@azure/arm-compute package

This is the Access Control Rules specification for an inVMAccessControlProfile version.

The properties of an Access Control Rule Identity.

The properties of an Access Control Rule Privilege.

The properties of an Access Control Rule Role.

The properties of an Access Control Rule RoleAssignment.

A disk access SAS uri.

Enables or disables a capability on the virtual machine or virtual machine scale set.

Describes the additional replica set information.

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Specifies if Scheduled Events should be auto-approved when all instances are down.

Describes the alternative option specified by the Publisher for this image when this image is deprecated.

The API entity reference.

Api error.

Api error base.

Contains the list of gallery applications that should be made available to the VM/VMSS

Specifies the input for attaching and detaching a list of managed data disks.

The configuration parameters used for performing automatic OS upgrade.

Describes automatic OS upgrade properties on the image.

Specifies the configuration parameters for automatic repairs on the virtual machine scale set.

The configuration parameters used while performing automatic AZ balancing.

In the case of an availability or connectivity issue with the data disk, specify the behavior of your VM

Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to an availability set at creation time. An existing VM cannot be added to an availability set.

The instance view of a resource.

Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a AvailabilitySets operations.

Optional parameters.

Optional parameters.

Optional parameters.

Describes the properties of an virtual machine instance view for available patch summary.

Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01.

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

The instance view of a virtual machine boot diagnostics.

Specifies information about the capacity reservation.

Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.

model interface CapacityReservationGroupInstanceView

capacity reservation group Properties.

Specifies information about the capacity reservation group. Only tags can be updated.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CapacityReservationGroups operations.

Optional parameters.

The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations.

The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group.

The parameters of a capacity reservation Profile.

Properties of the Capacity reservation.

Specifies information about the capacity reservation. sku.capacity cannot be updated for Block Capacity Reservation. Tags can be update for all Capacity Reservation Types.

Represents the capacity reservation utilization in terms of resources allocated.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a CapacityReservations operations.

Optional parameters.

An error response from the Compute service.

Optional parameters.

Interface representing a CommunityGalleries operations.

Specifies information about the Community Gallery that you want to create or update.

The identifier information of community gallery.

Specifies information about the gallery image definition that you want to create or update.

This is the community gallery image definition identifier.

Describes the properties of a gallery image definition.

Specifies information about the gallery image version that you want to create or update.

Describes the properties of a gallery image version.

Optional parameters.

Optional parameters.

Interface representing a CommunityGalleryImageVersions operations.

Optional parameters.

Optional parameters.

Interface representing a CommunityGalleryImages operations.

Information of community gallery if current gallery is shared to community

The metadata of community gallery.

Describes the properties of a community gallery.

Optional parameters for the client.

Describes the Virtual Machine Scale Set to convert from Availability Set.

Indicates the error details if the background copy of a resource created via the CopyStart operation fails.

Data used when creating a disk.

Describes a data disk.

Contains the data disk images information.

Contains encryption settings for a data disk image.

Describes the data disk to be attached.

Describes the data disk to be detached.

Specifies information about the Dedicated host.

Represents the dedicated host unutilized capacity in terms of a specific VM size.

Dedicated host unutilized capacity.

Specifies information about the dedicated host group that the dedicated hosts should be assigned to. Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group.

model interface DedicatedHostGroupInstanceView

Dedicated Host Group Properties.

Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01.

Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DedicatedHostGroups operations.

Optional parameters.

The instance view of a dedicated host.

The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group.

Properties of the dedicated host.

Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DedicatedHosts operations.

Optional parameters.

Optional parameters.

Optional parameters.

Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API.

Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.

Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk.

Describes the disallowed disk types.

Specifies the disallowed configuration for a virtual machine image.

Disk resource.

disk access resource.

model interface DiskAccessProperties

Used for updating a disk access resource.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DiskAccesses operations.

Optional parameters.

Optional parameters.

disk encryption set resource.

Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details.

disk encryption set update resource.

disk encryption set resource update properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DiskEncryptionSets operations.

Optional parameters.

Describes a Encryption Settings for a Disk

This is the disk image encryption base class.

The instance view of the disk.

Disk resource properties.

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

Properties of disk restore point

Disk Restore Point details.

Optional parameters.

Optional parameters.

The instance view of a disk restore point.

Optional parameters.

Interface representing a DiskRestorePoint operations.

Properties of an incremental disk restore point

The instance view of a disk restore point.

Optional parameters.

Contains the security related information for the resource.

The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS.

Disk update resource.

Disk resource update properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Disks operations.

Optional parameters.

Optional parameters.

Encryption at rest settings for disk or snapshot

Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact.

The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks.

model interface EncryptionSetProperties

Encryption settings for disk or snapshot

Encryption settings for one disk volume.

The resource management error additional info.

The error detail.

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Specifies eventGridAndResourceGraph related Scheduled Event related configurations.

This is the executed Validation.

The complex type of the extended location.

Specifies the external health policy for the virtual machine scale set.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Galleries operations.

Optional parameters.

Specifies information about the Shared Image Gallery that you want to create or update.

Specifies information about the gallery Application Definition that you want to create or update.

A custom action that can be performed with a Gallery Application Version.

The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

Describes the properties of a gallery Application Definition.

Specifies information about the gallery Application Definition that you want to update.

Specifies information about the gallery Application Version that you want to create or update.

Describes the properties of a gallery image version.

The publishing profile of a gallery image version.

The safety profile of the Gallery Application Version.

Specifies information about the gallery Application Version that you want to update.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryApplicationVersions operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryApplications operations.

Optional parameters.

Describes the basic gallery artifact publishing profile.

This is the safety profile of the Gallery Artifact Version.

The source of the gallery artifact version.

The gallery artifact version source.

This is the data disk image.

This is the disk image base class.

The source for the disk image.

The name of the extended location.

Describes the gallery unique name.

Identity for the virtual machine.

Specifies information about the gallery image definition that you want to create or update.

A feature for gallery image.

This is the gallery image definition identifier.

Describes the properties of a gallery image definition.

Specifies information about the gallery image definition that you want to update.

Specifies information about the gallery image version that you want to create or update.

Describes the properties of a gallery image version.

The publishing profile of a gallery image Version.

This is the safety profile of the Gallery Image Version.

This is the storage profile of a Gallery Image Version.

Contains UEFI settings for the image version.

Specifies information about the gallery image version that you want to update.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryImageVersions operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryImages operations.

Optional parameters.

Specifies information about the gallery inVMAccessControlProfile that you want to create or update.

Describes the properties of a gallery inVMAccessControlProfile.

Specifies information about the gallery inVMAccessControlProfile that you want to update.

Specifies information about the gallery inVMAccessControlProfile version that you want to create or update.

Describes the properties of an inVMAccessControlProfile version.

Specifies information about the gallery inVMAccessControlProfile version that you want to update.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryInVMAccessControlProfileVersions operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryInVMAccessControlProfiles operations.

Optional parameters.

This is the OS disk image.

Describes the properties of a Shared Image Gallery.

The properties of a gallery ResourceProfile.

The properties of a gallery ResourceProfile version.

Specifies information about the gallery Script Definition that you want to create or update.

The definition of a parameter that can be passed to a script of a Gallery Script Version.

Describes the properties of a gallery script definition.

Specifies information about the gallery Script Definition that you want to update.

Concrete tracked resource types can be created by aliasing this type using a specific property type.

Describes the properties of a gallery script version.

The publishing profile of a gallery image version.

