Virtual Machines - Update - REST API (Azure Compute) By kexugit Archived: 2026-04-06 01:56:36 UTC In this article 1. URI Parameters 2. Request Header 3. Request Body 4. Responses 5. Security 6. Examples 7. Definitions The operation to update a virtual machine. PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft. Name In Required Type Description resourceGroup Name path True string minLength: 1 maxLength: 90 The name of the resource group. The name is case insensitive. subscriptionId path True string minLength: 1 The ID of the target subscription. vmName path True string The name of the virtual machine. api-version query True string minLength: 1 The API version to use for this operation. Name Required Type Description If-Match string 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. If-None-Match string 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. Name Type Description identity Virtual Machine Identity The identity of the virtual machine, if configured. plan Plan 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 https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 1 of 64 Started ->. Enter any required information and then click Save. properties.additionalCapabilities Additional Capabilities Specifies additional capabilities enabled or disabled on the virtual machine. properties.applicationProfile Application Profile Specifies the gallery applications that should be made available to the VM/VMSS. properties.availabilitySet Sub Resource Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. properties.billingProfile Billing Profile Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. properties.capacityReservation Capacity Reservation Profile Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021- 04-01. properties.diagnosticsProfile Diagnostics Profile Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. properties.evictionPolicy Virtual Machine Eviction PolicyTypes Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. properties.extensionsTimeBudget string 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. properties.hardwareProfile Hardware Profile Specifies the hardware settings for the virtual machine. properties.host Sub Resource Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 2 of 64 properties.hostGroup Sub Resource Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. properties.licenseType string 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 properties.networkProfile Network Profile Specifies the network interfaces of the virtual machine. properties.osProfile OSProfile Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. properties.platformFaultDomain integer (int32) 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. properties.priority Virtual Machine Priority Types Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 properties.proximityPlacementGroup Sub Resource Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. properties.scheduledEventsPolicy Scheduled Events Policy Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 3 of 64 properties.scheduledEventsProfile Scheduled Events Profile Specifies Scheduled Event related configurations. properties.securityProfile Security Profile Specifies the Security related profile settings for the virtual machine. properties.storageProfile Storage Profile Specifies the storage settings for the virtual machine disks. properties.userData string UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. properties.virtualMachineScaleSet Sub Resource Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. tags object Resource tags zones string[] The virtual machine zones. Name Type Description 200 OK VirtualMachine The request has succeeded. Headers Location: string Retry-After: integer Other Status Codes CloudError An unexpected error response. Azure Active Directory OAuth2 Flow. Type: oauth2 Flow: implicit Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize Name Description user_impersonation impersonate your user account Sample request HTTP PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Com { "properties": { "hardwareProfile": { https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 4 of 64 "vmSize": "Standard_D2_v2" }, "storageProfile": { "imageReference": { "sku": "2016-Datacenter", "publisher": "MicrosoftWindowsServer", "version": "latest", "offer": "WindowsServer" }, "osDisk": { "caching": "ReadWrite", "managedDisk": { "storageAccountType": "Standard_LRS" }, "name": "myVMosdisk", "createOption": "FromImage" }, "dataDisks": [ { "diskSizeGB": 1023, "createOption": "Empty", "lun": 0, "toBeDetached": true }, { "diskSizeGB": 1023, "createOption": "Empty", "lun": 1, "toBeDetached": false } ] }, "osProfile": { "adminUsername": "{your-username}", "computerName": "myVM", "adminPassword": "{your-password}" }, "networkProfile": { "networkInterfaces": [ { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf "properties": { "primary": true } } ] } } } Sample response { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" "type": "Microsoft.Compute/virtualMachines", "properties": { "osProfile": { "adminUsername": "{your-username}", "secrets": [], "computerName": "myVM", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true } }, "networkProfile": { "networkInterfaces": [ { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 5 of 64 "properties": { "primary": true } } ] }, "storageProfile": { "imageReference": { "sku": "2016-Datacenter", "publisher": "MicrosoftWindowsServer", "version": "latest", "offer": "WindowsServer" }, "osDisk": { "osType": "Windows", "caching": "ReadWrite", "createOption": "FromImage", "name": "myVMosdisk", "managedDisk": { "storageAccountType": "Standard_LRS" } }, "dataDisks": [ { "caching": "None", "managedDisk": { "storageAccountType": "Standard_LRS" }, "createOption": "Empty", "lun": 0, "diskSizeGB": 1023, "toBeDetached": true }, { "caching": "None", "managedDisk": { "storageAccountType": "Standard_LRS" }, "createOption": "Empty", "lun": 1, "diskSizeGB": 1023, "toBeDetached": false } ] }, "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", "hardwareProfile": { "vmSize": "Standard_D2_v2" }, "provisioningState": "Updating" }, "name": "myVM", "location": "westus" } Sample request HTTP PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Com { "properties": { "hardwareProfile": { "vmSize": "Standard_D2_v2" }, "storageProfile": { "imageReference": { "sku": "2016-Datacenter", "publisher": "MicrosoftWindowsServer", https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 6 of 64 "version": "latest", "offer": "WindowsServer" }, "osDisk": { "caching": "ReadWrite", "managedDisk": { "storageAccountType": "Standard_LRS" }, "name": "myVMosdisk", "createOption": "FromImage" }, "dataDisks": [ { "diskSizeGB": 1023, "createOption": "Empty", "lun": 0, "toBeDetached": true, "detachOption": "ForceDetach" }, { "diskSizeGB": 1023, "createOption": "Empty", "lun": 1, "toBeDetached": false } ] }, "osProfile": { "adminUsername": "{your-username}", "computerName": "myVM", "adminPassword": "{your-password}" }, "networkProfile": { "networkInterfaces": [ { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf "properties": { "primary": true } } ] } } } Sample response { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" "type": "Microsoft.Compute/virtualMachines", "properties": { "osProfile": { "adminUsername": "{your-username}", "secrets": [], "computerName": "myVM", "windowsConfiguration": { "provisionVMAgent": true, "enableAutomaticUpdates": true } }, "networkProfile": { "networkInterfaces": [ { "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf "properties": { "primary": true } } ] https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 7 of 64 }, "storageProfile": { "imageReference": { "sku": "2016-Datacenter", "publisher": "MicrosoftWindowsServer", "version": "latest", "offer": "WindowsServer" }, "osDisk": { "osType": "Windows", "caching": "ReadWrite", "createOption": "FromImage", "name": "myVMosdisk", "managedDisk": { "storageAccountType": "Standard_LRS" } }, "dataDisks": [ { "caching": "None", "managedDisk": { "storageAccountType": "Standard_LRS" }, "createOption": "Empty", "lun": 0, "diskSizeGB": 1023, "toBeDetached": true, "detachOption": "ForceDetach" }, { "caching": "None", "managedDisk": { "storageAccountType": "Standard_LRS" }, "createOption": "Empty", "lun": 1, "diskSizeGB": 1023, "toBeDetached": false } ] }, "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", "hardwareProfile": { "vmSize": "Standard_D2_v2" }, "provisioningState": "Updating" }, "name": "myVM", "location": "westus" } Name Description Additional Capabilities Enables or disables a capability on the virtual machine or virtual machine scale set. AdditionalUnattend Content Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. AllInstancesDown Specifies if Scheduled Events should be auto-approved when all instances are down. ApiEntity Reference The API entity reference. ApiError Api error. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 8 of 64 ApiErrorBase Api error base. ApplicationProfile Contains the list of gallery applications that should be made available to the VM/VMSS AvailablePatch Summary Describes the properties of an virtual machine instance view for available patch summary. BillingProfile Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019- 03-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. BootDiagnostics InstanceView The instance view of a virtual machine boot diagnostics. CachingTypes Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage Capacity ReservationProfile The parameters of a capacity reservation Profile. CloudError An error response from the Compute service. Common.User AssignedIdentities Value ComponentNames createdByType The type of identity that created the resource. DataDisk Describes a data disk. DeleteOptions Specify what happens to the network interface when the VM is deleted DiagnosticsProfile Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. DiffDiskOptions Specifies the ephemeral disk option for operating system disk. DiffDiskPlacement Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01. DiffDiskSettings 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. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 9 of 64 DiskController Types 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. DiskCreateOption Types Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. DiskDeleteOption Types 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. DiskDetachOption Types Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. DiskEncryptionSet Parameters 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. DiskEncryption Settings Describes a Encryption Settings for a Disk DiskInstanceView The instance view of the disk. DomainNameLabel ScopeTypes The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created EncryptionIdentity Specifies the Managed Identity used by ADE to get access token for keyvault operations. EventGridAnd ResourceGraph Specifies eventGridAndResourceGraph related Scheduled Event related configurations. ExtendedLocation The complex type of the extended location. ExtendedLocation Types The type of the extended location. HardwareProfile Specifies the hardware settings for the virtual machine. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 10 of 64 HostEndpoint Settings Specifies particular host endpoint settings. HyperVGeneration Type Specifies the HyperVGeneration Type associated with a resource 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. NOTE: Image reference publisher and offer can only be set when you create the scale set. InnerError Inner error details. InstanceViewStatus Instance view status. IPVersions 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'. KeyVaultKey Reference Describes a reference to Key Vault Key KeyVaultSecret Reference Describes a reference to Key Vault Secret LastPatch Installation Summary Describes the properties of the last installed patch summary. Linux Configuration Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. LinuxPatch 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. LinuxPatchSettings Specifies settings related to VM Guest Patching on Linux. LinuxVMGuest PatchAutomatic ByPlatformReboot Setting Specifies the reboot setting for all AutomaticByPlatform patch installation operations. LinuxVMGuest PatchAutomatic ByPlatformSettings Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 11 of 64 LinuxVMGuest 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 Maintenance OperationResult CodeTypes The Last Maintenance Operation Result Code. Maintenance RedeployStatus Maintenance Operation Status. ManagedDisk Parameters The parameters of a managed disk. Mode 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. Modes Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. NetworkApi Version specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations NetworkInterface AuxiliaryMode Specifies whether the Auxiliary mode is enabled for the Network Interface resource. NetworkInterface AuxiliarySku Specifies whether the Auxiliary sku is enabled for the Network Interface resource. NetworkInterface Reference Describes a network interface reference. NetworkProfile Specifies the network interfaces or the networking configuration of the virtual machine. OperatingSystem Types 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. 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. OSImage NotificationProfile OSProfile Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. PassNames PatchOperation 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 https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 12 of 64 "CompletedWithWarnings." PatchSettings Specifies settings related to VM Guest Patching on Windows. Placement Describes the user-defined constraints for resource hardware placement. Plan 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. ProtocolTypes Specifies the protocol of WinRM listener. Possible values are: http, https. ProxyAgent Settings Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. PublicIPAddress Sku Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. PublicIPAddress SkuName Specify public IP sku name PublicIPAddress SkuTier Specify public IP sku tier PublicIPAllocation Method Specify the public IP allocation type ResourceIdentity 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. ScheduledEvents Additional PublishingTargets ScheduledEvents Policy Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. ScheduledEvents Profile SecurityEncryption Types 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. SecurityProfile Specifies the Security profile settings for the virtual machine or virtual machine scale set. SecurityTypes 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. SettingNames Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 13 of 64 SshConfiguration SSH configuration for Linux based VMs running on Azure SshPublicKey Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. StatusLevelTypes The level code. StorageAccount Types 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 StorageProfile Specifies the storage settings for the virtual machine disks. SubResource systemData Metadata pertaining to creation and last modification of the resource. Terminate NotificationProfile UefiSettings Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. UserInitiated Reboot Specifies Reboot related Scheduled Event related configurations. UserInitiated Redeploy Specifies Redeploy related Scheduled Event related configurations. VaultCertificate Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. VaultSecretGroup Describes a set of certificates which are all in the same Key Vault. VirtualHardDisk Describes the uri of a disk. VirtualMachine Describes a Virtual Machine. VirtualMachine AgentInstanceView The instance view of the VM Agent running on the virtual machine. VirtualMachine EvictionPolicy Types Specifies the eviction policy for the Azure Spot VM/VMSS VirtualMachine Extension Describes a Virtual Machine Extension. VirtualMachine ExtensionHandler The instance view of a virtual machine extension handler. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 14 of 64 InstanceView VirtualMachine ExtensionInstance View The instance view of a virtual machine extension. VirtualMachine HealthStatus The health status of the VM. VirtualMachine Identity Identity for the virtual machine. VirtualMachine InstanceView The instance view of a virtual machine. VirtualMachine IpTag Contains the IP tag associated with the public IP address. VirtualMachine NetworkInterface Configuration Describes a virtual machine network interface configurations. VirtualMachine NetworkInterface DnsSettings Configuration Describes a virtual machines network configuration's DNS settings. VirtualMachine NetworkInterface IPConfiguration Describes a virtual machine network profile's IP configuration. VirtualMachine PatchStatus The status of virtual machine patch operations. VirtualMachine PriorityTypes 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. VirtualMachine PublicIPAddress Configuration Describes a virtual machines IP Configuration's PublicIPAddress configuration VirtualMachine PublicIPAddress DnsSettings Configuration Describes a virtual machines network configuration's DNS settings. VirtualMachineSize Types 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. VirtualMachine Update Describes a Virtual Machine Update. VMDiskSecurity Profile Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. VMGallery Application Specifies the required information to reference a compute gallery application version VMSizeProperties Specifies VM Size Property settings on the virtual machine. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 15 of 64 Windows Configuration Specifies Windows operating system settings on the virtual machine. WindowsPatch 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. WindowsVMGuest PatchAutomatic ByPlatformReboot Setting Specifies the reboot setting for all AutomaticByPlatform patch installation operations. WindowsVMGuest PatchAutomatic ByPlatformSettings Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. WindowsVMGuest 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 Win RMConfiguration Describes Windows Remote Management configuration of the VM WinRMListener Describes Protocol and thumbprint of Windows Remote Management listener ZonePlacement PolicyType Specifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. Object Enables or disables a capability on the virtual machine or virtual machine scale set. Name Type Description enableFips1403Encryption boolean The flag enables the usage of FIPS 140-3 compliant cryptography on the protectedSettings of an extension. Learn more at: https://aka.ms/linuxagentfipssupport. hibernationEnabled boolean The flag that enables or disables hibernation capability on the VM. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 16 of 64 ultraSSDEnabled boolean 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. Object Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. Name Type Description componentName Component Names The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. content string 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 PassNames The pass name. Currently, the only allowable value is OobeSystem. settingName Setting Names Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Object Specifies if Scheduled Events should be auto-approved when all instances are down. Name Type Description automaticallyApprove boolean Specifies if Scheduled Events should be auto-approved when all instances are down. its default value is true Object The API entity reference. Name Type Description id string The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... Object Api error. Name Type Description code string The error code. details ApiErrorBase[] The Api error details innererror InnerError The Api inner error message string The error message. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 17 of 64 target string The target of the particular error. Object Api error base. Name Type Description code string The error code. message string The error message. target string The target of the particular error. Object Contains the list of gallery applications that should be made available to the VM/VMSS Name Type Description galleryApplications VMGallery Application[] Specifies the gallery applications that should be made available to the VM/VMSS Object Describes the properties of an virtual machine instance view for available patch summary. Name Type Description assessmentActivityId string The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. criticalAndSecurityPatchCount integer (int32) The number of critical or security patches that have been detected as available and not yet installed. error ApiError The errors that were encountered during execution of the operation. The details array contains the list of them. lastModifiedTime string (date-time) The UTC timestamp when the operation began. otherPatchCount integer (int32) The number of all available patches excluding critical and security. rebootPending boolean 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 string (date-time) The UTC timestamp when the operation began. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 18 of 64 status Patch Operation 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." Object Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01. Name Type Description maxPrice number (double) 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. Object 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. Name Type Description enabled boolean Whether boot diagnostics should be enabled on the Virtual Machine. storageUri string 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. Object The instance view of a virtual machine boot diagnostics. Name Type Description consoleScreenshotBlobUri string The console screenshot blob URI. Note: This will not be set if boot diagnostics is currently enabled with managed storage. serialConsoleLogBlobUri string The serial console log blob Uri. Note: This will not be set if boot diagnostics is currently enabled with managed storage. status InstanceView Status The boot diagnostics status information for the VM. Note: It will be set only if there are errors encountered in enabling boot diagnostics. Enumeration https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 19 of 64 Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage Value Description None ReadOnly ReadWrite Object The parameters of a capacity reservation Profile. Name Type Description capacityReservationGroup Sub Resource 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. Object An error response from the Compute service. Name Type Description error ApiError Api error. Object Name Type Description clientId string The client id of user assigned identity. principalId string The principal id of user assigned identity. Enumeration Value Description Microsoft-Windows-Shell-Setup Enumeration The type of identity that created the resource. Value Description User Application ManagedIdentity Key Object Describes a data disk. Name Type Description https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 20 of 64 caching Caching Types Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. createOption DiskCreate Option Types Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. deleteOption DiskDelete Option Types Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: 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 DiskDetach Option Types 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. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. diskIOPSReadWrite integer (int64) Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. diskMBpsReadWrite integer (int64) Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. diskSizeGB integer (int32) 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. image Virtual HardDisk 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 integer (int32) 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 Managed Disk Parameters The managed disk parameters. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 21 of 64 name string The disk name. sourceResource ApiEntity Reference The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. toBeDetached boolean Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset vhd Virtual HardDisk The virtual hard disk. writeAcceleratorEnabled boolean Specifies whether writeAccelerator should be enabled or disabled on the disk. Enumeration Specify what happens to the network interface when the VM is deleted Value Description Delete Detach Object Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. Name Type Description bootDiagnostics Boot Diagnostics 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. Enumeration Specifies the ephemeral disk option for operating system disk. Value Description Local Enumeration Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for NvmeDisk: 2024-03-01. Value Description CacheDisk ResourceDisk NvmeDisk Object https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 22 of 64 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. Name Type Description option DiffDisk Options Specifies the ephemeral disk settings for operating system disk. placement DiffDisk Placement Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the 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. Minimum api-version for NvmeDisk: 2024-03-01. Enumeration 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. Value Description SCSI NVMe Enumeration Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. Value Description FromImage Empty Attach Copy Restore Enumeration 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. Value Description Delete Detach Enumeration 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. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 23 of 64 If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. Value Description ForceDetach Object 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. Name Type Description id string Resource Id Object Describes a Encryption Settings for a Disk Name Type Description diskEncryptionKey KeyVaultSecret Reference Specifies the location of the disk encryption key, which is a Key Vault Secret. enabled boolean Specifies whether disk encryption should be enabled on the virtual machine. keyEncryptionKey KeyVaultKeyReference Specifies the location of the key encryption key in Key Vault. Object The instance view of the disk. Name Type Description encryptionSettings DiskEncryptionSettings[] Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15 name string The disk name. statuses InstanceViewStatus[] The resource status information. Enumeration The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created Value Description TenantReuse SubscriptionReuse ResourceGroupReuse NoReuse https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 24 of 64 Object Specifies the Managed Identity used by ADE to get access token for keyvault operations. Name Type Description userAssignedIdentityResourceId string Specifies ARM Resource ID of one of the user identities associated with the VM. Object Specifies eventGridAndResourceGraph related Scheduled Event related configurations. Name Type Description enable boolean Specifies if event grid and resource graph is enabled for Scheduled event related configurations. scheduledEventsApiVersion string Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. Object The complex type of the extended location. Name Type Description name string The name of the extended location. type ExtendedLocationTypes The type of the extended location. Enumeration The type of the extended location. Value Description EdgeZone Object Specifies the hardware settings for the virtual machine. Name Type Description vmSize Virtual Machine SizeTypes 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. vmSizeProperties VMSize Properties 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. Object Specifies particular host endpoint settings. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 25 of 64 Name Type Description inVMAccessControlProfileReferenceId string Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Com mode Modes Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access contro any requests to host endpoints. In Enforce mode, the system will enforce the access control and it Enumeration Specifies the HyperVGeneration Type associated with a resource Value Description V1 V2 Object 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. Name Type Description communityGalleryImageId string Specified the community gallery image unique id for vm deployment. This can be fetched from community gall exactVersion string Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual ma 'version', only if the value specified in 'version' field is 'latest'. id string Resource Id offer string Specifies the offer of the platform image or marketplace image used to create the virtual machine. publisher string The image publisher. sharedGalleryImageId string Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image sku string The image SKU. version string Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowe 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image availa 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of ga '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries in the 'id' field without version input. Object Inner error details. Name Type Description errordetail string The internal error message or exception dump. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 26 of 64 exceptiontype string The exception type. Object Instance view status. Name Type Description code string The status code. displayStatus string The short localizable label for the status. level StatusLevelTypes The level code. message string The detailed status message, including for alerts and error messages. time string (date-time) The time of the status. Enumeration 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'. Value Description IPv4 IPv6 Object Describes a reference to Key Vault Key Name Type Description keyUrl string The URL referencing a key encryption key in Key Vault. sourceVault SubResource The relative URL of the Key Vault containing the key. Object Describes a reference to Key Vault Secret Name Type Description secretUrl string The URL referencing a secret in a Key Vault. sourceVault SubResource The relative URL of the Key Vault containing the secret. Object Describes the properties of the last installed patch summary. Name Type Description error ApiError The errors that were encountered during execution of the operation. The details array contains the list of them. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 27 of 64 excludedPatchCount integer (int32) The number of all available patches but excluded explicitly by a customer-specified exclusion list match. failedPatchCount integer (int32) The count of patches that failed installation. installationActivityId string The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. installedPatchCount integer (int32) The count of patches that successfully installed. lastModifiedTime string (date-time) The UTC timestamp when the operation began. maintenanceWindowExceeded boolean Describes whether the operation ran out of time before it completed all its intended actions notSelectedPatchCount integer (int32) The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. pendingPatchCount integer (int32) The number of all available patches expected to be installed over the course of the patch installation operation. startTime string (date-time) The UTC timestamp when the operation began. status Patch Operation 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." Object Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. Name Type Description disablePasswordAuthentication boolean Specifies whether password authentication should be disabled. enableVMAgentPlatformUpdates boolean Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. patchSettings LinuxPatch Settings [Preview Feature] Specifies settings related to VM Guest Patching on Linux. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 28 of 64 provisionVMAgent boolean 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 Ssh Configuration Specifies the ssh key configuration for a Linux OS. Enumeration 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. Value Description ImageDefault AutomaticByPlatform Object Specifies settings related to VM Guest Patching on Linux. Name Type Description assessmentMode LinuxPatch 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 LinuxVMGuestPatch AutomaticByPlatform Settings Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. patchMode LinuxVMGuestPatch Mode 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 Enumeration Specifies the reboot setting for all AutomaticByPlatform patch installation operations. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 29 of 64 Value Description Unknown IfRequired Never Always Object Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. Name Type Description bypassPlatformSafetyChecksOnUserSchedule boolean Enables customer to schedule patching without accidental upgrades rebootSetting LinuxVMGuestPatch AutomaticByPlatform RebootSetting Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Enumeration 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 Value Description ImageDefault AutomaticByPlatform Enumeration The Last Maintenance Operation Result Code. Value Description None RetryLater MaintenanceAborted MaintenanceCompleted Object Maintenance Operation Status. Name Type Description isCustomerInitiatedMaintenanceAllowed boolean True, if customer is allowed to perform Maintenance. lastOperationMessage string Message returned for the last Maintenance Operation. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 30 of 64 lastOperationResultCode MaintenanceOperationResult CodeTypes The Last Maintenance Operation Result Code. maintenanceWindowEndTime string (date-time) End Time for the Maintenance Window. maintenanceWindowStartTime string (date-time) Start Time for the Maintenance Window. preMaintenanceWindowEndTime string (date-time) End Time for the Pre Maintenance Window. preMaintenanceWindowStartTime string (date-time) Start Time for the Pre Maintenance Window. Object The parameters of a managed disk. Name Type Description diskEncryptionSet DiskEncryptionSet Parameters Specifies the customer managed disk encryption set resource id for the managed disk. id string Resource Id securityProfile VMDiskSecurity Profile Specifies the security profile for the managed disk. storageAccountType StorageAccount Types 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. Enumeration 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. Value Description Audit Enforce Enumeration Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. Value Description Audit Enforce Disabled Enumeration https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 31 of 64 specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations Value Description 2020-11-01 2022-11-01 Enumeration Specifies whether the Auxiliary mode is enabled for the Network Interface resource. Value Description None AcceleratedConnections Floating Enumeration Specifies whether the Auxiliary sku is enabled for the Network Interface resource. Value Description None A1 A2 A4 A8 Object Describes a network interface reference. Name Type Description id string Resource Id properties.deleteOption Delete Options Specify what happens to the network interface when the VM is deleted properties.primary boolean Specifies the primary network interface in case the virtual machine has more than 1 network interface. Object Specifies the network interfaces or the networking configuration of the virtual machine. Name Type Description networkApiVersion NetworkApiVersion specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations networkInterfaceConfigurations VirtualMachineNetwork InterfaceConfiguration[] Specifies the networking configurations that will be used to create the virtual machine networking resources. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 32 of 64 networkInterfaces NetworkInterface Reference[] Specifies the list of resource Ids for the network interfaces associated with the virtual machine. Enumeration 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. Value Description Windows Linux Object 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. Name Type Description caching Caching Types Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. createOption DiskCreate OptionTypes Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. deleteOption DiskDelete OptionTypes Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: 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. The user cannot change the delete option for an ephemeral OS Disk. diffDiskSettings DiffDisk Settings Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. diskSizeGB integer (int32) 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. encryptionSettings Disk Encryption Settings Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. image VirtualHard Disk 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 Managed Disk The managed disk parameters. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 33 of 64 Parameters name string The disk name. osType Operating System Types 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 VirtualHard Disk The virtual hard disk. writeAcceleratorEnabled boolean Specifies whether writeAccelerator should be enabled or disabled on the disk. Object Name Type Description enable boolean Specifies whether the OS Image Scheduled event is enabled or disabled. notBeforeTimeout string 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) Object Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. Name Type Description adminPassword string (password) 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 string Specifies the name of the administrator account. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 34 of 64 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 boolean 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 string 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 string 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. linuxConfiguration Linux Configuration Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. requireGuestProvisionSignal boolean Optional property which must either be set to True or omitted. secrets VaultSecret Group[] 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 Windows Configuration Specifies Windows operating system settings on the virtual machine. Enumeration Value Description OobeSystem Enumeration https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 35 of 64 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." Value Description Unknown InProgress Failed Succeeded CompletedWithWarnings Object Specifies settings related to VM Guest Patching on Windows. Name Type Description assessmentMode WindowsPatch Assessment Mode 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 Windows VMGuestPatch Automatic ByPlatform Settings Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. enableHotpatching boolean 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 Windows VMGuestPatch Mode 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 Object Describes the user-defined constraints for resource hardware placement. Name Type Description https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 36 of 64 excludeZones string[] This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. includeZones string[] This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. zonePlacementPolicy Zone Placement PolicyType Specifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. Object 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. Name Type Description name string The plan ID. product string Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. promotionCode string The promotion code. publisher string The publisher ID. Enumeration Specifies the protocol of WinRM listener. Possible values are: http, https. Value Description Http Https Object Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. Name Type Description addProxyAgentExtension boolean Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. enabled boolean Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 37 of 64 imds HostEndpoint Settings Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. keyIncarnationId integer (int32) Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. mode Mode Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. wireServer HostEndpoint Settings Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. Object Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. Name Type Description name PublicIPAddressSkuName Specify public IP sku name tier PublicIPAddressSkuTier Specify public IP sku tier Enumeration Specify public IP sku name Value Description Basic Standard Enumeration Specify public IP sku tier Value Description Regional Global Enumeration Specify the public IP allocation type Value Description Dynamic Static Enumeration 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. Value Description SystemAssigned UserAssigned https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 38 of 64 SystemAssigned, UserAssigned None Object Name Type Description eventGridAndResourceGraph EventGridAnd ResourceGraph The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. Object Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. Name Type Description allInstancesDown AllInstances Down The configuration parameters used while creating AllInstancesDown scheduled event setting creation. scheduledEventsAdditionalPublishingTargets Scheduled Events Additional Publishing Targets The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. userInitiatedReboot UserInitiated Reboot The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. userInitiatedRedeploy UserInitiated Redeploy The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. Object Name Type Description osImageNotificationProfile OSImageNotification Profile Specifies OS Image Scheduled Event related configurations. terminateNotificationProfile TerminateNotification Profile Specifies Terminate Scheduled Event related configurations. Enumeration 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. Value Description VMGuestStateOnly DiskWithVMGuestState NonPersistedTPM Object Specifies the Security profile settings for the virtual machine or virtual machine scale set. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 39 of 64 Name Type Description encryptionAtHost boolean 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. encryptionIdentity Encryption Identity Specifies the Managed Identity used by ADE to get access token for keyvault operations. proxyAgentSettings ProxyAgent Settings Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. securityType Security Types 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. uefiSettings UefiSettings Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. Enumeration 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. Value Description TrustedLaunch ConfidentialVM Enumeration Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. Value Description AutoLogon FirstLogonCommands Object SSH configuration for Linux based VMs running on Azure Name Type Description publicKeys SshPublicKey[] The list of SSH public keys used to authenticate with linux based VMs. Object Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. Name Type Description keyData string 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). https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 40 of 64 path string 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 Enumeration The level code. Value Description Info Warning Error Enumeration 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 Value Description Standard_LRS Premium_LRS StandardSSD_LRS UltraSSD_LRS Premium_ZRS StandardSSD_ZRS PremiumV2_LRS Object Specifies the storage settings for the virtual machine disks. Name Type Description alignRegionalDisksToVMZone boolean Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. dataDisks DataDisk[] 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. diskControllerType Disk Controller Types Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08- 01. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 41 of 64 imageReference Image Reference 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 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. Object Name Type Description id string Resource Id Object Metadata pertaining to creation and last modification of the resource. Name Type Description createdAt string (date-time) The timestamp of resource creation (UTC). createdBy string The identity that created the resource. createdByType createdByType The type of identity that created the resource. lastModifiedAt string (date-time) The timestamp of resource last modification (UTC) lastModifiedBy string The identity that last modified the resource. lastModifiedByType createdByType The type of identity that last modified the resource. Object Name Type Description enable boolean Specifies whether the Terminate Scheduled event is enabled or disabled. notBeforeTimeout string 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) Object Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. Name Type Description secureBootEnabled boolean Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 42 of 64 vTpmEnabled boolean Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. Object Specifies Reboot related Scheduled Event related configurations. Name Type Description automaticallyApprove boolean Specifies Reboot Scheduled Event related configurations. Object Specifies Redeploy related Scheduled Event related configurations. Name Type Description automaticallyApprove boolean Specifies Redeploy Scheduled Event related configurations. Object Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. Name Type Description certificateStore string 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 .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. certificateUrl string 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. Object Describes a set of certificates which are all in the same Key Vault. Name Type Description sourceVault SubResource The relative URL of the Key Vault containing all of the certificates in VaultCertificates. vaultCertificates Vault Certificate[] The list of key vault references in SourceVault which contain certificates. Object Describes the uri of a disk. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 43 of 64 Name Type Description uri string Specifies the virtual hard disk's uri. Object Describes a Virtual Machine. Name Type Description etag string Etag is property returned in Create/Update/Get response of the VM, so that customer can supply extendedLocation Extended Location The extended location of the Virtual Machine. id string Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourcePro identity Virtual Machine Identity The identity of the virtual machine, if configured. location string The geo-location where the resource lives managedBy string ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is par for internal resource group delete optimization. name string The name of the resource placement Placement Placement section specifies the user-defined constraints for virtual machine hardware placemen provisioned. Minimum api-version: 2024-11-01. plan Plan Specifies information about the marketplace image used to create the virtual machine. This elem you can use a marketplace image from an API, you must enable the image for programmatic us that you want to use and then click Want to deploy programmatically, Get Started ->. Enter properties.additionalCapabilities Additional Capabilities Specifies additional capabilities enabled or disabled on the virtual machine. properties.applicationProfile Application Profile Specifies the gallery applications that should be made available to the VM/VMSS. properties.availabilitySet Sub Resource Specifies information about the availability set that the virtual machine should be assigned to. V set are allocated to different nodes to maximize availability. For more information about availab information on Azure planned maintenance, see Maintenance and updates for Virtual Machines availability set at creation time. The availability set to which the VM is being added should be u resource. An existing VM cannot be added to an availability set. This property cannot exist alon properties.virtualMachineScaleSet reference. properties.billingProfile Billing Profile Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 201 https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 44 of 64 properties.capacityReservation Capacity Reservation Profile Specifies information about the capacity reservation that is used to allocate virtual machine. Mi properties.diagnosticsProfile Diagnostics Profile Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. properties.evictionPolicy Virtual Machine Eviction Policy Types Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For A 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, b minimum api-version is 2017-10-30-preview. properties.extensionsTimeBudget string Specifies the time alloted for all extensions to start. The time duration should be between 15 mi specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-versi properties.hardwareProfile Hardware Profile Specifies the hardware settings for the virtual machine. properties.host Sub Resource Specifies information about the dedicated host that the virtual machine resides in. Minimum api properties.hostGroup Sub Resource Specifies information about the dedicated host group that the virtual machine resides in. Note: U properties. Minimum api-version: 2020-06-01. properties.instanceView Virtual Machine Instance View The virtual machine instance view. properties.licenseType string 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 properties.networkProfile Network Profile Specifies the network interfaces of the virtual machine. properties.osProfile OSProfile Specifies the operating system settings used while creating the virtual machine. Some of the set https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 45 of 64 properties.platformFaultDomain integer (int32) Specifies the scale set logical fault domain into which the Virtual Machine will be created. By d assigned to a fault domain that best maintains balance across available fault domains. This is ap property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must h This property cannot be updated once the Virtual Machine is created. Fault domain assignment View. Minimum api‐version: 2020‐12‐01. properties.priority Virtual Machine Priority Types Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 properties.provisioningState string The provisioning state, which only appears in the response. properties.proximityPlacementGroup Sub Resource Specifies information about the proximity placement group that the virtual machine should be a properties.scheduledEventsPolicy Scheduled Events Policy Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Even properties.scheduledEventsProfile Scheduled Events Profile Specifies Scheduled Event related configurations. properties.securityProfile Security Profile Specifies the Security related profile settings for the virtual machine. properties.storageProfile Storage Profile Specifies the storage settings for the virtual machine disks. properties.timeCreated string (date-time) Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 20 properties.userData string UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in properties.virtualMachineScaleSet Sub Resource Specifies information about the virtual machine scale set that the virtual machine should be assi virtual machine scale set are allocated to different nodes to maximize availability. Currently, a V creation time. An existing VM cannot be added to a virtual machine scale set. This property can properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. properties.vmId string Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azur platform BIOS commands. resources Virtual Machine Extension[] The virtual machine child extension resources. systemData systemData Azure Resource Manager metadata containing createdBy and modifiedBy information. tags object Resource tags. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 46 of 64 type string The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/stor zones string[] The availability zones. Object The instance view of the VM Agent running on the virtual machine. Name Type Description extensionHandlers VirtualMachineExtensionHandlerInstance View[] The virtual machine extension handler instance view. statuses InstanceViewStatus[] The resource status information. vmAgentVersion string The VM Agent full version. Enumeration Specifies the eviction policy for the Azure Spot VM/VMSS Value Description Deallocate Delete Object Describes a Virtual Machine Extension. Name Type Description id string Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource location string The geo-location where the resource lives name string The name of the resource properties.autoUpgradeMinorVersion boolean Indicates whether the extension should use a newer minor version if one is available at depl will not upgrade minor versions unless redeployed, even with this property set to true. properties.enableAutomaticUpgrade boolean Indicates whether the extension should be automatically upgraded by the platform if there is properties.forceUpdateTag string How the extension handler should be forced to update even if the extension configuration ha properties.instanceView Virtual Machine Extension Instance View The virtual machine extension instance view. properties.protectedSettings The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 47 of 64 properties.protectedSettingsFromKeyVault KeyVault Secret Reference The extensions protected settings that are passed by reference, and consumed from key vaul properties.provisionAfterExtensions string[] Collection of extension names after which this extension needs to be provisioned. properties.provisioningState string The provisioning state, which only appears in the response. properties.publisher string The name of the extension handler publisher. properties.settings Json formatted public settings for the extension. properties.suppressFailures boolean Indicates whether failures stemming from the extension will be suppressed (Operational fail suppressed regardless of this value). The default is false. properties.type string Specifies the type of the extension; an example is "CustomScriptExtension". properties.typeHandlerVersion string Specifies the version of the script handler. systemData system Data Azure Resource Manager metadata containing createdBy and modifiedBy information. tags object Resource tags. type string The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/ Object The instance view of a virtual machine extension handler. Name Type Description status InstanceView Status The extension handler status. type string Specifies the type of the extension; an example is "CustomScriptExtension". typeHandlerVersion string Specifies the version of the script handler. Object The instance view of a virtual machine extension. Name Type Description name string The virtual machine extension name. statuses InstanceView Status[] The resource status information. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 48 of 64 substatuses InstanceView Status[] The resource status information. type string Specifies the type of the extension; an example is "CustomScriptExtension". typeHandlerVersion string Specifies the version of the script handler. Object The health status of the VM. Name Type Description status InstanceViewStatus The health status information for the VM. Object Identity for the virtual machine. Name Type Description principalId string The principal id of virtual machine identity. This property will only be provided for a system assigned identity. tenantId string The tenant id associated with the virtual machine. This property will only be provided for a system assigned iden type Resource Identity Type The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an im 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 b '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/u Object The instance view of a virtual machine. Name Type Description assignedHost string 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 BootDiagnostics InstanceView 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 string The computer name assigned to the virtual machine. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 49 of 64 disks DiskInstance View[] The virtual machine disk information. extensions VirtualMachine ExtensionInstance View[] The extensions information. hyperVGeneration Hyper VGenerationType Specifies the HyperVGeneration Type associated with a resource isVMInStandbyPool boolean [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. maintenanceRedeployStatus Maintenance RedeployStatus The Maintenance Operation status on the virtual machine. osName string The Operating System running on the virtual machine. osVersion string The version of Operating System running on the virtual machine. patchStatus VirtualMachine PatchStatus [Preview Feature] The status of virtual machine patch operations. platformFaultDomain integer (int32) Specifies the fault domain of the virtual machine. platformUpdateDomain integer (int32) Specifies the update domain of the virtual machine. rdpThumbPrint string The Remote desktop certificate thumbprint. statuses InstanceView Status[] The resource status information. vmAgent VirtualMachine AgentInstance View The VM Agent running on the virtual machine. vmHealth VirtualMachine HealthStatus The health status for the VM. Object Contains the IP tag associated with the public IP address. Name Type Description ipTagType string IP tag type. Example: FirstPartyUsage. tag string IP tag associated with the public IP. Example: SQL, Storage etc. Object https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 50 of 64 Describes a virtual machine network interface configurations. Name Type Description name string The network interface configuration name. properties.auxiliaryMode NetworkInterface AuxiliaryMode Specifies whether the Auxiliary mode is enabled for the Network Interface resource. properties.auxiliarySku NetworkInterface AuxiliarySku Specifies whether the Auxiliary sku is enabled for the Network Interface resource. properties.deleteOption DeleteOptions Specify what happens to the network interface when the VM is deleted properties.disableTcpStateTracking boolean Specifies whether the network interface is disabled for tcp state tracking. properties.dnsSettings VirtualMachineNetwork InterfaceDnsSettings Configuration The dns settings to be applied on the network interfaces. properties.dscpConfiguration SubResource properties.enableAcceleratedNetworking boolean Specifies whether the network interface is accelerated networking-enabled. properties.enableFpga boolean Specifies whether the network interface is FPGA networking-enabled. properties.enableIPForwarding boolean Whether IP forwarding enabled on this NIC. properties.ipConfigurations VirtualMachineNetwork Interface IPConfiguration[] Specifies the IP configurations of the network interface. properties.networkSecurityGroup SubResource The network security group. properties.primary boolean Specifies the primary network interface in case the virtual machine has more than 1 network interface. tags object Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration Object Describes a virtual machines network configuration's DNS settings. Name Type Description https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 51 of 64 dnsServers string[] List of DNS servers IP addresses Object Describes a virtual machine network profile's IP configuration. Name Type Description name string The IP configuration name. properties.applicationGatewayBackendAddressPools SubResource[] 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. properties.applicationSecurityGroups SubResource[] Specifies an array of references to application security group. properties.loadBalancerBackendAddressPools SubResource[] 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]. properties.primary boolean Specifies the primary network interface in case the virtual machine has more than 1 network interface. properties.privateIPAddressVersion IPVersions 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'. properties.publicIPAddressConfiguration VirtualMachine Public IPAddress Configuration The publicIPAddressConfiguration. properties.subnet SubResource Specifies the identifier of the subnet. Object The status of virtual machine patch operations. Name Type Description availablePatchSummary AvailablePatch Summary The available patch summary of the latest assessment operation for the virtual machine. configurationStatuses InstanceViewStatus[] The enablement status of the specified patchMode https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 52 of 64 lastPatchInstallationSummary LastPatchInstallation Summary The installation summary of the latest installation operation for the virtual machine. Enumeration 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. Value Description Regular Low Spot Object Describes a virtual machines IP Configuration's PublicIPAddress configuration Name Type Description name string The publicIP address configuration name. properties.deleteOption DeleteOptions Specify what happens to the public IP address when the VM is deleted properties.dnsSettings VirtualMachine PublicIPAddressDns Settings Configuration The dns settings to be applied on the publicIP addresses . properties.idleTimeoutInMinutes integer (int32) The idle timeout of the public IP address. properties.ipTags VirtualMachine IpTag[] The list of IP tags associated with the public IP address. properties.publicIPAddressVersion IPVersions 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'. properties.publicIPAllocationMethod PublicIPAllocation Method Specify the public IP allocation type properties.publicIPPrefix SubResource The PublicIPPrefix from which to allocate publicIP addresses. sku PublicIPAddressSku Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. tags object Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration Object https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 53 of 64 Describes a virtual machines network configuration's DNS settings. Name Type Description domainNameLabel string 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. domainNameLabelScope Domain NameLabel ScopeTypes 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. Enumeration 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. Value Description Basic_A0 Basic_A1 Basic_A2 Basic_A3 Basic_A4 Standard_A0 Standard_A1 Standard_A2 Standard_A3 Standard_A4 Standard_A5 Standard_A6 Standard_A7 Standard_A8 Standard_A9 Standard_A10 Standard_A11 Standard_A1_v2 Standard_A2_v2 Standard_A4_v2 Standard_A8_v2 Standard_A2m_v2 Standard_A4m_v2 Standard_A8m_v2 Standard_B1s https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 54 of 64 Standard_B1ms Standard_B2s Standard_B2ms Standard_B4ms Standard_B8ms Standard_D1 Standard_D2 Standard_D3 Standard_D4 Standard_D11 Standard_D12 Standard_D13 Standard_D14 Standard_D1_v2 Standard_D2_v2 Standard_D3_v2 Standard_D4_v2 Standard_D5_v2 Standard_D2_v3 Standard_D4_v3 Standard_D8_v3 Standard_D16_v3 Standard_D32_v3 Standard_D64_v3 Standard_D2s_v3 Standard_D4s_v3 Standard_D8s_v3 Standard_D16s_v3 Standard_D32s_v3 Standard_D64s_v3 Standard_D11_v2 Standard_D12_v2 Standard_D13_v2 Standard_D14_v2 Standard_D15_v2 Standard_DS1 Standard_DS2 Standard_DS3 Standard_DS4 Standard_DS11 https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 55 of 64 Standard_DS12 Standard_DS13 Standard_DS14 Standard_DS1_v2 Standard_DS2_v2 Standard_DS3_v2 Standard_DS4_v2 Standard_DS5_v2 Standard_DS11_v2 Standard_DS12_v2 Standard_DS13_v2 Standard_DS14_v2 Standard_DS15_v2 Standard_DS13-4_v2 Standard_DS13-2_v2 Standard_DS14-8_v2 Standard_DS14-4_v2 Standard_E2_v3 Standard_E4_v3 Standard_E8_v3 Standard_E16_v3 Standard_E32_v3 Standard_E64_v3 Standard_E2s_v3 Standard_E4s_v3 Standard_E8s_v3 Standard_E16s_v3 Standard_E32s_v3 Standard_E64s_v3 Standard_E32-16_v3 Standard_E32-8s_v3 Standard_E64-32s_v3 Standard_E64-16s_v3 Standard_F1 Standard_F2 Standard_F4 Standard_F8 Standard_F16 Standard_F1s Standard_F2s https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 56 of 64 Standard_F4s Standard_F8s Standard_F16s Standard_F2s_v2 Standard_F4s_v2 Standard_F8s_v2 Standard_F16s_v2 Standard_F32s_v2 Standard_F64s_v2 Standard_F72s_v2 Standard_G1 Standard_G2 Standard_G3 Standard_G4 Standard_G5 Standard_GS1 Standard_GS2 Standard_GS3 Standard_GS4 Standard_GS5 Standard_GS4-8 Standard_GS4-4 Standard_GS5-16 Standard_GS5-8 Standard_H8 Standard_H16 Standard_H8m Standard_H16m Standard_H16r Standard_H16mr Standard_L4s Standard_L8s Standard_L16s Standard_L32s Standard_M64s Standard_M64ms Standard_M128s Standard_M128ms Standard_M64-32ms Standard_M64-16ms https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 57 of 64 Standard_M128-64ms Standard_M128-32ms Standard_NC6 Standard_NC12 Standard_NC24 Standard_NC24r Standard_NC6s_v2 Standard_NC12s_v2 Standard_NC24s_v2 Standard_NC24rs_v2 Standard_NC6s_v3 Standard_NC12s_v3 Standard_NC24s_v3 Standard_NC24rs_v3 Standard_ND6s Standard_ND12s Standard_ND24s Standard_ND24rs Standard_NV6 Standard_NV12 Standard_NV24 Object Describes a Virtual Machine Update. Name Type Description identity Virtual Machine Identity The identity of the virtual machine, if configured. plan Plan 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. properties.additionalCapabilities Additional Capabilities Specifies additional capabilities enabled or disabled on the virtual machine. properties.applicationProfile Application Profile Specifies the gallery applications that should be made available to the VM/VMSS. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 58 of 64 properties.availabilitySet Sub Resource Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. properties.billingProfile Billing Profile Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. properties.capacityReservation Capacity Reservation Profile Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021- 04-01. properties.diagnosticsProfile Diagnostics Profile Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. properties.evictionPolicy Virtual Machine Eviction PolicyTypes Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. properties.extensionsTimeBudget string 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. properties.hardwareProfile Hardware Profile Specifies the hardware settings for the virtual machine. properties.host Sub Resource Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. properties.hostGroup Sub Resource Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. properties.instanceView Virtual Machine Instance View The virtual machine instance view. properties.licenseType string Specifies that the image or disk that is being used was licensed on-premises. Possible values for Windows Server operating system are: https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 59 of 64 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 properties.networkProfile Network Profile Specifies the network interfaces of the virtual machine. properties.osProfile OSProfile Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. properties.platformFaultDomain integer (int32) 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. properties.priority Virtual Machine Priority Types Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 properties.provisioningState string The provisioning state, which only appears in the response. properties.proximityPlacementGroup Sub Resource Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. properties.scheduledEventsPolicy Scheduled Events Policy Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. properties.scheduledEventsProfile Scheduled Events Profile Specifies Scheduled Event related configurations. properties.securityProfile Security Profile Specifies the Security related profile settings for the virtual machine. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 60 of 64 properties.storageProfile Storage Profile Specifies the storage settings for the virtual machine disks. properties.timeCreated string (date-time)Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. properties.userData string UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. properties.virtualMachineScaleSet Sub Resource Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. properties.vmId string 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. tags object Resource tags zones string[] The virtual machine zones. Object Specifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs. Name Type Description diskEncryptionSet Disk Encryption Set Parameters 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 Security Encryption Types 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. Object Specifies the required information to reference a compute gallery application version Name Type Description configurationReference string Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 61 of 64 enableAutomaticUpgrade boolean If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically u order integer (int32) Optional, Specifies the order in which the packages have to be installed packageReferenceId string Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute tags string Optional, Specifies a passthrough value for more generic context. treatFailureAsDeploymentFailure boolean Optional, If true, any failure for any operation in the VmApplication will fail the deployment Object Specifies VM Size Property settings on the virtual machine. Name Type Description vCPUsAvailable integer (int32) 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 integer (int32) 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. Object Specifies Windows operating system settings on the virtual machine. Name Type Description additionalUnattendContent Additional UnattendContent[] Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. enableAutomaticUpdates boolean 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. enableVMAgentPlatformUpdates boolean Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. patchSettings PatchSettings [Preview Feature] Specifies settings related to VM Guest Patching on Windows. provisionVMAgent boolean 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. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 62 of 64 timeZone string 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. winRM Win RMConfiguration Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. Enumeration 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. Value Description ImageDefault AutomaticByPlatform Enumeration Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Value Description Unknown IfRequired Never Always Object Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. Name Type Description bypassPlatformSafetyChecksOnUserSchedule boolean Enables customer to schedule patching without accidental upgrades rebootSetting WindowsVMGuestPatch AutomaticByPlatform RebootSetting Specifies the reboot setting for all AutomaticByPlatform patch installation operations. Enumeration 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. https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 63 of 64 AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true Value Description Manual AutomaticByOS AutomaticByPlatform Object Describes Windows Remote Management configuration of the VM Name Type Description listeners WinRMListener[] The list of Windows Remote Management listeners Object Describes Protocol and thumbprint of Windows Remote Management listener Name Type Description certificateUrl string 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. protocol Protocol Types Specifies the protocol of WinRM listener. Possible values are: http, https. Enumeration Specifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. Value Description Any Auto Automatic zone placement in a Virtual Machine Scale Set. Source: https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update https://docs.microsoft.com/en-us/rest/api/compute/virtual-machines/update Page 64 of 64