compute.azure.com/v1api20220301

"2022-03-01"

HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

HibernationEnabled: The flag that enables or disables hibernation capability on the VM.

UltraSSDEnabled: The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

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

Content: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.

PassName: The pass name. Currently, the only allowable value is OobeSystem.

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

"Microsoft-Windows-Shell-Setup"

"Microsoft-Windows-Shell-Setup"

"OobeSystem"

"OobeSystem"

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

Content: Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.

PassName: The pass name. Currently, the only allowable value is OobeSystem.

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

"AutoLogon"

"FirstLogonCommands"

"AutoLogon"

"FirstLogonCommands"

Reference: The ARM resource id in the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​…

Id: The ARM resource id in the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​…

Code: The error code.

Message: The error message.

Target: The target of the particular error.

Code: The error code.

Details: The Api error details

Innererror: The Api inner error

Message: The error message.

Target: The target of the particular error.

GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

GalleryApplications: Specifies the gallery applications that should be made available to the VM/VMSS

DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

EnableAutomaticOSUpgrade: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.

UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

DisableAutomaticRollback: Whether OS image rollback feature should be disabled. Default value is false.

EnableAutomaticOSUpgrade: Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, enableAutomaticUpdates is automatically set to false and cannot be set to true.

UseRollingUpgradePolicy: Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS.

Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

GracePeriod: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

"Reimage"

"Replace"

"Restart"

"Reimage"

"Replace"

"Restart"

Enabled: Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false.

GracePeriod: The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M).

RepairAction: Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace.

AssessmentActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

CriticalAndSecurityPatchCount: The number of critical or security patches that have been detected as available and not yet installed.

Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

LastModifiedTime: The UTC timestamp when the operation began.

OtherPatchCount: The number of all available patches excluding critical and security.

RebootPending: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred.

StartTime: The UTC timestamp when the operation began.

Status: 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.”

"CompletedWithWarnings"

"Failed"

"InProgress"

"Succeeded"

"Unknown"

MaxPrice: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: - Any decimal value greater than zero. Example: 0.01538 -1 – indicates default price to be up-to on-demand. You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. Minimum api-version: 2019-03-01.

MaxPrice: Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price. The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS. Possible values are: - Any decimal value greater than zero. Example: 0.01538 -1 – indicates default price to be up-to on-demand. You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you. Minimum api-version: 2019-03-01.

Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

StorageUri: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

ConsoleScreenshotBlobUri: The console screenshot blob URI. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

SerialConsoleLogBlobUri: The serial console log blob Uri. NOTE: This will not be set if boot diagnostics is currently enabled with managed storage.

Status: The boot diagnostics status information for the VM. NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

Enabled: Whether boot diagnostics should be enabled on the Virtual Machine.

StorageUri: Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

"None"

"ReadOnly"

"ReadWrite"

"None"

"ReadOnly"

"ReadWrite"

CapacityReservationGroup: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.

CapacityReservationGroup: Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details.

"Attach"

"Empty"

"FromImage"

"Attach"

"Empty"

"FromImage"

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

CreateOption: Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

DetachOption: 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: 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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to ‘true’ along with setting detachOption: ‘ForceDetach’.

DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB

Image: 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.

Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

ManagedDisk: The managed disk parameters.

Name: The disk name.

ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

Vhd: The virtual hard disk.

WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

CreateOption: Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DeleteOption: Specifies whether data disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the data disk is deleted when VM is deleted. Detach If this value is used, the data disk is retained after VM is deleted. The default value is set to detach

DetachOption: 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: 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 mode and is not supported for VirtualMachineScaleSet. To force-detach a data disk update toBeDetached to ‘true’ along with setting detachOption: ‘ForceDetach’.

DiskIOPSReadWrite: Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

DiskMBpsReadWrite: Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set.

DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB

Image: 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.

Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

ManagedDisk: The managed disk parameters.

Name: The disk name.

ToBeDetached: Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

Vhd: The virtual hard disk.

WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

"Delete"

"Detach"

"Delete"