The safety profile of the Gallery Script Version.

Specifies information about the gallery Script Version that you want to update.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryScriptVersions operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a GalleryScripts operations.

Optional parameters.

Interface representing a GallerySharingProfile operations.

Optional parameters.

The details information of soft-deleted resource.

Describes the properties of a soft-deleted resource.

model interface GalleryTargetExtendedLocation

Specifies information about the Shared Image Gallery that you want to update.

The definition of a generic gallery parameter.

Data used for requesting a SAS.

Specifies the hardware settings for the virtual machine.

Specifies particular host endpoint settings.

The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist.

Describes a data disk.

Describes image deprecation status properties on the image.

Describes a image disk.

The source image used for creating the disk.

Describes an Operating System disk.

Describes the properties of an Image.

Describes the gallery image definition purchase plan. This is used by marketplace images.

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

Describes a storage profile.

The source user image virtual hard disk. Only tags may be updated.

The security profile of a gallery image version

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Images operations.

Optional parameters.

Inner error details.

Instance view status.

Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots

Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey

Key Vault Secret Url and vault id of the encryption key

Describes a reference to Key Vault Key

Describes a reference to Key Vault Secret

Describes the properties of the last installed patch summary.

Describes a lifecycle hook.

Specifies the lifecycle hooks profile for the virtual machine scale set.

Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.

Input for InstallPatches on a Linux VM, as directly received by the API

Specifies settings related to VM Guest Patching on Linux.

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.

Optional parameters.

Optional parameters.

Api input base class for LogAnalytics Api.

LogAnalytics operation status response

Interface representing a LogAnalytics operations.

LogAnalytics output properties

Maintenance Operation Status.

The parameters of a managed disk.

The configuration parameters used to limit the number of virtual machines per availability zone in the virtual machine scale set.

Describes the Virtual Machine Scale Set to migrate from Availability Set.

The input of virtual machine migration from Availability Set to Flexible Virtual Machine Scale Set.

Describes a network interface reference.

Describes a network interface reference properties.

Specifies the network interfaces or the networking configuration of the virtual machine.

Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

Contains the os disk image information.

Contains encryption settings for an OS disk image.

Contains security profile for an OS disk image.

model interface OSImageNotificationProfile

Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned.

Additional parameters for Reimaging Non-Ephemeral Virtual Machine.

Details of a REST API operation, returned from the Resource Provider Operations API

Localized display information for an operation.

The configuration parameters used for operation recovery settings on a virtual machine scale set.

Optional parameters.

Interface representing a Operations operations.

The input for OrchestrationServiceState

Summary for an orchestration service of a virtual machine scale set.

Options for the byPage method

An interface that allows async iterable iteration both to completion and by page.

Information about a specific patch that was encountered during an installation action.

Specifies settings related to VM Guest Patching on Windows.

Base information about the community gallery resource in azure compute gallery.

The Resource model definition.

Base information about the shared gallery resource in pir.

Describes the user-defined constraints for resource hardware placement.

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

This is the platform attribute of the image version.

A policy violation reported against a gallery artifact.

Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached.

The Private Endpoint resource.

The Private Endpoint Connection resource.

Properties of the PrivateEndpointConnectProperties.

A private link resource

A list of private link resources

Properties of a private link resource.

A collection of information about the state of the connection between service consumer and provider.

Properties of the disk for which update is pending.

Specifies information about the proximity placement group.

Describes the properties of a Proximity Placement Group.

Specifies the user intent of the proximity placement group.

Specifies information about the proximity placement group.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a ProximityPlacementGroups operations.

Optional parameters.

Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.

The properties describe the recommended machine configuration for this Image Definition. These properties are updatable.

Response after calling a manual recovery walk

This is the regional replication status.

Gallery regional sharing status

The configuration parameters used while performing reimage recovery.

This is the replication status of the gallery image version.

Api request input for LogAnalytics getRequestRateByInterval Api.

Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy, ResilientVMDeletionPolicy and OperationRecoverySettings (version > 2025-11-01).

Gets resiliency solutions enabled on the VM. This includes backup or disaster recovery solutions.

The configuration parameters used while performing resilient VM creation.

The configuration parameters used while performing resilient VM deletion.

Common fields that are returned in the response for all Azure Resource Manager resources

Describes the resource range.

model interface ResourceSharingProfile

Describes an available Compute SKU.

Describes The SKU capabilities object.

Describes scaling information of a SKU.

Describes metadata for retrieving price info.

Describes an available Compute SKU Location Information.

Describes an available Compute SKU Restriction Information.

Describes scaling information of a SKU.

Describes The zonal capabilities of a SKU.

Optional parameters.

Interface representing a ResourceSkus operations.

The configuration parameters used while performing restart recovery.

Restore Point details.

Create or update Restore Point collection parameters.

The restore point collection properties.

The properties of the source resource that this restore point collection is created from.

Update Restore Point collection parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a RestorePointCollections operations.

Optional parameters.

Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point.

The instance view of a restore point.

The restore point properties.

Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation.

Describes a data disk.

Describes the storage profile.

Describes an Operating System disk.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a RestorePoints operations.

The SAS URIs of the console screenshot and serial log blobs.

Information about rollback on failed VM instances after a OS Upgrade operation.

The configuration parameters used while performing a rolling upgrade.

Information about the number of virtual machine instances in each upgrade state.

Information about the current running state of the overall upgrade.

The status of the latest virtual machine scale set rolling upgrade.

The status of the latest virtual machine scale set rolling upgrade.

Describes the properties of a Run Command.

Describes the properties of a Run Command metadata.

Capture Virtual Machine parameters.

Describes the properties of a run command parameter.

Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged.

Describes the properties of a run command parameter.

model interface RunCommandResult

Describes a scale-in policy for a virtual machine scale set.

Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.

model interface ScheduledEventsAdditionalPublishingTargets

Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.

model interface ScheduledEventsProfile

The source script from which the Script Version is going to be created.

Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01

Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01

model interface ShareInfoElement

Optional parameters.

Optional parameters.

Interface representing a SharedGalleries operations.

Specifies information about the Shared Gallery that you want to create or update.

This is the data disk image.

This is the disk image base class.

The identifier information of shared gallery.

Specifies information about the gallery image definition that you want to create or update.

Describes the properties of a gallery image definition.

Specifies information about the gallery image version that you want to create or update.

Describes the properties of a gallery image version.

This is the storage profile of a Gallery Image Version.

Optional parameters.

Optional parameters.

Interface representing a SharedGalleryImageVersions operations.

Optional parameters.

Optional parameters.

Interface representing a SharedGalleryImages operations.

This is the OS disk image.

Specifies the properties of a shared gallery

Profile for gallery sharing to subscription or tenant

Group of the gallery sharing profile

Sharing status of current gallery.

Specifies information about the gallery sharing profile update.

A simple poller that can be used to poll a long running operation.

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy.

Specifies the VM Size.

Snapshot resource.

Snapshot resource properties.

The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot

Snapshot update resource.

Snapshot resource update properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Snapshots operations.

Optional parameters.

Optional parameters.

Contains information about the soft deletion policy of the gallery.

Optional parameters.

Interface representing a SoftDeletedResource operations.

The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}

Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint.

SSH configuration for Linux based VMs running on Azure

Parameters for GenerateSshKeyPair.

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Response from generation of an SSH key pair.

Specifies information about the SSH public key.

Properties of the SSH public key.

Specifies information about the SSH public key.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a SshPublicKeys operations.

