PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/?api-version=2023-09-01

The name of the virtual machine.

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

The name of the resource group.

Default value: "application/json"

Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will result in error from server as they are not supported.

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

Describes the properties of a Virtual Machine.

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

Specifies Windows operating system settings on the virtual machine.

Describes Windows Remote Management configuration of the VM

The list of Windows Remote Management listeners

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

Possible values:

• "Https"
• "Http"

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

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

Specifies settings related to VM Guest Patching on Windows.

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.

Possible values:

• "ImageDefault"
• "AutomaticByPlatform"

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

Possible values:

• "Manual"
• "AutomaticByPlatform"
• "AutomaticByOS"

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'.

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

Enables customer to schedule patching without accidental upgrades

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Possible values:

• "Always"
• "Unknown"
• "IfRequired"
• "Never"

Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.

Indicates whether VMAgent Platform Updates is enabled for the Windows virtual machine. Default value is false.

Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.

Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

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

Possible values:

• "AutoLogon"
• "FirstLogonCommands"

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

Possible values:

• "OobeSystem"

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.

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

Possible values:

• "Microsoft-Windows-Shell-Setup"

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. The property '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.

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

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.

Specifies settings related to VM Guest Patching on Linux.

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.

Possible values:

• "ImageDefault"
• "AutomaticByPlatform"

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

Possible values:

• "ImageDefault"
• "AutomaticByPlatform"

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

Enables customer to schedule patching without accidental upgrades

Specifies the reboot setting for all AutomaticByPlatform patch installation operations.

Possible values:

• "Always"
• "Unknown"
• "IfRequired"
• "Never"

Specifies whether password authentication should be disabled.

Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false.

SSH configuration for Linux based VMs running on Azure

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

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).

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

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.

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.

Resource Id

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

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.

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.

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.

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

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

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.

Resource Id

The parameters of a capacity reservation Profile.

Resource Id

The instance view of a virtual machine.

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

The VM Agent full version.

The resource status information.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

The virtual machine extension handler instance view.

Specifies the type of the extension; an example is "CustomScriptExtension".

Instance view status.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

Specifies the version of the script handler.

Maintenance Operation Status.

The Last Maintenance Operation Result Code.

Possible values:

• "MaintenanceCompleted"
• "RetryLater"
• "None"
• "MaintenanceAborted"

True, if customer is allowed to perform Maintenance.

Message returned for the last Maintenance Operation.

End Time for the Pre Maintenance Window.

End Time for the Maintenance Window.

Start Time for the Pre Maintenance Window.

Start Time for the Maintenance Window.

The health status of the VM.

Instance view status.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

Specifies the fault domain of the virtual machine.

The Operating System running on the virtual machine.

The computer name assigned to the virtual machine.

The version of Operating System running on the virtual machine.

Specifies the update domain of the virtual machine.

The resource status information.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

The extensions information.

The virtual machine extension name.

Specifies the type of the extension; an example is "CustomScriptExtension".

Specifies the version of the script handler.

The resource status information.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

The resource status information.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

The instance view of a virtual machine boot diagnostics.

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

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

Instance view status.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

The Remote desktop certificate thumbprint.

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.

The virtual machine disk information.

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Describes a reference to Key Vault Key

Resource Id

The URL referencing a key encryption key in Key Vault.

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

Describes a reference to Key Vault Secret

Resource Id

The URL referencing a secret in a Key Vault.

The disk name.

The resource status information.

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

Specifies the HyperVGeneration Type associated with a resource

Possible values:

• "V2"
• "V1"

The status of virtual machine patch operations.

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

The UTC timestamp when the operation began.

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

The number of all available patches excluding critical and security.

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.

Api error.

The error message.

The target of the particular error.

Inner error details.

The internal error message or exception dump.

The exception type.

The error code.

The Api error details

The error message.

The target of the particular error.

The error code.

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."

Possible values:

• "CompletedWithWarnings"
• "Succeeded"
• "Unknown"
• "InProgress"
• "Failed"

The UTC timestamp when the operation began.

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

Describes the properties of the last installed patch summary.

The UTC timestamp when the operation began.

The count of patches that failed installation.

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

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

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

The count of patches that successfully installed.

Api error.

The error message.

The target of the particular error.

Inner error details.

The internal error message or exception dump.

The exception type.

The error code.

The Api error details

The error message.

The target of the particular error.

The error code.

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."

Possible values:

• "CompletedWithWarnings"
• "Succeeded"
• "Unknown"
• "InProgress"
• "Failed"

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

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

The UTC timestamp when the operation began.

The enablement status of the specified patchMode

The time of the status.

The short localizable label for the status.

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

The level code.

Possible values:

• "Error"
• "Warning"
• "Info"

The status code.

[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool.

Specifies the eviction policy for the Azure Spot VM/VMSS

Possible values:

• "Deallocate"
• "Delete"

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

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

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

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

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

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

Optional, Specifies a passthrough value for more generic context.

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

Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands.

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.

Possible values:

• "Low"
• "Spot"
• "Regular"

Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01.

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

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

The network interface configuration name.

Describes a virtual machine network profile's IP configuration.

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

Possible values:

• "Detach"
• "Delete"

Specifies whether the network interface is disabled for tcp state tracking.

Whether IP forwarding enabled on this NIC.

Resource Id

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

Possible values:

• "AcceleratedConnections"
• "None"
• "Floating"

Resource Id

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

Possible values:

• "A1"
• "A8"
• "None"
• "A4"
• "A2"

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

Specifies whether the network interface is accelerated networking-enabled.

Specifies the IP configurations of the network interface.

The IP configuration name.

Describes a virtual machine network interface IP configuration properties.

Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer].