"Detach"

"ForceDetach"

"ForceDetach"

BootDiagnostics: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

BootDiagnostics: Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.

"Local"

"Local"

"CacheDisk"

"ResourceDisk"

"CacheDisk"

"ResourceDisk"

Option: Specifies the ephemeral disk settings for operating system disk.

Placement: Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk ResourceDisk Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

Option: Specifies the ephemeral disk settings for operating system disk.

Placement: Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk ResourceDisk Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk.

DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.

Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.

DiskEncryptionKey: Specifies the location of the disk encryption key, which is a Key Vault Secret.

Enabled: Specifies whether disk encryption should be enabled on the virtual machine.

KeyEncryptionKey: Specifies the location of the key encryption key in Key Vault.

EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

Name: The disk name.

Statuses: The resource status information.

"Deallocate"

"Delete"

"Deallocate"

"Delete"

Name: The name of the extended location.

Type: The type of the extended location.

"EdgeZone"

"EdgeZone"

Name: The name of the extended location.

Type: The type of the extended location.

VmSize: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. 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.

VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

VmSize: Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. 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.

VmSizeProperties: Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.

"Basic_A0"

"Basic_A1"

"Basic_A2"

"Basic_A3"

"Basic_A4"

"Standard_A0"

"Standard_A1"

"Standard_A10"

"Standard_A11"

"Standard_A1_v2"

"Standard_A2"

"Standard_A2m_v2"

"Standard_A2_v2"

"Standard_A3"

"Standard_A4"

"Standard_A4m_v2"

"Standard_A4_v2"

"Standard_A5"

"Standard_A6"

"Standard_A7"

"Standard_A8"

"Standard_A8m_v2"

"Standard_A8_v2"

"Standard_A9"

"Standard_B1ms"

"Standard_B1s"

"Standard_B2ms"

"Standard_B2s"

"Standard_B4ms"

"Standard_B8ms"

"Standard_D1"

"Standard_D11"

"Standard_D11_v2"

"Standard_D12"

"Standard_D12_v2"

"Standard_D13"

"Standard_D13_v2"

"Standard_D14"

"Standard_D14_v2"

"Standard_D15_v2"

"Standard_D16s_v3"

"Standard_D16_v3"

"Standard_D1_v2"

"Standard_D2"

"Standard_D2s_v3"

"Standard_D2_v2"

"Standard_D2_v3"

"Standard_D3"

"Standard_D32s_v3"

"Standard_D32_v3"

"Standard_D3_v2"

"Standard_D4"

"Standard_D4s_v3"

"Standard_D4_v2"

"Standard_D4_v3"

"Standard_D5_v2"

"Standard_D64s_v3"

"Standard_D64_v3"

"Standard_D8s_v3"

"Standard_D8_v3"

"Standard_DS1"

"Standard_DS11"

"Standard_DS11_v2"

"Standard_DS12"

"Standard_DS12_v2"

"Standard_DS13"

"Standard_DS13-2_v2"

"Standard_DS13-4_v2"

"Standard_DS13_v2"

"Standard_DS14"

"Standard_DS14-4_v2"

"Standard_DS14-8_v2"

"Standard_DS14_v2"

"Standard_DS15_v2"

"Standard_DS1_v2"

"Standard_DS2"

"Standard_DS2_v2"

"Standard_DS3"

"Standard_DS3_v2"

"Standard_DS4"

"Standard_DS4_v2"

"Standard_DS5_v2"

"Standard_E16s_v3"

"Standard_E16_v3"

"Standard_E2s_v3"

"Standard_E2_v3"

"Standard_E32-16_v3"

"Standard_E32-8s_v3"

"Standard_E32s_v3"

"Standard_E32_v3"

"Standard_E4s_v3"

"Standard_E4_v3"

"Standard_E64-16s_v3"

"Standard_E64-32s_v3"

"Standard_E64s_v3"

"Standard_E64_v3"

"Standard_E8s_v3"

"Standard_E8_v3"

"Standard_F1"