Optional parameters.

The configuration parameters used while performing start recovery.

Specifies the storage settings for the virtual machine disks.

model interface SubResource

model interface SubResourceReadOnly

model interface SubResourceWithColocationStatus

List of supported capabilities persisted on the disk resource for VM use.

Metadata pertaining to creation and last modification of the resource.

Describes the target region information.

model interface TerminateNotificationProfile

Api request input for LogAnalytics getThrottledRequests Api.

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

A UEFI key signature.

Additional UEFI key signatures that will be added to the image in addition to the signature templates

Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

The Update Resource model definition.

The Update Resource model definition.

Virtual Machine Scale Set OS Upgrade History operation response.

Describes each OS upgrade on the Virtual Machine Scale Set.

Information about the current running state of the overall upgrade.

Describes an upgrade policy - automatic, manual, or rolling.

Describes Compute Resource Usage.

Optional parameters.

The Usage Names.

Interface representing a Usage operations.

model interface UserArtifactManage

Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set.

The source image from which the Image Version is going to be created.

model interface UserAssignedIdentitiesValue

Specifies Reboot related Scheduled Event related configurations.

Specifies Redeploy related Scheduled Event related configurations.

Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.

Specifies the required information to reference a compute gallery application version

model interface VMScaleSetConvertToSinglePlacementGroupInput

Defines a virtual machine scale set lifecycle hook event.

Additional key-value pairs set on the lifecycle hook event that gives customer some useful context/data. The keys in this dictionary are specific to the lifecycle hook type. Different lifecycle hook events can have different sets of keys in the additional context depending on the lifecycle hook type. For example, for a lifecycle hook event with UpgradeAutoOSScheduling type, the additional context can contain the key "priority" that helps customer identify the priority of the Auto OS Upgrade operation triggered on the virtual machine scale set.

Defines the virtual machine scale set lifecycle hook event properties.

Define a single target ARM resource in a virtual machine scale set lifecycle hook event. Currently, this can be a virtual machine scale set resource or an individual virtual machine resource within a VMScaleSet.

Specifies information about the virtual machine scale set lifecycle hook event.

The input for ScaleOut

The input properties for ScaleOut

Specifies VM Size Property settings on the virtual machine.

This is the validations profile of a Gallery Image Version.

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Describes a set of certificates which are all in the same Key Vault.

Describes the uri of a disk.

Describes a Virtual Machine.

The instance view of the VM Agent running on the virtual machine.

Describes the properties of an AssessPatches result.

Capture Virtual Machine parameters.

Output of virtual machine capture operation.

Describes a Virtual Machine Extension.

The instance view of a virtual machine extension handler.

Describes a Virtual Machine Extension Image.

Describes the properties of a Virtual Machine Extension Image.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineExtensionImages operations.

The instance view of a virtual machine extension.

Describes the properties of a Virtual Machine Extension.

Describes a Virtual Machine Extension.

Describes the properties of a Virtual Machine Extension.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The List Extension operation response

Interface representing a VirtualMachineExtensions operations.

Optional parameters.

The health status of the VM.

Identity for the virtual machine.

Describes a Virtual Machine Image.

Specifies additional capabilities supported by the image

Describes the properties of a Virtual Machine Image.

Virtual machine image resource information.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineImagesEdgeZone operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineImages operations.

Input for InstallPatches as directly received by the API

The result summary of an installation operation.

The instance view of a virtual machine.

Contains the IP tag associated with the public IP address.

Describes a virtual machine network interface configurations.

Describes a virtual machine network profile's IP configuration.

Describes a virtual machines network configuration's DNS settings.

Describes a virtual machine network profile's IP configuration.

Describes a virtual machine network interface IP configuration properties.

The status of virtual machine patch operations.

Describes the properties of a Virtual Machine.

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Describes a virtual machines network configuration's DNS settings.

Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged

Describes a Virtual Machine run command.

The instance view of a virtual machine run command.

Describes the properties of a Virtual Machine run command.

Describes the script sources for run command. Use only one of these script sources: script, scriptUri, commandId, galleryScriptReferenceId.

Describes a Virtual Machine run command.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineRunCommands operations.

Optional parameters.

Describes a Virtual Machine Scale Set.

Describes a virtual machine scale set data disk.

Describes a Virtual Machine Scale Set Extension.

Describes a virtual machine scale set extension profile.

Describes the properties of a Virtual Machine Scale Set Extension.

Describes a Virtual Machine Scale Set Extension.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSetExtensions operations.

Optional parameters.

Specifies the hardware settings for the virtual machine scale set.

Describes a virtual machine scale set network profile's IP configuration.

Describes a virtual machine scale set network profile's IP configuration properties.

Identity for the virtual machine scale set.

The instance view of a virtual machine scale set.

Instance view statuses summary for virtual machines of a virtual machine scale set.

Contains the IP tag associated with the public IP address.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSetLifeCycleHookEvents operations.

Optional parameters.

Describes the parameters of a ScaleSet managed disk.

Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set.

Describes a virtual machine scale set network profile's network configurations.

Describes a virtual machines scale sets network configuration's DNS settings.

Describes a virtual machine scale set network profile's IP configuration.

Describes a virtual machine scale set network profile.

Describes a virtual machine scale set operating system disk.

Describes a virtual machine scale set OS profile.

Describes the properties of a Virtual Machine Scale Set.

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Describes a virtual machines scale sets network configuration's DNS settings.

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Describes a Virtual Machine Scale Set VM Reimage Parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSetRollingUpgrades operations.

Optional parameters.

Optional parameters.

Describes an available virtual machine scale set sku.

Describes scaling information of a sku.

Describes a virtual machine scale set storage profile.

Describes a Virtual Machine Scale Set.

Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network

Describes a virtual machine scale set network profile's IP configuration properties.

Describes a virtual machine scale set network profile's network configurations.

Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration.

Describes a virtual machine scale set network profile.

Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk.

Describes a virtual machine scale set OS profile.

Describes the properties of a Virtual Machine Scale Set.

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration

Describes a virtual machine scale set storage profile.

Describes a virtual machine scale set virtual machine profile.

Describes a virtual machine scale set virtual machine.

Describes a VMSS VM Extension.

Describes a VMSS VM Extension.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The List VMSS VM Extension operation response

Interface representing a VirtualMachineScaleSetVMExtensions operations.

Extensions summary for virtual machines of a virtual machine scale set.

Optional parameters.

Specifies a list of virtual machine instance IDs from the VM scale set.

Specifies a list of virtual machine instance IDs from the VM scale set.

The instance view of a virtual machine scale set VM.

Describes a virtual machine scale set VM network profile.

Describes a virtual machine scale set virtual machine profile.

Describes the properties of a virtual machine scale set virtual machine.

The protection policy of a virtual machine scale set VM.

Describes a Virtual Machine Scale Set VM Reimage Parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSetVMRunCommands operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSetVMs operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachineScaleSets operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Describes the properties of a VM size.

Optional parameters.

Interface representing a VirtualMachineSizes operations.

Describes the properties of a Virtual Machine software patch.

The status code and count of the virtual machine scale set instance view status summary.

Describes a Virtual Machine Update.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a VirtualMachines operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The List VmImages in EdgeZone operation response.

Describes Windows Remote Management configuration of the VM

Describes Protocol and thumbprint of Windows Remote Management listener

Specifies Windows operating system settings on the virtual machine.

Input for InstallPatches on a Windows VM, as directly received by the API

Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.