Resource Id

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'.

Possible values:

• "IPv4"
• "IPv6"

Specifies an array of references to application security group.

Resource Id

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

Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway.

Resource Id

Describes a virtual machines IP Configuration's PublicIPAddress configuration

The publicIP address configuration name.

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

Specify public IP sku tier

Possible values:

• "Regional"
• "Global"

Specify public IP sku name

Possible values:

• "Basic"
• "Standard"

Describes a virtual machines IP Configuration's PublicIPAddress configuration

Specify what happens to the public IP address when the VM is deleted

Possible values:

• "Detach"
• "Delete"

The idle timeout of the public IP address.

Resource Id

Specify the public IP allocation type

Possible values:

• "Dynamic"
• "Static"

The list of IP tags associated with the public IP address.

IP tag type. Example: FirstPartyUsage.

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

Describes a virtual machines network configuration's DNS settings.

The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.

Possible values:

• "SubscriptionReuse"
• "NoReuse"
• "TenantReuse"
• "ResourceGroupReuse"

The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID.

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

Possible values:

• "IPv4"
• "IPv6"

Resource Id

Specifies whether the network interface is FPGA networking-enabled.

Describes a virtual machines network configuration's DNS settings.

List of DNS servers IP addresses

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

Possible values:

• "2020-11-01"

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

Resource Id

Describes a network interface reference properties.

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

Possible values:

• "Detach"
• "Delete"

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

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

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.

Whether boot diagnostics should be enabled on the Virtual Machine.

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.

The provisioning state, which only appears in the response.

Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01.

Resource Id

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

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.

Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see Azure Hybrid Use Benefit for Windows Server

Azure Hybrid Use Benefit for Linux Server

Minimum api-version: 2015-06-15

UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01.

Resource Id

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

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. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.

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

Possible values:

• "ConfidentialVM"
• "TrustedLaunch"

Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.

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.

Possible values:

• "Audit"
• "Enforce"

Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

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

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

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

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

Specifies ARM Resource ID of one of the user identities associated with the VM.

Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M)

Specifies whether the OS Image Scheduled event is enabled or disabled.

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)

Specifies whether the Terminate Scheduled event is enabled or disabled.

Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01.

Resource Id

Resource Id

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

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.

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

Specifies the hardware settings for the virtual machine.

Specifies VM Size Property settings on the virtual machine.

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.

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.

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.

Possible values:

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

Specifies the storage settings for the virtual machine disks.

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.

Possible values:

• "NVMe"
• "SCSI"

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.

Describes the uri of a disk.

Specifies the virtual hard disk's uri.

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

Possible values:

• "None"
• "ReadOnly"
• "ReadWrite"

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

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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

Describes the uri of a disk.

Specifies the virtual hard disk's uri.

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

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.

Possible values:

• "Detach"
• "Delete"

The disk name.

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.

Specifies how the virtual machine 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 also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

Possible values:

• "Empty"
• "FromImage"
• "Attach"

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.

The parameters of a managed disk.

Resource Id

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

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.

Resource Id

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.

Possible values:

• "VMGuestStateOnly"
• "NonPersistedTPM"
• "DiskWithVMGuestState"

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

Possible values:

• "PremiumV2_LRS"
• "UltraSSD_LRS"
• "StandardSSD_LRS"
• "Standard_LRS"
• "Premium_ZRS"
• "StandardSSD_ZRS"
• "Premium_LRS"

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.

Resource Id

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

Possible values:

• "ForceDetach"

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.

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.

Resource Id

The image SKU.

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

The image publisher.

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'.

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.

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

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

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.

Describes a Encryption Settings for a Disk

Describes a reference to Key Vault Key

Resource Id

The URL referencing a key encryption key in Key Vault.

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

Describes a reference to Key Vault Secret

Resource Id

The URL referencing a secret in a Key Vault.

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.

Possible values:

• "Detach"
• "Delete"

The disk name.

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.

Specifies the ephemeral disk option for operating system disk.

Possible values:

• "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 or resource 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

Possible values:

• "ResourceDisk"
• "CacheDisk"

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.

Possible values:

• "Windows"
• "Linux"

Describes the uri of a disk.

Specifies the virtual hard disk's uri.

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

Possible values:

• "None"
• "ReadOnly"
• "ReadWrite"

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

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. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023.

Specifies how the virtual machine 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 also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

Possible values:

• "Empty"
• "FromImage"
• "Attach"

Describes the uri of a disk.

Specifies the virtual hard disk's uri.

The parameters of a managed disk.

Resource Id

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

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.

Resource Id

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.

Possible values:

• "VMGuestStateOnly"
• "NonPersistedTPM"
• "DiskWithVMGuestState"

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

Possible values:

• "PremiumV2_LRS"
• "UltraSSD_LRS"
• "StandardSSD_LRS"
• "Standard_LRS"
• "Premium_ZRS"
• "StandardSSD_ZRS"
• "Premium_LRS"

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.

Resource Id

The virtual machine zones.

Resource tags

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.

The plan ID.

The publisher ID.

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

The promotion code.

Identity for the virtual machine.

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

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.

Possible values:

• "SystemAssigned"
• "UserAssigned"
• "None"
• "SystemAssigned, UserAssigned"

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}'.

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