"Standard_F16"

"Standard_F16s"

"Standard_F16s_v2"

"Standard_F1s"

"Standard_F2"

"Standard_F2s"

"Standard_F2s_v2"

"Standard_F32s_v2"

"Standard_F4"

"Standard_F4s"

"Standard_F4s_v2"

"Standard_F64s_v2"

"Standard_F72s_v2"

"Standard_F8"

"Standard_F8s"

"Standard_F8s_v2"

"Standard_G1"

"Standard_G2"

"Standard_G3"

"Standard_G4"

"Standard_G5"

"Standard_GS1"

"Standard_GS2"

"Standard_GS3"

"Standard_GS4"

"Standard_GS4-4"

"Standard_GS4-8"

"Standard_GS5"

"Standard_GS5-16"

"Standard_GS5-8"

"Standard_H16"

"Standard_H16m"

"Standard_H16mr"

"Standard_H16r"

"Standard_H8"

"Standard_H8m"

"Standard_L16s"

"Standard_L32s"

"Standard_L4s"

"Standard_L8s"

"Standard_M128-32ms"

"Standard_M128-64ms"

"Standard_M128ms"

"Standard_M128s"

"Standard_M64-16ms"

"Standard_M64-32ms"

"Standard_M64ms"

"Standard_M64s"

"Standard_NC12"

"Standard_NC12s_v2"

"Standard_NC12s_v3"

"Standard_NC24"

"Standard_NC24r"

"Standard_NC24rs_v2"

"Standard_NC24rs_v3"

"Standard_NC24s_v2"

"Standard_NC24s_v3"

"Standard_NC6"

"Standard_NC6s_v2"

"Standard_NC6s_v3"

"Standard_ND12s"

"Standard_ND24rs"

"Standard_ND24s"

"Standard_ND6s"

"Standard_NV12"

"Standard_NV24"

"Standard_NV6"

"V1"

"V2"

"V1"

"V2"

BlobUri: The Virtual Hard Disk.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.

DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

ManagedDisk: The managedDisk.

Snapshot: The snapshot.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

"None"

"ReadOnly"

"ReadWrite"

"None"

"ReadOnly"

"ReadWrite"

BlobUri: The Virtual Hard Disk.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.

DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

Lun: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM.

ManagedDisk: The managedDisk.

Snapshot: The snapshot.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

BlobUri: The Virtual Hard Disk.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.

DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

ManagedDisk: The managedDisk.

OsState: The OS State. For managed images, use Generalized.

OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

Snapshot: The snapshot.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

"None"

"ReadOnly"

"ReadWrite"

"None"

"ReadOnly"

"ReadWrite"

"Generalized"

"Specialized"

"Generalized"

"Specialized"

"Linux"

"Windows"

"Linux"

"Windows"

BlobUri: The Virtual Hard Disk.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed image disk.

DiskSizeGB: Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB

ManagedDisk: The managedDisk.

OsState: The OS State. For managed images, use Generalized.

OsType: This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: Windows Linux

Snapshot: The snapshot.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

Publisher: The image publisher.

Reference: Resource Id

SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

Sku: The image SKU.

Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

CommunityGalleryImageId: Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call.

ExactVersion: Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from ‘version’, only if the value specified in ‘version’ field is ‘latest’.

Id: Resource Id

Offer: Specifies the offer of the platform image or marketplace image used to create the virtual machine.

Publisher: The image publisher.

SharedGalleryImageId: Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call.

Sku: The image SKU.

Version: Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor, and Build are decimal numbers. Specify ‘latest’ to use the latest version of an image available at deploy time. Even if you use ‘latest’, the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field ‘version’ for gallery image deployment, gallery image should always use ‘id’ field for deployment, to use ‘latest’ version of gallery image, just set ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​images/​{imageName}’ in the ‘id’ field without version input.

DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

OsDisk: 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.

ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

OsDisk: 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.

ZoneResilient: Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS).

Conditions: The observed state of the resource

ExtendedLocation: The extended location of the Image.

HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

Id: Resource Id

Location: Resource location

Name: Resource name

ProvisioningState: The provisioning state.

SourceVirtualMachine: The source virtual machine from which Image is created.

StorageProfile: Specifies the storage settings for the virtual machine disks.

Tags: Resource tags

Type: Resource type

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

ExtendedLocation: The extended location of the Image.

HyperVGeneration: Specifies the HyperVGenerationType of the VirtualMachine created from the image. From API Version 2019-03-01 if the image source is a blob, then we need the user to specify the value, if the source is managed resource like disk or snapshot, we may require the user to specify the property if we cannot deduce it from the source managed resource.

Location: Resource location

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

SourceVirtualMachine: The source virtual machine from which Image is created.

StorageProfile: Specifies the storage settings for the virtual machine disks.

Tags: Resource tags

Errordetail: The internal error message or exception dump.

Exceptiontype: The exception type.

Code: The status code.

DisplayStatus: The short localizable label for the status.

Level: The level code.

Message: The detailed status message, including for alerts and error messages.

Time: The time of the status.

"Error"

"Info"

"Warning"

"Error"

"Info"

"Warning"

Code: The status code.

DisplayStatus: The short localizable label for the status.

Level: The level code.

Message: The detailed status message, including for alerts and error messages.

Time: The time of the status.

KeyUrl: The URL referencing a key encryption key in Key Vault.

SourceVault: The relative URL of the Key Vault containing the key.

KeyUrl: The URL referencing a key encryption key in Key Vault.

SourceVault: The relative URL of the Key Vault containing the key.

SecretUrl: The URL referencing a secret in a Key Vault.

SourceVault: The relative URL of the Key Vault containing the secret.

SecretUrl: The URL referencing a secret in a Key Vault.

SourceVault: The relative URL of the Key Vault containing the secret.

Error: The errors that were encountered during execution of the operation. The details array contains the list of them.

ExcludedPatchCount: The number of all available patches but excluded explicitly by a customer-specified exclusion list match.

FailedPatchCount: The count of patches that failed installation.

InstallationActivityId: The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.

InstalledPatchCount: The count of patches that successfully installed.

LastModifiedTime: The UTC timestamp when the operation began.

MaintenanceWindowExceeded: Describes whether the operation ran out of time before it completed all its intended actions

NotSelectedPatchCount: The number of all available patches but not going to be installed because it didn’t match a classification or inclusion list entry.

PendingPatchCount: The number of all available patches expected to be installed over the course of the patch installation operation.

StartTime: The UTC timestamp when the operation began.

Status: 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.”

"CompletedWithWarnings"

"Failed"

"InProgress"

"Succeeded"

"Unknown"

DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.

ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

Ssh: Specifies the ssh key configuration for a Linux OS.

DisablePasswordAuthentication: Specifies whether password authentication should be disabled.

PatchSettings: [Preview Feature] Specifies settings related to VM Guest Patching on Linux.

ProvisionVMAgent: Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

Ssh: Specifies the ssh key configuration for a Linux OS.

AssessmentMode: 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.

AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

PatchMode: 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

"AutomaticByPlatform"

"ImageDefault"

"AutomaticByPlatform"

"ImageDefault"

"AutomaticByPlatform"

"ImageDefault"

"AutomaticByPlatform"

"ImageDefault"

AssessmentMode: 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.

AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.

PatchMode: 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

RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

"Always"

"IfRequired"

"Never"

"Unknown"

"Always"

"IfRequired"

"Never"

"Unknown"

RebootSetting: Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

"MaintenanceAborted"

"MaintenanceCompleted"

"None"

"RetryLater"

IsCustomerInitiatedMaintenanceAllowed: True, if customer is allowed to perform Maintenance.

LastOperationMessage: Message returned for the last Maintenance Operation.

LastOperationResultCode: The Last Maintenance Operation Result Code.

MaintenanceWindowEndTime: End Time for the Maintenance Window.

MaintenanceWindowStartTime: Start Time for the Maintenance Window.