The configuration parameters for zone allocation of a virtual machine scale set.

Describes zone movement configuration. This allows VM to be moved across availability zones during an outage.

This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'.
KnownAccessControlRulesMode can be used interchangeably with AccessControlRulesMode, this enum contains the known values that the service supports.

Known values supported by the service

Audit
Enforce
Disabled

The Access Level, accepted values include None, Read, Write.
KnownAccessLevel can be used interchangeably with AccessLevel, this enum contains the known values that the service supports.

Known values supported by the service

None
Read
Write

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

This is the aggregated replication status based on all the regional replication status flags.
KnownAggregatedReplicationState can be used interchangeably with AggregatedReplicationState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
InProgress
Completed
Failed

Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.
KnownAllocationStrategy can be used interchangeably with AllocationStrategy, this enum contains the known values that the service supports.

Known values supported by the service

LowestPrice
CapacityOptimized
Prioritized

Describes the type of the alternative option.
KnownAlternativeType can be used interchangeably with AlternativeType, this enum contains the known values that the service supports.

Known values supported by the service

None
Offer
Plan

CPU architecture supported by an OS disk.
KnownArchitecture can be used interchangeably with Architecture, this enum contains the known values that the service supports.

Known values supported by the service

x64
Arm64

Specifies the Architecture Type
KnownArchitectureTypes can be used interchangeably with ArchitectureTypes, this enum contains the known values that the service supports.

Known values supported by the service

x64
Arm64

Determines on how to handle disks with slow I/O.
KnownAvailabilityPolicyDiskDelay can be used interchangeably with AvailabilityPolicyDiskDelay, this enum contains the known values that the service supports.

Known values supported by the service

None: Defaults to behavior without av policy specified, which is VM restart upon slow disk io.
AutomaticReattach: Upon a disk io failure or slow response, try detaching then reattaching the disk.

The supported values for cloud setting as a string literal type

Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage

Type of CapacityReservationGroupInstanceViewTypes

Type of CapacityReservationInstanceViewTypes

The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.

confidential VM encryption types
KnownConfidentialVMEncryptionType can be used interchangeably with ConfidentialVMEncryptionType, this enum contains the known values that the service supports.

Known values supported by the service

EncryptedVMGuestStateOnlyWithPmk
EncryptedWithPmk
EncryptedWithCmk
NonPersistedTPM

ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.
KnownConsistencyModeTypes can be used interchangeably with ConsistencyModeTypes, this enum contains the known values that the service supports.

Known values supported by the service

CrashConsistent
FileSystemConsistent
ApplicationConsistent

An interface that describes a page of results.

Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
KnownCopyCompletionErrorReason can be used interchangeably with CopyCompletionErrorReason, this enum contains the known values that the service supports.

Known values supported by the service

CopySourceNotFound: Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress.

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

Additional authentication requirements when exporting or uploading to a disk or snapshot.
KnownDataAccessAuthMode can be used interchangeably with DataAccessAuthMode, this enum contains the known values that the service supports.

Known values supported by the service

AzureActiveDirectory: When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth.
None: No additional authentication would be performed when accessing export/upload URL.

Specifies the software license type that will be applied to the VMs deployed on the dedicated host. Possible values are: None, Windows_Server_Hybrid, Windows_Server_Perpetual. The default value is: None.

Specify what happens to the network interface when the VM is deleted
KnownDeleteOptions can be used interchangeably with DeleteOptions, this enum contains the known values that the service supports.

Known values supported by the service

Delete
Detach

Specifies the ephemeral disk option for operating system disk.
KnownDiffDiskOptions can be used interchangeably with DiffDiskOptions, this enum contains the known values that the service supports.

Known values supported by the service

Local

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01.
KnownDiffDiskPlacement can be used interchangeably with DiffDiskPlacement, this enum contains the known values that the service supports.

Known values supported by the service

CacheDisk
ResourceDisk
NvmeDisk

Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.
KnownDiskControllerTypes can be used interchangeably with DiskControllerTypes, this enum contains the known values that the service supports.

Known values supported by the service

SCSI
NVMe

This enumerates the possible sources of a disk's creation.
KnownDiskCreateOption can be used interchangeably with DiskCreateOption, this enum contains the known values that the service supports.

Known values supported by the service

Empty: Create an empty data disk of a size given by diskSizeGB.
Attach: Disk will be attached to a VM.
FromImage: Create a new disk from a platform image specified by the given imageReference or galleryImageReference.
Import: Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId.
Copy: Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId.
Restore: Create a new disk by copying from a backup recovery point.
Upload: Create a new disk by obtaining a write token and using it to directly upload the contents of the disk.
CopyStart: Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source.
ImportSecure: Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM.
UploadPreparedSecure: Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM.
CopyFromSanSnapshot: Create a new disk by exporting from elastic san volume snapshot

Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point.
KnownDiskCreateOptionTypes can be used interchangeably with DiskCreateOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

FromImage
Empty
Attach
Copy
Restore

Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.
KnownDiskDeleteOptionTypes can be used interchangeably with DiskDeleteOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

Delete
Detach

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.
KnownDiskDetachOptionTypes can be used interchangeably with DiskDetachOptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

ForceDetach

The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.
KnownDiskEncryptionSetIdentityType can be used interchangeably with DiskEncryptionSetIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

The type of key used to encrypt the data of the disk.
KnownDiskEncryptionSetType can be used interchangeably with DiskEncryptionSetType, this enum contains the known values that the service supports.

Known values supported by the service

EncryptionAtRestWithCustomerKey: Resource using diskEncryptionSet would be encrypted at rest with Customer managed key that can be changed and revoked by a customer.
EncryptionAtRestWithPlatformAndCustomerKeys: Resource using diskEncryptionSet would be encrypted at rest with two layers of encryption. One of the keys is Customer managed and the other key is Platform managed.
ConfidentialVmEncryptedWithCustomerKey: Confidential VM supported disk and VM guest state would be encrypted with customer managed key.

Specifies the SecurityType of the VM. Applicable for OS disks only.
KnownDiskSecurityTypes can be used interchangeably with DiskSecurityTypes, this enum contains the known values that the service supports.

Known values supported by the service

TrustedLaunch: Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM)
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey: Indicates Confidential VM disk with only VM guest state encrypted
ConfidentialVM_DiskEncryptedWithPlatformKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key
ConfidentialVM_DiskEncryptedWithCustomerKey: Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key
ConfidentialVM_NonPersistedTPM: Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots.

This enumerates the possible state of the disk.
KnownDiskState can be used interchangeably with DiskState, this enum contains the known values that the service supports.

Known values supported by the service

Unattached: The disk is not being used and can be attached to a VM.
Attached: The disk is currently attached to a running VM.
Reserved: The disk is attached to a stopped-deallocated VM.
Frozen: The disk is attached to a VM which is in hibernated state.
ActiveSAS: The disk currently has an Active SAS Uri associated with it.
ActiveSASFrozen: The disk is attached to a VM in hibernated state and has an active SAS URI associated with it.
ReadyToUpload: A disk is ready to be created by upload by requesting a write token.
ActiveUpload: A disk is created for upload and a write token has been issued for uploading to it.

The sku name.
KnownDiskStorageAccountTypes can be used interchangeably with DiskStorageAccountTypes, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS: Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access.
Premium_LRS: Premium SSD locally redundant storage. Best for production and performance sensitive workloads.
StandardSSD_LRS: Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test.
UltraSSD_LRS: Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads.
Premium_ZRS: Premium SSD zone redundant storage. Best for the production workloads that need storage resiliency against zone failures.
StandardSSD_ZRS: Standard SSD zone redundant storage. Best for web servers, lightly used enterprise applications and dev/test that need storage resiliency against zone failures.
PremiumV2_LRS: Premium SSD v2 locally redundant storage. Best for production and performance-sensitive workloads that consistently require low latency and high IOPS and throughput.

The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created
KnownDomainNameLabelScopeTypes can be used interchangeably with DomainNameLabelScopeTypes, this enum contains the known values that the service supports.

Known values supported by the service

TenantReuse
SubscriptionReuse
ResourceGroupReuse
NoReuse

Specifies the storage account type to be used to store the image. This property is not updatable.
KnownEdgeZoneStorageAccountType can be used interchangeably with EdgeZoneStorageAccountType, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS
Standard_ZRS
StandardSSD_LRS
Premium_LRS

The type of key used to encrypt the data of the disk.
KnownEncryptionType can be used interchangeably with EncryptionType, this enum contains the known values that the service supports.

Known values supported by the service

EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets.
EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer.
EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'.
KnownEndpointAccess can be used interchangeably with EndpointAccess, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS'

Script execution status.
KnownExecutionState can be used interchangeably with ExecutionState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Pending
Running
Failed
Succeeded
TimedOut
Canceled

Type of ExpandTypeForListVMs

Type of ExpandTypesForGetCapacityReservationGroups

Type of ExpandTypesForGetVMScaleSets

Type of ExpandTypesForListVMs

The type of the extended location.
KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone

The type of extendedLocation.
KnownExtendedLocationTypes can be used interchangeably with ExtendedLocationTypes, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone

Used to specify the file format when making request for SAS on a VHDX file format snapshot
KnownFileFormat can be used interchangeably with FileFormat, this enum contains the known values that the service supports.

Known values supported by the service

VHD: A VHD file is a disk image file in the Virtual Hard Disk file format.
VHDX: A VHDX file is a disk image file in the Virtual Hard Disk v2 file format.

Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob

Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.
KnownGalleryApplicationScriptRebootBehavior can be used interchangeably with GalleryApplicationScriptRebootBehavior, this enum contains the known values that the service supports.

Known values supported by the service

None
Rerun

Type of GalleryExpandParams

It is type of the extended location.
KnownGalleryExtendedLocationType can be used interchangeably with GalleryExtendedLocationType, this enum contains the known values that the service supports.

Known values supported by the service

EdgeZone
Unknown

The provisioning state, which only appears in the response.
KnownGalleryProvisioningState can be used interchangeably with GalleryProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating
Updating
Failed
Succeeded
Deleting
Migrating

Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum
KnownGalleryScriptParameterType can be used interchangeably with GalleryScriptParameterType, this enum contains the known values that the service supports.

Known values supported by the service

String: String gallery script parameter type
Int: Int gallery script parameter type
Double: Double gallery script parameter type
Boolean: Boolean gallery script parameter type
Enum: Enum gallery script parameter type

This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.
KnownGallerySharingPermissionTypes can be used interchangeably with GallerySharingPermissionTypes, this enum contains the known values that the service supports.

Known values supported by the service

Private
Groups
Community

Specifies the high speed interconnect placement for the virtual machine scale set.
KnownHighSpeedInterconnectPlacement can be used interchangeably with HighSpeedInterconnectPlacement, this enum contains the known values that the service supports.

Known values supported by the service

None: No high speed interconnect placement
Trunk: Trunk high speed interconnect placement

The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'

The hypervisor generation of the Virtual Machine.
KnownHyperVGeneration can be used interchangeably with HyperVGeneration, this enum contains the known values that the service supports.

Known values supported by the service

V1
V2

Specifies the HyperVGeneration Type associated with a resource
KnownHyperVGenerationType can be used interchangeably with HyperVGenerationType, this enum contains the known values that the service supports.

Known values supported by the service

V1
V2

Specifies the HyperVGeneration Type
KnownHyperVGenerationTypes can be used interchangeably with HyperVGenerationTypes, this enum contains the known values that the service supports.

Known values supported by the service

V1
V2

Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
KnownIPVersion can be used interchangeably with IPVersion, this enum contains the known values that the service supports.

Known values supported by the service

IPv4
IPv6

Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
KnownIPVersions can be used interchangeably with IPVersions, this enum contains the known values that the service supports.

Known values supported by the service

IPv4
IPv6

Describes the state of the image.
KnownImageState can be used interchangeably with ImageState, this enum contains the known values that the service supports.

Known values supported by the service

Active
ScheduledForDeprecation
Deprecated

Type of InstanceViewTypes

Interval value in minutes used to create LogAnalytics call rate logs.

The action that will be applied to a target resource in the virtual machine scale set lifecycle hook event if the platform does not receive a response from the customer for the target resource before waitUntil.
KnownLifecycleHookAction can be used interchangeably with LifecycleHookAction, this enum contains the known values that the service supports.

Known values supported by the service

Approve: The lifecycle hook of a target resource in a lifecycle hook event will be approved.
Reject: The lifecycle hook of a target resource in a lifecycle hook event will be rejected.

Approval status of a target resource in a virtual machine scale set lifecycle hook event.
KnownLifecycleHookActionState can be used interchangeably with LifecycleHookActionState, this enum contains the known values that the service supports.

Known values supported by the service

Waiting: The lifecycle hook for the target resource is waiting for approval.
Approved: The lifecycle hook for the target resource is approved.
Rejected: The lifecycle hook for the target resource is rejected.

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
KnownLinuxPatchAssessmentMode can be used interchangeably with LinuxPatchAssessmentMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault
AutomaticByPlatform

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
KnownLinuxVMGuestPatchAutomaticByPlatformRebootSetting can be used interchangeably with LinuxVMGuestPatchAutomaticByPlatformRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
IfRequired
Never
Always

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
KnownLinuxVMGuestPatchMode can be used interchangeably with LinuxVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault
AutomaticByPlatform

The Last Maintenance Operation Result Code.

Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.
KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports.

Known values supported by the service

Audit
Enforce

Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation.
KnownModes can be used interchangeably with Modes, this enum contains the known values that the service supports.

Known values supported by the service

Audit
Enforce
Disabled

Policy for accessing the disk via network.
KnownNetworkAccessPolicy can be used interchangeably with NetworkAccessPolicy, this enum contains the known values that the service supports.

Known values supported by the service

AllowAll: The disk can be exported or uploaded to from any network.
AllowPrivate: The disk can be exported or uploaded to using a DiskAccess resource's private endpoints.
DenyAll: The disk cannot be exported.

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
KnownNetworkApiVersion can be used interchangeably with NetworkApiVersion, this enum contains the known values that the service supports.

Known values supported by the service

2020-11-01
2022-11-01

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
KnownNetworkInterfaceAuxiliaryMode can be used interchangeably with NetworkInterfaceAuxiliaryMode, this enum contains the known values that the service supports.

Known values supported by the service

None
AcceleratedConnections
Floating

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
KnownNetworkInterfaceAuxiliarySku can be used interchangeably with NetworkInterfaceAuxiliarySku, this enum contains the known values that the service supports.

Known values supported by the service

None
A1
A2
A4
A8

The OS State. For managed images, use Generalized.

Gets the Operating System type.
KnownOperatingSystemType can be used interchangeably with OperatingSystemType, this enum contains the known values that the service supports.

Known values supported by the service

Windows
Linux