PreMaintenanceWindowEndTime: End Time for the Pre Maintenance Window.

PreMaintenanceWindowStartTime: Start Time for the Pre Maintenance Window.

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

Reference: Resource Id

SecurityProfile: Specifies the security profile for the managed disk.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk.

Id: Resource Id

SecurityProfile: Specifies the security profile for the managed disk.

StorageAccountType: Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.

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

Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

Reference: Resource Id

"Delete"

"Detach"

"Delete"

"Detach"

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

Id: Resource Id

Primary: Specifies the primary network interface in case the virtual machine has more than 1 network interface.

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

NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

"2020-11-01"

"2020-11-01"

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

NetworkInterfaceConfigurations: Specifies the networking configurations that will be used to create the virtual machine networking resources.

NetworkInterfaces: Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage.

CreateOption: Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB

EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

Image: 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.

ManagedDisk: The managed disk parameters.

Name: The disk name.

OsType: 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

Vhd: The virtual hard disk.

WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

"Linux"

"Windows"

"Linux"

"Windows"

Caching: Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage.

CreateOption: Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

DeleteOption: Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values: Delete If this value is used, the OS disk is deleted when VM is deleted. Detach If this value is used, the os disk is retained after VM is deleted. The default value is set to detach. For an ephemeral OS Disk, the default value is set to Delete. User cannot change the delete option for ephemeral OS Disk.

DiffDiskSettings: Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.

DiskSizeGB: Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. This value cannot be larger than 1023 GB

EncryptionSettings: Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15

Image: 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.

ManagedDisk: The managed disk parameters.

Name: The disk name.

OsType: 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

Vhd: The virtual hard disk.

WriteAcceleratorEnabled: Specifies whether writeAccelerator should be enabled or disabled on the disk.

AdminPassword: Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: “abc@123”, “P@$$w0rd”, “P@ssw0rd”, “P@ssword123”, “Pa$$word”, “pass@word1”, “Password!”, “Password1”, “Password22”, “iloveyou!” For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

AdminUsername: Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.

AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.

ComputerName: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.

CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

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

RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

AdminUsername: Specifies the name of the administrator account. This property cannot be updated after the VM is created. Windows-only restriction: Cannot end in “.” Disallowed values: “administrator”, “admin”, “user”, “user1”, “test”, “user2”, “test1”, “user3”, “admin1”, “1”, “123”, “a”, “actuser”, “adm”, “admin2”, “aspnet”, “backup”, “console”, “david”, “guest”, “john”, “owner”, “root”, “server”, “sql”, “support”, “support_388945a0”, “sys”, “test2”, “test3”, “user4”, “user5”. Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters.

AllowExtensionOperations: Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine.

ComputerName: Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines.

CustomData: Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property This property cannot be updated after the VM is created. customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation

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

RequireGuestProvisionSignal: Optional property which must either be set to True or omitted.

Secrets: Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

WindowsConfiguration: Specifies Windows operating system settings on the virtual machine.

"Flexible"

"Uniform"

"Flexible"

"Uniform"

AssessmentMode: 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.

AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

EnableHotpatching: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the ‘provisionVMAgent’ must be set to true and ‘patchMode’ must be set to ‘AutomaticByPlatform’.

PatchMode: 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

"AutomaticByPlatform"

"ImageDefault"

"AutomaticByPlatform"

"ImageDefault"

"AutomaticByOS"

"AutomaticByPlatform"

"Manual"

"AutomaticByOS"

"AutomaticByPlatform"

"Manual"

AssessmentMode: 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.

AutomaticByPlatformSettings: Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.

EnableHotpatching: Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the ‘provisionVMAgent’ must be set to true and ‘patchMode’ must be set to ‘AutomaticByPlatform’.

PatchMode: 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

Name: The plan ID.

Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

PromotionCode: The promotion code.

Publisher: The publisher ID.

Name: The plan ID.

Product: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.

PromotionCode: The promotion code.

Publisher: The publisher ID.

"Low"

"Regular"