This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.

Specifies the orchestration mode for the virtual machine scale set.
KnownOrchestrationMode can be used interchangeably with OrchestrationMode, this enum contains the known values that the service supports.

Known values supported by the service

Uniform
Flexible

The name of the service.
KnownOrchestrationServiceNames can be used interchangeably with OrchestrationServiceNames, this enum contains the known values that the service supports.

Known values supported by the service

AutomaticRepairs
AutomaticZoneRebalancing: AutomaticZoneRebalancing orchestration service.

The latest operation status of the service.
KnownOrchestrationServiceOperationStatus can be used interchangeably with OrchestrationServiceOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

InProgress: InProgress orchestration service operation status.
Completed: Completed orchestration service operation status.

The current state of the service.
KnownOrchestrationServiceState can be used interchangeably with OrchestrationServiceState, this enum contains the known values that the service supports.

Known values supported by the service

NotRunning
Running
Suspended

The action to be performed.
KnownOrchestrationServiceStateAction can be used interchangeably with OrchestrationServiceStateAction, this enum contains the known values that the service supports.

Known values supported by the service

Resume
Suspend

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

Type of PassNames

Describes the availability of a given patch.
KnownPatchAssessmentState can be used interchangeably with PatchAssessmentState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Available

The state of the patch after the installation operation completed.
KnownPatchInstallationState can be used interchangeably with PatchInstallationState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Installed
Failed
Excluded
NotSelected
Pending

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
KnownPatchOperationStatus can be used interchangeably with PatchOperationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
InProgress
Failed
Succeeded
CompletedWithWarnings

Describes the nature of the policy violation.
KnownPolicyViolationCategory can be used interchangeably with PolicyViolationCategory, this enum contains the known values that the service supports.

Known values supported by the service

Other
ImageFlaggedUnsafe
CopyrightValidation
IpTheft

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

Specifies the protocol of WinRM listener. Possible values are: http, https.

If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
KnownProvisionedBandwidthCopyOption can be used interchangeably with ProvisionedBandwidthCopyOption, this enum contains the known values that the service supports.

Known values supported by the service

None
Enhanced

Specifies the type of the proximity placement group. Possible values are: Standard : Co-locate resources within an Azure region or Availability Zone. Ultra : For future use.
KnownProximityPlacementGroupType can be used interchangeably with ProximityPlacementGroupType, this enum contains the known values that the service supports.

Known values supported by the service

Standard
Ultra

Specify public IP sku name
KnownPublicIPAddressSkuName can be used interchangeably with PublicIPAddressSkuName, this enum contains the known values that the service supports.

Known values supported by the service

Basic
Standard

Specify public IP sku tier
KnownPublicIPAddressSkuTier can be used interchangeably with PublicIPAddressSkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Regional
Global

Specify the public IP allocation type
KnownPublicIPAllocationMethod can be used interchangeably with PublicIPAllocationMethod, this enum contains the known values that the service supports.

Known values supported by the service

Dynamic
Static

Policy for controlling export on the disk.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.
Disabled: You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate.

Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete.
KnownRebalanceBehavior can be used interchangeably with RebalanceBehavior, this enum contains the known values that the service supports.

Known values supported by the service

CreateBeforeDelete

Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate.
KnownRebalanceStrategy can be used interchangeably with RebalanceStrategy, this enum contains the known values that the service supports.

Known values supported by the service

Recreate

Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.
KnownRepairAction can be used interchangeably with RepairAction, this enum contains the known values that the service supports.

Known values supported by the service

Replace
Restart
Reimage

Optional parameter which specifies the mode to be used for replication. This property is not updatable.
KnownReplicationMode can be used interchangeably with ReplicationMode, this enum contains the known values that the service supports.

Known values supported by the service

Full
Shallow

This is the regional replication state.
KnownReplicationState can be used interchangeably with ReplicationState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Replicating
Completed
Failed

Type of ReplicationStatusTypes

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.
KnownReservationType can be used interchangeably with ReservationType, this enum contains the known values that the service supports.

Known values supported by the service

Targeted: To consume on demand allocated capacity reservation when a capacity reservation group is provided.
Block: To consume scheduled allocated block capacity reservation when a capacity reservation group is provided.

Specifies the resilient VM deletion status for the virtual machine.
KnownResilientVMDeletionStatus can be used interchangeably with ResilientVMDeletionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled
InProgress
Failed

Type of ResourceIdOptionsForGetCapacityReservationGroups

The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.

The scale type applicable to the sku.

The reason for restriction.

The type of restrictions.

Type of RestorePointCollectionExpandOptions

The type of key used to encrypt the data of the disk restore point.
KnownRestorePointEncryptionType can be used interchangeably with RestorePointEncryptionType, this enum contains the known values that the service supports.

Known values supported by the service

EncryptionAtRestWithPlatformKey: Disk Restore Point is encrypted at rest with Platform managed key.
EncryptionAtRestWithCustomerKey: Disk Restore Point is encrypted at rest with Customer managed key that can be changed and revoked by a customer.
EncryptionAtRestWithPlatformAndCustomerKeys: Disk Restore Point is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

Type of RestorePointExpandOptions

The last action performed on the rolling upgrade.

Code indicating the current status of the upgrade.

Script shell types.
KnownScriptShellTypes can be used interchangeably with ScriptShellTypes, this enum contains the known values that the service supports.

Known values supported by the service

Default: Default script shell type.
Powershell7: Powershell7 script shell type.

Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.
KnownSecurityEncryptionTypes can be used interchangeably with SecurityEncryptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

VMGuestStateOnly
DiskWithVMGuestState
NonPersistedTPM

Specifies the VM securityType; UefiSettings are enabled only when set to TrustedLaunch or ConfidentialVM, and returns a Standard value starting API version 2025-11-01.
KnownSecurityTypes can be used interchangeably with SecurityTypes, this enum contains the known values that the service supports.

Known values supported by the service

Standard: Indicates a VM without UEFI features such as SecureBoot or vTPM; returned as the default value when securityType is not specified.
TrustedLaunch
ConfidentialVM

Type of SelectPermissions

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite'
KnownSharedGalleryHostCaching can be used interchangeably with SharedGalleryHostCaching, this enum contains the known values that the service supports.

Known values supported by the service

None
ReadOnly
ReadWrite

Type of SharedToValues

This property allows you to specify the type of sharing group. Possible values are: Subscriptions, AADTenants.
KnownSharingProfileGroupTypes can be used interchangeably with SharingProfileGroupTypes, this enum contains the known values that the service supports.

Known values supported by the service

Subscriptions
AADTenants

The sharing state of the gallery, which only appears in the response.
KnownSharingState can be used interchangeably with SharingState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
InProgress
Failed
Unknown

This property allows you to specify the operation type of gallery sharing update. Possible values are: Add, Remove, Reset.
KnownSharingUpdateOperationTypes can be used interchangeably with SharingUpdateOperationTypes, this enum contains the known values that the service supports.

Known values supported by the service

Add
Remove
Reset
EnableCommunity

The state of snapshot which determines the access availability of the snapshot.
KnownSnapshotAccessState can be used interchangeably with SnapshotAccessState, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Default value.
Pending: The snapshot cannot be used for restore, copy or download to offline.
Available: The snapshot can be used for restore, copy to different region, and download to offline.
InstantAccess: The snapshot can be used for restoring disks with fast performance but cannot be copied or downloaded.
AvailableWithInstantAccess: The snapshot can be used for restoring disks with fast performance, copied and downloaded.

The sku name.
KnownSnapshotStorageAccountTypes can be used interchangeably with SnapshotStorageAccountTypes, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS: Standard HDD locally redundant storage
Premium_LRS: Premium SSD locally redundant storage
Standard_ZRS: Standard zone redundant storage

artifact type of the soft-deleted resource
KnownSoftDeletedArtifactTypes can be used interchangeably with SoftDeletedArtifactTypes, this enum contains the known values that the service supports.

Known values supported by the service

Images

The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA
KnownSshEncryptionTypes can be used interchangeably with SshEncryptionTypes, this enum contains the known values that the service supports.

Known values supported by the service

RSA
Ed25519

The level code.

Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable.
KnownStorageAccountStrategy can be used interchangeably with StorageAccountStrategy, this enum contains the known values that the service supports.

Known values supported by the service

PreferStandard_ZRS: Choose Standard_ZRS storage if the region supports it, else choose Standard_LRS storage, unless overridden by specifying regional storageAccountType. If no storageAccountStrategy is specified, this is the default strategy (from API version 2025-03-03 onwards).
DefaultStandard_LRS: Choose Standard_LRS storage unless overridden by specifying regional storageAccountType.

Specifies the storage account type to be used to store the image. This property is not updatable.
KnownStorageAccountType can be used interchangeably with StorageAccountType, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS
Standard_ZRS
Premium_LRS
PremiumV2_LRS

Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant storage. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/azure/virtual-machines/linux/disks-types
KnownStorageAccountTypes can be used interchangeably with StorageAccountTypes, this enum contains the known values that the service supports.

Known values supported by the service

Standard_LRS
Premium_LRS
StandardSSD_LRS
UltraSSD_LRS
Premium_ZRS
StandardSSD_ZRS
PremiumV2_LRS

Specifies the storage alignment status for the disk.
KnownStorageAlignmentStatus can be used interchangeably with StorageAlignmentStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unaligned: Disk does not have Storage Fault Domain to Compute Fault Domain mapping. A single Storage Fault Domain failure may impact all VMs that reference this disk profile.
Aligned: Disk has Storage Fault Domain to Compute Fault Domain mapping. Storage Fault Domain failure is contained to VMs in a single Compute Fault Domain.

Specifies the storage fault domain alignment type for the disk.
KnownStorageFaultDomainAlignmentType can be used interchangeably with StorageFaultDomainAlignmentType, this enum contains the known values that the service supports.

Known values supported by the service

Aligned: Disk Storage Fault Domains are mapped to Compute Fault Domains. Deployment fails if disk does not support enough Fault Domains.
BestEffortAligned: Attempt to map Storage Fault Domains to Compute Fault Domains. Disks are unaligned if disk does not support enough Fault Domains.

Refers to the security capability of the disk supported to create a Trusted launch or Confidential VM
KnownSupportedSecurityOption can be used interchangeably with SupportedSecurityOption, this enum contains the known values that the service supports.

Known values supported by the service

TrustedLaunchSupported: The disk supports creating Trusted Launch VMs.
TrustedLaunchAndConfidentialVMSupported: The disk supports creating both Trusted Launch and Confidential VMs.

The type of key signature.
KnownUefiKeyType can be used interchangeably with UefiKeyType, this enum contains the known values that the service supports.

Known values supported by the service

sha256
x509

The name of the signature template that contains default UEFI keys.
KnownUefiSignatureTemplateName can be used interchangeably with UefiSignatureTemplateName, this enum contains the known values that the service supports.

Known values supported by the service

NoSignatureTemplate
MicrosoftUefiCertificateAuthorityTemplate
MicrosoftWindowsTemplate

Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

Automatic - All virtual machines in the scale set are automatically updated at the same time.

Invoker of the Upgrade Operation

Code indicating the current status of the upgrade.

Type of VMGuestPatchClassificationLinux

Type of VMGuestPatchClassificationWindows

Describes the reboot requirements of the patch.
KnownVMGuestPatchRebootBehavior can be used interchangeably with VMGuestPatchRebootBehavior, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
NeverReboots
AlwaysRequiresReboot
CanRequestReboot

Defines when it is acceptable to reboot a VM during a software update operation.
KnownVMGuestPatchRebootSetting can be used interchangeably with VMGuestPatchRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

IfRequired
Never
Always

The reboot state of the VM following completion of the operation.
KnownVMGuestPatchRebootStatus can be used interchangeably with VMGuestPatchRebootStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
NotNeeded
Required
Started
Failed
Completed

The states that a virtual machine scale set lifecycle hook event can be in. This is not settable by the customer. It is set only by the platform.
KnownVMScaleSetLifecycleHookEventState can be used interchangeably with VMScaleSetLifecycleHookEventState, this enum contains the known values that the service supports.

Known values supported by the service

Active: The lifecycle hook event is active. E.g., waiting on a response from the customer.
Completed: The lifecycle hook event is completed. i.e., all the target resources in the event have moved to a terminal state.

Specifies the scenario for which the customer is interested in receiving virtual machine scale set lifecycle hook events.
KnownVMScaleSetLifecycleHookEventType can be used interchangeably with VMScaleSetLifecycleHookEventType, this enum contains the known values that the service supports.

Known values supported by the service

UpgradeAutoOSScheduling: Lifecycle hook event sent to the customer before an Auto OS Upgrade operation starts on the virtual machine scale set.
UpgradeAutoOSRollingBatchStarting: Lifecycle hook event sent to the customer before upgrade starts on a batch of virtual machines belonging to a virtual machine scale set during an Auto OS Upgrade operation.

This property specifies the status of the validationProfile of the image version.
KnownValidationStatus can be used interchangeably with ValidationStatus, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
Failed
Succeeded

Specifies the eviction policy for the Azure Spot VM/VMSS
KnownVirtualMachineEvictionPolicyTypes can be used interchangeably with VirtualMachineEvictionPolicyTypes, this enum contains the known values that the service supports.

Known values supported by the service

Deallocate
Delete

Specifies the priority for a standalone virtual machine or the virtual machines in the scale set. 'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.
KnownVirtualMachinePriorityTypes can be used interchangeably with VirtualMachinePriorityTypes, this enum contains the known values that the service supports.

Known values supported by the service

Regular
Low
Spot

Type of VirtualMachineScaleSetScaleInRules

The scale type applicable to the sku.

Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
KnownVirtualMachineSizeTypes can be used interchangeably with VirtualMachineSizeTypes, this enum contains the known values that the service supports.

Known values supported by the service