"Spot"

"Low"

"Regular"

"Spot"

Name: Specify public IP sku name

Tier: Specify public IP sku tier

"Basic"

"Standard"

"Basic"

"Standard"

Name: Specify public IP sku name

Tier: Specify public IP sku tier

"Global"

"Regional"

"Global"

"Regional"

EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

MaxBatchInstancePercent: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.

MaxUnhealthyInstancePercent: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.

MaxUnhealthyUpgradedInstancePercent: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.

PauseTimeBetweenBatches: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).

PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

EnableCrossZoneUpgrade: Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size.

MaxBatchInstancePercent: The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%.

MaxUnhealthyInstancePercent: The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%.

MaxUnhealthyUpgradedInstancePercent: The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%.

PauseTimeBetweenBatches: The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S).

PrioritizeUnhealthyInstances: Upgrade all unhealthy instances in a scale set before any healthy instances.

ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

Rules: The rules to be followed when scaling-in a virtual machine scale set. Possible values are: Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

"Default"

"NewestVM"

"OldestVM"

"Default"

"NewestVM"

"OldestVM"

ForceDeletion: This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview)

Rules: The rules to be followed when scaling-in a virtual machine scale set. Possible values are: Default When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in. OldestVM When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal. NewestVM When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

TerminateNotificationProfile: Specifies Terminate Scheduled Event related configurations.

EncryptionAtHost: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.

SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

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

EncryptionAtHost: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.

SecurityType: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. Default: UefiSettings will not be enabled unless this property is set.

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

"ConfidentialVM"

"TrustedLaunch"

"ConfidentialVM"

"TrustedLaunch"

Capacity: Specifies the number of virtual machines in the scale set.

Name: The sku name.

Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

Capacity: Specifies the number of virtual machines in the scale set.

Name: The sku name.

Tier: Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic

Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

Enabled: Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints

RestoreTimeout: Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances

PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

PublicKeys: The list of SSH public keys used to authenticate with linux based VMs.

KeyData: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

KeyData: SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

Path: Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys

"PremiumV2_LRS"

"Premium_LRS"

"Premium_ZRS"

"StandardSSD_LRS"

"StandardSSD_ZRS"

"Standard_LRS"

"UltraSSD_LRS"

"PremiumV2_LRS"

"Premium_LRS"

"Premium_ZRS"

"StandardSSD_LRS"

"StandardSSD_ZRS"

"Standard_LRS"

"UltraSSD_LRS"

DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

ImageReference: 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.

OsDisk: 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.

DataDisks: Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.

ImageReference: 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.

OsDisk: 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.

Reference: Resource Id

Id: Resource Id

Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

NotBeforeTimeout: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)

Enable: Specifies whether the Terminate Scheduled event is enabled or disabled.

NotBeforeTimeout: Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)

SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

SecureBootEnabled: Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01

VTpmEnabled: Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01

AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

Mode: 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.

RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

"Automatic"

"Manual"

"Rolling"

"Automatic"

"Manual"

"Rolling"

AutomaticOSUpgradePolicy: Configuration parameters used for performing automatic OS Upgrade.

Mode: 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.

RollingUpgradePolicy: The configuration parameters used while performing a rolling upgrade.

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

DiskEncryptionSet: Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob.

SecurityEncryptionType: Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, and VMGuestStateOnly for encryption of just the VMGuestState blob. NOTE: It can be set for only Confidential VMs.

"DiskWithVMGuestState"

"VMGuestStateOnly"

"DiskWithVMGuestState"

"VMGuestStateOnly"

ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

Order: Optional, Specifies the order in which the packages have to be installed

PackageReferenceReference: Specifies the GalleryApplicationVersion resource id on the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​applications/​{application}/​versions/​{version}

Tags: Optional, Specifies a passthrough value for more generic context.

TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

ConfigurationReference: Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided

EnableAutomaticUpgrade: If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS

Order: Optional, Specifies the order in which the packages have to be installed