Basic_A0
Basic_A1
Basic_A2
Basic_A3
Basic_A4
Standard_A0
Standard_A1
Standard_A2
Standard_A3
Standard_A4
Standard_A5
Standard_A6
Standard_A7
Standard_A8
Standard_A9
Standard_A10
Standard_A11
Standard_A1_v2
Standard_A2_v2
Standard_A4_v2
Standard_A8_v2
Standard_A2m_v2
Standard_A4m_v2
Standard_A8m_v2
Standard_B1s
Standard_B1ms
Standard_B2s
Standard_B2ms
Standard_B4ms
Standard_B8ms
Standard_D1
Standard_D2
Standard_D3
Standard_D4
Standard_D11
Standard_D12
Standard_D13
Standard_D14
Standard_D1_v2
Standard_D2_v2
Standard_D3_v2
Standard_D4_v2
Standard_D5_v2
Standard_D2_v3
Standard_D4_v3
Standard_D8_v3
Standard_D16_v3
Standard_D32_v3
Standard_D64_v3
Standard_D2s_v3
Standard_D4s_v3
Standard_D8s_v3
Standard_D16s_v3
Standard_D32s_v3
Standard_D64s_v3
Standard_D11_v2
Standard_D12_v2
Standard_D13_v2
Standard_D14_v2
Standard_D15_v2
Standard_DS1
Standard_DS2
Standard_DS3
Standard_DS4
Standard_DS11
Standard_DS12
Standard_DS13
Standard_DS14
Standard_DS1_v2
Standard_DS2_v2
Standard_DS3_v2
Standard_DS4_v2
Standard_DS5_v2
Standard_DS11_v2
Standard_DS12_v2
Standard_DS13_v2
Standard_DS14_v2
Standard_DS15_v2
Standard_DS13-4_v2
Standard_DS13-2_v2
Standard_DS14-8_v2
Standard_DS14-4_v2
Standard_E2_v3
Standard_E4_v3
Standard_E8_v3
Standard_E16_v3
Standard_E32_v3
Standard_E64_v3
Standard_E2s_v3
Standard_E4s_v3
Standard_E8s_v3
Standard_E16s_v3
Standard_E32s_v3
Standard_E64s_v3
Standard_E32-16_v3
Standard_E32-8s_v3
Standard_E64-32s_v3
Standard_E64-16s_v3
Standard_F1
Standard_F2
Standard_F4
Standard_F8
Standard_F16
Standard_F1s
Standard_F2s
Standard_F4s
Standard_F8s
Standard_F16s
Standard_F2s_v2
Standard_F4s_v2
Standard_F8s_v2
Standard_F16s_v2
Standard_F32s_v2
Standard_F64s_v2
Standard_F72s_v2
Standard_G1
Standard_G2
Standard_G3
Standard_G4
Standard_G5
Standard_GS1
Standard_GS2
Standard_GS3
Standard_GS4
Standard_GS5
Standard_GS4-8
Standard_GS4-4
Standard_GS5-16
Standard_GS5-8
Standard_H8
Standard_H16
Standard_H8m
Standard_H16m
Standard_H16r
Standard_H16mr
Standard_L4s
Standard_L8s
Standard_L16s
Standard_L32s
Standard_M64s
Standard_M64ms
Standard_M128s
Standard_M128ms
Standard_M64-32ms
Standard_M64-16ms
Standard_M128-64ms
Standard_M128-32ms
Standard_NC6
Standard_NC12
Standard_NC24
Standard_NC24r
Standard_NC6s_v2
Standard_NC12s_v2
Standard_NC24s_v2
Standard_NC24rs_v2
Standard_NC6s_v3
Standard_NC12s_v3
Standard_NC24s_v3
Standard_NC24rs_v3
Standard_ND6s
Standard_ND12s
Standard_ND24s
Standard_ND24rs
Standard_NV6
Standard_NV12
Standard_NV24

VM disk types which are disallowed.
KnownVmDiskTypes can be used interchangeably with VmDiskTypes, this enum contains the known values that the service supports.

Known values supported by the service

None
Unmanaged

Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
KnownWindowsPatchAssessmentMode can be used interchangeably with WindowsPatchAssessmentMode, this enum contains the known values that the service supports.

Known values supported by the service

ImageDefault
AutomaticByPlatform

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
KnownWindowsVMGuestPatchAutomaticByPlatformRebootSetting can be used interchangeably with WindowsVMGuestPatchAutomaticByPlatformRebootSetting, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
IfRequired
Never
Always

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
KnownWindowsVMGuestPatchMode can be used interchangeably with WindowsVMGuestPatchMode, this enum contains the known values that the service supports.

Known values supported by the service

Manual
AutomaticByOS
AutomaticByPlatform

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
KnownZonalPlatformFaultDomainAlignMode can be used interchangeably with ZonalPlatformFaultDomainAlignMode, this enum contains the known values that the service supports.

Known values supported by the service

Aligned
Unaligned
BestEffortAligned: Offload Alignment to VMSS. VMSS aligns disks that support enough Storage Fault Domains, while keeping others unaligned.

Specifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation.
KnownZonePlacementPolicyType can be used interchangeably with ZonePlacementPolicyType, this enum contains the known values that the service supports.

Known values supported by the service

Any
Auto: Automatic zone placement in a Virtual Machine Scale Set.

An enum to describe Azure Cloud environments.

This property allows you to specify whether the access control rules are in Audit mode, in Enforce mode or Disabled. Possible values are: 'Audit', 'Enforce' or 'Disabled'.

The Access Level, accepted values include None, Read, Write.

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

This is the aggregated replication status based on all the regional replication status flags.

Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated.

Describes the type of the alternative option.

CPU architecture supported by an OS disk.

Specifies the Architecture Type

Determines on how to handle disks with slow I/O.

Known values of CapacityReservationGroupInstanceViewTypes that the service accepts.

Known values of CapacityReservationInstanceViewTypes that the service accepts.

confidential VM encryption types

ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details.

Indicates the error code if the background copy of a resource created via the CopyStart operation fails.

The kind of entity that created the resource.

Additional authentication requirements when exporting or uploading to a disk or snapshot.

Specify what happens to the network interface when the VM is deleted

Specifies the ephemeral disk option for operating system disk.

Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01.

Specifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for virtual machines whose operating system disk and VM sku supports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please check the HyperVGenerations capability returned as part of VM sku capabilities in the response of Microsoft.Compute SKUs api for the region contains V2 (https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.

This enumerates the possible sources of a disk's creation.

Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point.

Specifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or detached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.

Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.

The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys.

The type of key used to encrypt the data of the disk.

Specifies the SecurityType of the VM. Applicable for OS disks only.

This enumerates the possible state of the disk.

The sku name.

The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created

Specifies the storage account type to be used to store the image. This property is not updatable.

The type of key used to encrypt the data of the disk.

This property allows you to specify if the requests will be allowed to access the host endpoints. Possible values are: 'Allow', 'Deny'.

Script execution status.

Known values of ExpandTypeForListVMs that the service accepts.

Known values of ExpandTypesForGetCapacityReservationGroups that the service accepts.

Known values of ExpandTypesForGetVMScaleSets that the service accepts.

Known values of ExpandTypesForListVMs that the service accepts.

The type of the extended location.

The type of extendedLocation.

Used to specify the file format when making request for SAS on a VHDX file format snapshot

Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot.

Known values of GalleryExpandParams that the service accepts.

It is type of the extended location.

The provisioning state, which only appears in the response.

Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum

This property allows you to specify the permission of sharing gallery. Possible values are: Private, Groups, Community.

Specifies the high speed interconnect placement for the virtual machine scale set.

The hypervisor generation of the Virtual Machine.

Specifies the HyperVGeneration Type associated with a resource

Specifies the HyperVGeneration Type

Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.

Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.

Describes the state of the image.

The action that will be applied to a target resource in the virtual machine scale set lifecycle hook event if the platform does not receive a response from the customer for the target resource before waitUntil.

Approval status of a target resource in a virtual machine scale set lifecycle hook event.

Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

ImageDefault - You control the timing of patch assessments on a virtual machine.

AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

ImageDefault - The virtual machine's default patching configuration is used.

AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true

Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.

Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation.

Policy for accessing the disk via network.

specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations

Specifies whether the Auxiliary mode is enabled for the Network Interface resource.

Specifies whether the Auxiliary sku is enabled for the Network Interface resource.