PackageReferenceId: Specifies the GalleryApplicationVersion resource id on the form of /​subscriptions/​{SubscriptionId}/​resourceGroups/​{ResourceGroupName}/​providers/​Microsoft.Compute/​galleries/​{galleryName}/​applications/​{application}/​versions/​{version}

Tags: Optional, Specifies a passthrough value for more generic context.

TreatFailureAsDeploymentFailure: Optional, If true, any failure for any operation in the VmApplication will fail the deployment

VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

VCPUsAvailable: Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region .

VCPUsPerCore: Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region Setting this property to 1 also means that hyper-threading is disabled.

CertificateStore: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.

CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

CertificateStore: For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted.

CertificateUrl: This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { “data”:””, “dataType”:“pfx”, “password”:”” } To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.

SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

VaultCertificates: The list of key vault references in SourceVault which contain certificates.

SourceVault: The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

VaultCertificates: The list of key vault references in SourceVault which contain certificates.

Uri: Specifies the virtual hard disk’s uri.

Uri: Specifies the virtual hard disk’s uri.

ExtensionHandlers: The virtual machine extension handler instance view.

Statuses: The resource status information.

VmAgentVersion: The VM Agent full version.

Status: The extension handler status.

Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

TypeHandlerVersion: Specifies the version of the script handler.

Name: The virtual machine extension name.

Statuses: The resource status information.

Substatuses: The resource status information.

Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

TypeHandlerVersion: Specifies the version of the script handler.

Name: The virtual machine extension name.

Statuses: The resource status information.

Substatuses: The resource status information.

Type: Specifies the type of the extension; an example is “CustomScriptExtension”.

TypeHandlerVersion: Specifies the version of the script handler.

AutoUpgradeMinorVersion: Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

EnableAutomaticUpgrade: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.

ForceUpdateTag: How the extension handler should be forced to update even if the extension configuration has not changed.

Id: Resource Id

InstanceView: The virtual machine extension instance view.

Location: Resource location

Name: Resource name

PropertiesType: Specifies the type of the extension; an example is “CustomScriptExtension”.

ProtectedSettingsFromKeyVault: The extensions protected settings that are passed by reference, and consumed from key vault

ProvisioningState: The provisioning state, which only appears in the response.

Publisher: The name of the extension handler publisher.

Settings: Json formatted public settings for the extension.

SuppressFailures: Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

Tags: Resource tags

Type: Resource type

TypeHandlerVersion: Specifies the version of the script handler.

Status: The health status information for the VM.

Type: The type of identity used for the virtual machine. 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.

UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

PrincipalId: The principal id of virtual machine identity. This property will only be provided for a system assigned identity.

TenantId: The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity.

Type: The type of identity used for the virtual machine. 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.

UserAssignedIdentities: The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}’.

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

ClientId: The client id of user assigned identity.

PrincipalId: The principal id of user assigned identity.

"V1"

"V2"

AssignedHost: Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01.

BootDiagnostics: 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.

ComputerName: The computer name assigned to the virtual machine.

Disks: The virtual machine disk information.

Extensions: The extensions information.

HyperVGeneration: Specifies the HyperVGeneration Type associated with a resource

MaintenanceRedeployStatus: The Maintenance Operation status on the virtual machine.

OsName: The Operating System running on the virtual machine.

OsVersion: The version of Operating System running on the virtual machine.

PatchStatus: [Preview Feature] The status of virtual machine patch operations.

PlatformFaultDomain: Specifies the fault domain of the virtual machine.

PlatformUpdateDomain: Specifies the update domain of the virtual machine.

RdpThumbPrint: The Remote desktop certificate thumbprint.

Statuses: The resource status information.

VmAgent: The VM Agent running on the virtual machine.

VmHealth: The health status for the VM.

IpTagType: IP tag type. Example: FirstPartyUsage.

Tag: IP tag associated with the public IP. Example: SQL, Storage etc.

IpTagType: IP tag type. Example: FirstPartyUsage.

Tag: IP tag associated with the public IP. Example: SQL, Storage etc.