{
	"id": "117f002f-b69d-4582-9bdb-9a56f4688ae9",
	"created_at": "2026-04-06T00:19:14.201589Z",
	"updated_at": "2026-04-10T03:20:34.392672Z",
	"deleted_at": null,
	"sha1_hash": "0700fce473a7925e2e766d0bf2dc13af5edaaec1",
	"title": "Virtual Machines - Get - REST API (Azure Compute)",
	"llm_title": "",
	"authors": "",
	"file_creation_date": "0001-01-01T00:00:00Z",
	"file_modification_date": "0001-01-01T00:00:00Z",
	"file_size": 468677,
	"plain_text": "Virtual Machines - Get - REST API (Azure Compute)\r\nBy kexugit\r\nArchived: 2026-04-05 20:18:28 UTC\r\nIn this article\r\n1. URI Parameters\r\n2. Responses\r\n3. Security\r\n4. Examples\r\n5. Definitions\r\nRetrieves information about the model view or the instance view of a virtual machine.\r\nGET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Co\r\nWith optional parameters:\r\nGET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Co\r\nURI Parameters\r\nName In Required Type Description\r\nresource\r\nGroupName\r\npath True\r\nstring\r\nminLength:\r\n1\r\nmaxLength:\r\n90\r\nThe name of the resource group. The name is case insensitive.\r\nsubscription\r\nId\r\npath True\r\nstring\r\nminLength:\r\n1\r\nThe ID of the target subscription.\r\nvmName path True string The name of the virtual machine.\r\napi-version query True\r\nstring\r\nminLength:\r\n1\r\nThe API version to use for this operation.\r\n$expand query\r\nInstance\r\nViewTypes\r\nThe expand expression to apply on the operation.\r\n'InstanceView' retrieves a snapshot of the runtime properties of\r\nthe virtual machine that is managed by the platform and can\r\nchange outside of control plane operations. 'UserData' retrieves\r\nthe UserData property as part of the VM model view that was\r\nprovided by the user during the VM Create/Update operation.\r\nResponses\r\nName Type Description\r\n200 OK VirtualMachine Azure operation completed successfully.\r\nOther Status Codes CloudError An unexpected error response.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 1 of 65\n\nSecurity\r\nazure_auth\r\nAzure Active Directory OAuth2 Flow.\r\nType: oauth2\r\nFlow: implicit\r\nAuthorization URL: https://login.microsoftonline.com/common/oauth2/authorize\r\nScopes\r\nName Description\r\nuser_impersonation impersonate your user account\r\nExamples\r\nGet a virtual machine placed on a dedicated host group through automatic placement\r\nSample request\r\nHTTP\r\nGET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compu\r\nSample response\r\n{\r\n \"name\": \"myVM\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM\"\r\n \"type\": \"Microsoft.Compute/virtualMachines\",\r\n \"location\": \"West US\",\r\n \"tags\": {\r\n \"myTag1\": \"tagValue1\"\r\n },\r\n \"properties\": {\r\n \"vmId\": \"0f47b100-583c-48e3-a4c0-aefc2c9bbcc1\",\r\n \"hostGroup\": {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHost\r\n },\r\n \"hardwareProfile\": {\r\n \"vmSize\": \"Standard_D2s_v3\"\r\n },\r\n \"storageProfile\": {\r\n \"imageReference\": {\r\n \"publisher\": \"MicrosoftWindowsServer\",\r\n \"offer\": \"WindowsServer\",\r\n \"sku\": \"2016-Datacenter\",\r\n \"version\": \"latest\"\r\n },\r\n \"osDisk\": {\r\n \"osType\": \"Windows\",\r\n \"name\": \"myOsDisk\",\r\n \"createOption\": \"FromImage\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDis\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n \"dataDisks\": []\r\n },\r\n \"osProfile\": {\r\n \"computerName\": \"myVM\",\r\n \"adminUsername\": \"admin\",\r\n \"windowsConfiguration\": {\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 2 of 65\n\n\"provisionVMAgent\": true,\r\n \"enableAutomaticUpdates\": false\r\n },\r\n \"secrets\": []\r\n },\r\n \"networkProfile\": {\r\n \"networkInterfaces\": [\r\n {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf\r\n }\r\n ]\r\n },\r\n \"provisioningState\": \"Succeeded\"\r\n }\r\n}\r\nGet a virtual machine with Disk Controller Type Properties\r\nSample request\r\nHTTP\r\nGET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compu\r\nSample response\r\n{\r\n \"name\": \"myVM\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM\"\r\n \"type\": \"Microsoft.Compute/virtualMachines\",\r\n \"location\": \"West US\",\r\n \"tags\": {\r\n \"myTag1\": \"tagValue1\"\r\n },\r\n \"properties\": {\r\n \"vmId\": \"0f47b100-583c-48e3-a4c0-aefc2c9bbcc1\",\r\n \"availabilitySet\": {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/\r\n },\r\n \"hardwareProfile\": {\r\n \"vmSize\": \"Standard_DS3_v2\",\r\n \"vmSizeProperties\": {\r\n \"vCPUsAvailable\": 1,\r\n \"vCPUsPerCore\": 1\r\n }\r\n },\r\n \"storageProfile\": {\r\n \"imageReference\": {\r\n \"publisher\": \"MicrosoftWindowsServer\",\r\n \"offer\": \"WindowsServer\",\r\n \"sku\": \"2016-Datacenter\",\r\n \"version\": \"latest\"\r\n },\r\n \"osDisk\": {\r\n \"osType\": \"Windows\",\r\n \"name\": \"myOsDisk\",\r\n \"createOption\": \"FromImage\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDis\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n \"dataDisks\": [\r\n {\r\n \"lun\": 0,\r\n \"name\": \"myDataDisk0\",\r\n \"createOption\": \"Empty\",\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 3 of 65\n\n\"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n {\r\n \"lun\": 1,\r\n \"name\": \"myDataDisk1\",\r\n \"createOption\": \"Attach\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 100\r\n }\r\n ],\r\n \"diskControllerType\": \"NVMe\"\r\n },\r\n \"applicationProfile\": {\r\n \"galleryApplications\": [\r\n {\r\n \"tags\": \"myTag1\",\r\n \"order\": 1,\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/p\r\n \"configurationReference\": \"https://mystorageaccount.blob.core.windows.net/configurations/settings.config\"\r\n },\r\n {\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/p\r\n }\r\n ]\r\n },\r\n \"userData\": \"RXhhbXBsZSBVc2VyRGF0YQ==\",\r\n \"osProfile\": {\r\n \"computerName\": \"myVM\",\r\n \"adminUsername\": \"admin\",\r\n \"windowsConfiguration\": {\r\n \"provisionVMAgent\": true,\r\n \"enableAutomaticUpdates\": false\r\n },\r\n \"secrets\": []\r\n },\r\n \"networkProfile\": {\r\n \"networkInterfaces\": [\r\n {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf\r\n }\r\n ]\r\n },\r\n \"diagnosticsProfile\": {\r\n \"bootDiagnostics\": {\r\n \"enabled\": true,\r\n \"storageUri\": \"http://{myStorageAccount}.blob.core.windows.net\"\r\n }\r\n },\r\n \"extensionsTimeBudget\": \"PT50M\",\r\n \"provisioningState\": \"Succeeded\"\r\n },\r\n \"resources\": [\r\n {\r\n \"name\": \"CustomScriptExtension-DSC\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/m\r\n \"type\": \"Microsoft.Compute/virtualMachines/extensions\",\r\n \"location\": \"west us\",\r\n \"tags\": {\r\n \"displayName\": \"CustomScriptExtension-DSC\"\r\n },\r\n \"properties\": {\r\n \"autoUpgradeMinorVersion\": true,\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 4 of 65\n\n\"provisioningState\": \"Succeeded\",\r\n \"publisher\": \"Microsoft.Compute\",\r\n \"type\": \"CustomScriptExtension\",\r\n \"typeHandlerVersion\": \"1.9\",\r\n \"settings\": {}\r\n }\r\n }\r\n ]\r\n}\r\nGet a virtual machine with VM Size Properties\r\nSample request\r\nHTTP\r\nGET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compu\r\nSample response\r\n{\r\n \"name\": \"myVM\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM\"\r\n \"type\": \"Microsoft.Compute/virtualMachines\",\r\n \"location\": \"West US\",\r\n \"tags\": {\r\n \"myTag1\": \"tagValue1\"\r\n },\r\n \"properties\": {\r\n \"vmId\": \"0f47b100-583c-48e3-a4c0-aefc2c9bbcc1\",\r\n \"availabilitySet\": {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/\r\n },\r\n \"hardwareProfile\": {\r\n \"vmSize\": \"Standard_DS3_v2\",\r\n \"vmSizeProperties\": {\r\n \"vCPUsAvailable\": 1,\r\n \"vCPUsPerCore\": 1\r\n }\r\n },\r\n \"storageProfile\": {\r\n \"imageReference\": {\r\n \"publisher\": \"MicrosoftWindowsServer\",\r\n \"offer\": \"WindowsServer\",\r\n \"sku\": \"2016-Datacenter\",\r\n \"version\": \"latest\"\r\n },\r\n \"osDisk\": {\r\n \"osType\": \"Windows\",\r\n \"name\": \"myOsDisk\",\r\n \"createOption\": \"FromImage\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDis\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n \"dataDisks\": [\r\n {\r\n \"lun\": 0,\r\n \"name\": \"myDataDisk0\",\r\n \"createOption\": \"Empty\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 30\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 5 of 65\n\n},\r\n {\r\n \"lun\": 1,\r\n \"name\": \"myDataDisk1\",\r\n \"createOption\": \"Attach\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 100\r\n }\r\n ]\r\n },\r\n \"applicationProfile\": {\r\n \"galleryApplications\": [\r\n {\r\n \"tags\": \"myTag1\",\r\n \"order\": 1,\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/p\r\n \"configurationReference\": \"https://mystorageaccount.blob.core.windows.net/configurations/settings.config\"\r\n },\r\n {\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/p\r\n }\r\n ]\r\n },\r\n \"userData\": \"RXhhbXBsZSBVc2VyRGF0YQ==\",\r\n \"osProfile\": {\r\n \"computerName\": \"myVM\",\r\n \"adminUsername\": \"admin\",\r\n \"windowsConfiguration\": {\r\n \"provisionVMAgent\": true,\r\n \"enableAutomaticUpdates\": false\r\n },\r\n \"secrets\": []\r\n },\r\n \"networkProfile\": {\r\n \"networkInterfaces\": [\r\n {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf\r\n }\r\n ]\r\n },\r\n \"diagnosticsProfile\": {\r\n \"bootDiagnostics\": {\r\n \"enabled\": true,\r\n \"storageUri\": \"http://{myStorageAccount}.blob.core.windows.net\"\r\n }\r\n },\r\n \"extensionsTimeBudget\": \"PT50M\",\r\n \"provisioningState\": \"Succeeded\"\r\n },\r\n \"resources\": [\r\n {\r\n \"name\": \"CustomScriptExtension-DSC\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/m\r\n \"type\": \"Microsoft.Compute/virtualMachines/extensions\",\r\n \"location\": \"west us\",\r\n \"tags\": {\r\n \"displayName\": \"CustomScriptExtension-DSC\"\r\n },\r\n \"properties\": {\r\n \"autoUpgradeMinorVersion\": true,\r\n \"provisioningState\": \"Succeeded\",\r\n \"publisher\": \"Microsoft.Compute\",\r\n \"type\": \"CustomScriptExtension\",\r\n \"typeHandlerVersion\": \"1.9\",\r\n \"settings\": {}\r\n }\r\n }\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 6 of 65\n\n]\r\n}\r\nGet a Virtual Machine.\r\nSample request\r\nHTTP\r\nGET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compu\r\nSample response\r\n{\r\n \"name\": \"myVM\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM\"\r\n \"type\": \"Microsoft.Compute/virtualMachines\",\r\n \"location\": \"West US\",\r\n \"tags\": {\r\n \"myTag1\": \"tagValue1\"\r\n },\r\n \"etag\": \"\\\"1\\\"\",\r\n \"properties\": {\r\n \"vmId\": \"0f47b100-583c-48e3-a4c0-aefc2c9bbcc1\",\r\n \"availabilitySet\": {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/\r\n },\r\n \"proximityPlacementGroup\": {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacemen\r\n },\r\n \"hardwareProfile\": {\r\n \"vmSize\": \"Standard_DS3_v2\"\r\n },\r\n \"storageProfile\": {\r\n \"imageReference\": {\r\n \"publisher\": \"MicrosoftWindowsServer\",\r\n \"offer\": \"WindowsServer\",\r\n \"sku\": \"2016-Datacenter\",\r\n \"version\": \"latest\"\r\n },\r\n \"osDisk\": {\r\n \"osType\": \"Windows\",\r\n \"name\": \"myOsDisk\",\r\n \"createOption\": \"FromImage\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDis\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n \"dataDisks\": [\r\n {\r\n \"lun\": 0,\r\n \"name\": \"myDataDisk0\",\r\n \"createOption\": \"Empty\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\n \"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 30\r\n },\r\n {\r\n \"lun\": 1,\r\n \"name\": \"myDataDisk1\",\r\n \"createOption\": \"Attach\",\r\n \"caching\": \"ReadWrite\",\r\n \"managedDisk\": {\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 7 of 65\n\n\"storageAccountType\": \"Premium_LRS\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDat\r\n },\r\n \"diskSizeGB\": 100\r\n }\r\n ]\r\n },\r\n \"applicationProfile\": {\r\n \"galleryApplications\": [\r\n {\r\n \"tags\": \"myTag1\",\r\n \"order\": 1,\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdb/resourceGroups/myresourceGroupName2/p\r\n \"configurationReference\": \"https://mystorageaccount.blob.core.windows.net/configurations/settings.config\"\r\n },\r\n {\r\n \"packageReferenceId\": \"/subscriptions/32c17a9e-aa7b-4ba5-a45b-e324116b6fdg/resourceGroups/myresourceGroupName3/p\r\n }\r\n ]\r\n },\r\n \"userData\": \"RXhhbXBsZSBVc2VyRGF0YQ==\",\r\n \"osProfile\": {\r\n \"computerName\": \"myVM\",\r\n \"adminUsername\": \"admin\",\r\n \"windowsConfiguration\": {\r\n \"provisionVMAgent\": true,\r\n \"enableAutomaticUpdates\": false\r\n },\r\n \"secrets\": []\r\n },\r\n \"networkProfile\": {\r\n \"networkInterfaces\": [\r\n {\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterf\r\n }\r\n ]\r\n },\r\n \"diagnosticsProfile\": {\r\n \"bootDiagnostics\": {\r\n \"enabled\": true,\r\n \"storageUri\": \"http://{myStorageAccount}.blob.core.windows.net\"\r\n }\r\n },\r\n \"extensionsTimeBudget\": \"PT50M\",\r\n \"provisioningState\": \"Succeeded\",\r\n \"timeCreated\": \"2021-06-27T01:02:38.3138469+00:00\"\r\n },\r\n \"resources\": [\r\n {\r\n \"name\": \"CustomScriptExtension-DSC\",\r\n \"id\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/m\r\n \"type\": \"Microsoft.Compute/virtualMachines/extensions\",\r\n \"location\": \"west us\",\r\n \"tags\": {\r\n \"displayName\": \"CustomScriptExtension-DSC\"\r\n },\r\n \"properties\": {\r\n \"autoUpgradeMinorVersion\": true,\r\n \"provisioningState\": \"Succeeded\",\r\n \"publisher\": \"Microsoft.Compute\",\r\n \"type\": \"CustomScriptExtension\",\r\n \"typeHandlerVersion\": \"1.9\",\r\n \"settings\": {}\r\n }\r\n }\r\n ],\r\n \"managedBy\": \"/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachine\r\n}\r\nDefinitions\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 8 of 65\n\nName Description\r\nAdditional\r\nCapabilities\r\nEnables or disables a capability on the virtual machine or virtual machine scale set.\r\nAdditionalUnattend\r\nContent\r\nSpecifies additional XML formatted information that can be included in the Unattend.xml file,\r\nwhich is used by Windows Setup. Contents are defined by setting name, component name, and\r\nthe pass in which the content is applied.\r\nAllInstancesDown Specifies if Scheduled Events should be auto-approved when all instances are down.\r\nApiEntity\r\nReference\r\nThe API entity reference.\r\nApiError Api error.\r\nApiErrorBase Api error base.\r\nApplicationProfile Contains the list of gallery applications that should be made available to the VM/VMSS\r\nAvailablePatch\r\nSummary\r\nDescribes the properties of an virtual machine instance view for available patch summary.\r\nBillingProfile\r\nSpecifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-\r\n03-01.\r\nBootDiagnostics\r\nBoot Diagnostics is a debugging feature which allows you to view Console Output and\r\nScreenshot to diagnose VM status. You can easily view the output of your console log. Azure\r\nalso enables you to see a screenshot of the VM from the hypervisor.\r\nBootDiagnostics\r\nInstanceView\r\nThe instance view of a virtual machine boot diagnostics.\r\nCachingTypes\r\nSpecifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The\r\ndefault values are: None for Standard storage. ReadOnly for Premium storage\r\nCapacity\r\nReservationProfile\r\nThe parameters of a capacity reservation Profile.\r\nCloudError An error response from the Compute service.\r\nCommon.User\r\nAssignedIdentities\r\nValue\r\nComponentNames\r\ncreatedByType The type of identity that created the resource.\r\nDataDisk Describes a data disk.\r\nDeleteOptions Specify what happens to the network interface when the VM is deleted\r\nDiagnosticsProfile Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 9 of 65\n\nDiffDiskOptions Specifies the ephemeral disk option for operating system disk.\r\nDiffDiskPlacement\r\nSpecifies the ephemeral disk placement for operating system disk. This property can be used by\r\nuser in the request to choose the location i.e, cache disk, resource disk or nvme disk space for\r\nEphemeral OS disk provisioning. For more information on Ephemeral OS disk size\r\nrequirements, please refer Ephemeral OS disk size requirements for Windows VM at\r\nhttps://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:\r\n2024-03-01.\r\nDiffDiskSettings\r\nDescribes the parameters of ephemeral disk settings that can be specified for operating system\r\ndisk. Note: The ephemeral disk settings can only be specified for managed disk.\r\nDiskController\r\nTypes\r\nSpecifies the disk controller type configured for the VM and VirtualMachineScaleSet. This\r\nproperty is only supported for virtual machines whose operating system disk and VM sku\r\nsupports Generation 2 (https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2),\r\nplease check the HyperVGenerations capability returned as part of VM sku capabilities in the\r\nresponse of Microsoft.Compute SKUs api for the region contains V2\r\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about\r\nDisk Controller Types supported please refer to https://aka.ms/azure-diskcontrollertypes.\r\nDiskCreateOption\r\nTypes\r\nSpecifies how the virtual machine disk should be created. Possible values are Attach: This value\r\nis used when you are using a specialized disk to create the virtual machine. FromImage: This\r\nvalue is used when you are using an image to create the virtual machine. If you are using a\r\nplatform image, you should also use the imageReference element described above. If you are\r\nusing a marketplace image, you should also use the plan element previously described. Empty:\r\nThis value is used when creating an empty data disk. Copy: This value is used to create a data\r\ndisk from a snapshot or another disk. Restore: This value is used to create a data disk from a\r\ndisk restore point.\r\nDiskDeleteOption\r\nTypes\r\nSpecifies the behavior of the managed disk when the VM gets deleted, for example whether the\r\nmanaged disk is deleted or detached. Supported values are: Delete. If this value is used, the\r\nmanaged disk is deleted when VM gets deleted. Detach. If this value is used, the managed disk\r\nis retained after VM gets deleted. Minimum api-version: 2021-03-01.\r\nDiskDetachOption\r\nTypes\r\nSpecifies the detach behavior to be used while detaching a disk or which is already in the process\r\nof detachment from the virtual machine. Supported values are: ForceDetach. detachOption:\r\nForceDetach is applicable only for managed data disks. If a previous detachment attempt of the\r\ndata disk did not complete due to an unexpected failure from the virtual machine and the disk is\r\nstill not released then use force-detach as a last resort option to detach the disk forcibly from the\r\nVM. All writes might not have been flushed when using this detach behavior. This feature is\r\nstill in preview. To force-detach a data disk update toBeDetached to 'true' along with setting\r\ndetachOption: 'ForceDetach'.\r\nDiskEncryptionSet\r\nParameters\r\nDescribes the parameter of customer managed disk encryption set resource id that can be\r\nspecified for disk. Note: The disk encryption set resource id can only be specified for managed\r\ndisk. Please refer https://aka.ms/mdssewithcmkoverview for more details.\r\nDiskEncryption\r\nSettings\r\nDescribes a Encryption Settings for a Disk\r\nDiskInstanceView The instance view of the disk.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 10 of 65\n\nDomainNameLabel\r\nScopeTypes\r\nThe Domain name label scope.The concatenation of the hashed domain name label that\r\ngenerated according to the policy from domain name label scope and vm index will be the\r\ndomain name labels of the PublicIPAddress resources that will be created\r\nEncryptionIdentity Specifies the Managed Identity used by ADE to get access token for keyvault operations.\r\nEventGridAnd\r\nResourceGraph\r\nSpecifies eventGridAndResourceGraph related Scheduled Event related configurations.\r\nExtendedLocation The complex type of the extended location.\r\nExtendedLocation\r\nTypes\r\nThe type of the extended location.\r\nHardwareProfile Specifies the hardware settings for the virtual machine.\r\nHostEndpoint\r\nSettings\r\nSpecifies particular host endpoint settings.\r\nHyperVGeneration\r\nType\r\nSpecifies the HyperVGeneration Type associated with a resource\r\nImageReference\r\nSpecifies information about the image to use. You can specify information about platform\r\nimages, marketplace images, or virtual machine images. This element is required when you want\r\nto use a platform image, marketplace image, or virtual machine image, but is not used in other\r\ncreation operations. NOTE: Image reference publisher and offer can only be set when you create\r\nthe scale set.\r\nInnerError Inner error details.\r\nInstanceViewStatus Instance view status.\r\nInstanceViewTypes\r\nIPVersions\r\nAvailable from Api-Version 2017-03-30 onwards, it represents whether the specific\r\nipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.\r\nKeyVaultKey\r\nReference\r\nDescribes a reference to Key Vault Key\r\nKeyVaultSecret\r\nReference\r\nDescribes a reference to Key Vault Secret\r\nLastPatch\r\nInstallation\r\nSummary\r\nDescribes the properties of the last installed patch summary.\r\nLinux\r\nConfiguration\r\nSpecifies the Linux operating system settings on the virtual machine. For a list of supported\r\nLinux distributions, see Linux on Azure-Endorsed Distributions.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 11 of 65\n\nLinuxPatch\r\nAssessmentMode\r\nSpecifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments on a virtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property\r\nprovisionVMAgent must be true.\r\nLinuxPatchSettings Specifies settings related to VM Guest Patching on Linux.\r\nLinuxVMGuest\r\nPatchAutomatic\r\nByPlatformReboot\r\nSetting\r\nSpecifies the reboot setting for all AutomaticByPlatform patch installation operations.\r\nLinuxVMGuest\r\nPatchAutomatic\r\nByPlatformSettings\r\nSpecifies additional settings to be applied when patch mode AutomaticByPlatform is selected in\r\nLinux patch settings.\r\nLinuxVMGuest\r\nPatchMode\r\nSpecifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated\r\nto virtual machine scale set with OrchestrationMode as Flexible.\r\nPossible values are:\r\nImageDefault - The virtual machine's default patching configuration is used.\r\nAutomaticByPlatform - The virtual machine will be automatically updated by the platform. The\r\nproperty provisionVMAgent must be true\r\nMaintenance\r\nOperationResult\r\nCodeTypes\r\nThe Last Maintenance Operation Result Code.\r\nMaintenance\r\nRedeployStatus Maintenance Operation Status.\r\nManagedDisk\r\nParameters\r\nThe parameters of a managed disk.\r\nMode\r\nSpecifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will\r\nstart to audit or monitor but not enforce access control over requests to host endpoints in Audit\r\nmode, while in Enforce mode it will enforce access control. The default value is Enforce mode.\r\nModes\r\nSpecifies the execution mode. In Audit mode, the system acts as if it is enforcing the access\r\ncontrol policy, including emitting access denial entries in the logs but it does not actually deny\r\nany requests to host endpoints. In Enforce mode, the system will enforce the access control and it\r\nis the recommended mode of operation.\r\nNetworkApi\r\nVersion\r\nspecifies the Microsoft.Network API version used when creating networking resources in the\r\nNetwork Interface Configurations\r\nNetworkInterface\r\nAuxiliaryMode\r\nSpecifies whether the Auxiliary mode is enabled for the Network Interface resource.\r\nNetworkInterface\r\nAuxiliarySku\r\nSpecifies whether the Auxiliary sku is enabled for the Network Interface resource.\r\nNetworkInterface\r\nReference\r\nDescribes a network interface reference.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 12 of 65\n\nNetworkProfile Specifies the network interfaces or the networking configuration of the virtual machine.\r\nOperatingSystem\r\nTypes\r\nThis property allows you to specify the type of the OS that is included in the disk if creating a\r\nVM from a custom image. Possible values are: Windows, Linux.\r\nOSDisk\r\nSpecifies information about the operating system disk used by the virtual machine. For more\r\ninformation about disks, see About disks and VHDs for Azure virtual machines.\r\nOSImage\r\nNotificationProfile\r\nOSProfile\r\nSpecifies the operating system settings for the virtual machine. Some of the settings cannot be\r\nchanged once VM is provisioned.\r\nPassNames\r\nPatchOperation\r\nStatus\r\nThe overall success or failure status of the operation. It remains \"InProgress\" until the operation\r\ncompletes. At that point it will become \"Unknown\", \"Failed\", \"Succeeded\", or\r\n\"CompletedWithWarnings.\"\r\nPatchSettings Specifies settings related to VM Guest Patching on Windows.\r\nPlacement Describes the user-defined constraints for resource hardware placement.\r\nPlan\r\nSpecifies information about the marketplace image used to create the virtual machine. This\r\nelement is only used for marketplace images. Before you can use a marketplace image from an\r\nAPI, you must enable the image for programmatic use. In the Azure portal, find the marketplace\r\nimage that you want to use and then click Want to deploy programmatically, Get Started -\u003e.\r\nEnter any required information and then click Save.\r\nProtocolTypes Specifies the protocol of WinRM listener. Possible values are: http, https.\r\nProxyAgent\r\nSettings\r\nSpecifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.\r\nPublicIPAddress\r\nSku\r\nDescribes the public IP Sku. It can only be set with OrchestrationMode as Flexible.\r\nPublicIPAddress\r\nSkuName\r\nSpecify public IP sku name\r\nPublicIPAddress\r\nSkuTier\r\nSpecify public IP sku tier\r\nPublicIPAllocation\r\nMethod\r\nSpecify the public IP allocation type\r\nResourceIdentity\r\nType\r\nThe type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned'\r\nincludes both an implicitly created identity and a set of user assigned identities. The type 'None'\r\nwill remove any identities from the virtual machine.\r\nScheduledEvents\r\nAdditional\r\nPublishingTargets\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 13 of 65\n\nScheduledEvents\r\nPolicy\r\nSpecifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event\r\nrelated configurations.\r\nScheduledEvents\r\nProfile\r\nSecurityEncryption\r\nTypes\r\nSpecifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for\r\nencryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for\r\nencryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware\r\nstate in the VMGuestState blob.. Note: It can be set for only Confidential VMs.\r\nSecurityProfile Specifies the Security profile settings for the virtual machine or virtual machine scale set.\r\nSecurityTypes\r\nSpecifies the SecurityType of the virtual machine. It has to be set to any specified value to enable\r\nUefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.\r\nSettingNames\r\nSpecifies the name of the setting to which the content applies. Possible values are:\r\nFirstLogonCommands and AutoLogon.\r\nSshConfiguration SSH configuration for Linux based VMs running on Azure\r\nSshPublicKey\r\nContains information about SSH certificate public key and the path on the Linux VM where the\r\npublic key is placed.\r\nStatusLevelTypes The level code.\r\nStorageAccount\r\nTypes\r\nSpecifies the storage account type for the managed disk. Managed OS disk storage account type\r\ncan only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data\r\ndisks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS\r\nuses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk.\r\nPremium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard\r\nSSD zone redundant storage. For more information regarding disks supported for Windows\r\nVirtual 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\r\nStorageProfile Specifies the storage settings for the virtual machine disks.\r\nSubResource\r\nsystemData Metadata pertaining to creation and last modification of the resource.\r\nTerminate\r\nNotificationProfile\r\nUefiSettings\r\nSpecifies the security settings like secure boot and vTPM used while creating the virtual\r\nmachine. Minimum api-version: 2020-12-01.\r\nUserInitiated\r\nReboot\r\nSpecifies Reboot related Scheduled Event related configurations.\r\nUserInitiated\r\nRedeploy\r\nSpecifies Redeploy related Scheduled Event related configurations.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 14 of 65\n\nVaultCertificate\r\nDescribes a single certificate reference in a Key Vault, and where the certificate should reside on\r\nthe VM.\r\nVaultSecretGroup Describes a set of certificates which are all in the same Key Vault.\r\nVirtualHardDisk Describes the uri of a disk.\r\nVirtualMachine Describes a Virtual Machine.\r\nVirtualMachine\r\nAgentInstanceView\r\nThe instance view of the VM Agent running on the virtual machine.\r\nVirtualMachine\r\nEvictionPolicy\r\nTypes\r\nSpecifies the eviction policy for the Azure Spot VM/VMSS\r\nVirtualMachine\r\nExtension\r\nDescribes a Virtual Machine Extension.\r\nVirtualMachine\r\nExtensionHandler\r\nInstanceView\r\nThe instance view of a virtual machine extension handler.\r\nVirtualMachine\r\nExtensionInstance\r\nView\r\nThe instance view of a virtual machine extension.\r\nVirtualMachine\r\nHealthStatus\r\nThe health status of the VM.\r\nVirtualMachine\r\nIdentity\r\nIdentity for the virtual machine.\r\nVirtualMachine\r\nInstanceView\r\nThe instance view of a virtual machine.\r\nVirtualMachine\r\nIpTag\r\nContains the IP tag associated with the public IP address.\r\nVirtualMachine\r\nNetworkInterface\r\nConfiguration\r\nDescribes a virtual machine network interface configurations.\r\nVirtualMachine\r\nNetworkInterface\r\nDnsSettings\r\nConfiguration\r\nDescribes a virtual machines network configuration's DNS settings.\r\nVirtualMachine\r\nNetworkInterface\r\nIPConfiguration\r\nDescribes a virtual machine network profile's IP configuration.\r\nVirtualMachine\r\nPatchStatus\r\nThe status of virtual machine patch operations.\r\nVirtualMachine\r\nPriorityTypes\r\nSpecifies the priority for a standalone virtual machine or the virtual machines in the scale set.\r\n'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot\r\nVM/VMSS.\r\nVirtualMachine\r\nPublicIPAddress\r\nConfiguration\r\nDescribes a virtual machines IP Configuration's PublicIPAddress configuration\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 15 of 65\n\nVirtualMachine\r\nPublicIPAddress\r\nDnsSettings\r\nConfiguration\r\nDescribes a virtual machines network configuration's DNS settings.\r\nVirtualMachineSize\r\nTypes\r\nSpecifies the size of the virtual machine. The enum data type is currently deprecated and will be\r\nremoved by December 23rd 2023. The recommended way to get the list of available sizes is\r\nusing these APIs: List all available virtual machine sizes in an availability set, List all available\r\nvirtual machine sizes in a region, List all available virtual machine sizes for resizing. For more\r\ninformation about virtual machine sizes, see Sizes for virtual machines. The available VM sizes\r\ndepend on region and availability set.\r\nVMDiskSecurity\r\nProfile\r\nSpecifies the security profile settings for the managed disk. Note: It can only be set for\r\nConfidential VMs.\r\nVMGallery\r\nApplication\r\nSpecifies the required information to reference a compute gallery application version\r\nVMSizeProperties Specifies VM Size Property settings on the virtual machine.\r\nWindows\r\nConfiguration\r\nSpecifies Windows operating system settings on the virtual machine.\r\nWindowsPatch\r\nAssessmentMode\r\nSpecifies the mode of VM Guest patch assessment for the IaaS virtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments on a virtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property\r\nprovisionVMAgent must be true.\r\nWindowsVMGuest\r\nPatchAutomatic\r\nByPlatformReboot\r\nSetting\r\nSpecifies the reboot setting for all AutomaticByPlatform patch installation operations.\r\nWindowsVMGuest\r\nPatchAutomatic\r\nByPlatformSettings\r\nSpecifies additional settings to be applied when patch mode AutomaticByPlatform is selected in\r\nWindows patch settings.\r\nWindowsVMGuest\r\nPatchMode\r\nSpecifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated\r\nto virtual machine scale set with OrchestrationMode as Flexible.\r\nPossible values are:\r\nManual - You control the application of patches to a virtual machine. You do this by applying\r\npatches manually inside the VM. In this mode, automatic updates are disabled; the property\r\nWindowsConfiguration.enableAutomaticUpdates must be false\r\nAutomaticByOS - The virtual machine will automatically be updated by the OS. The property\r\nWindowsConfiguration.enableAutomaticUpdates must be true.\r\nAutomaticByPlatform - the virtual machine will automatically updated by the platform. The\r\nproperties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be\r\ntrue\r\nWin\r\nRMConfiguration\r\nDescribes Windows Remote Management configuration of the VM\r\nWinRMListener Describes Protocol and thumbprint of Windows Remote Management listener\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 16 of 65\n\nZonePlacement\r\nPolicyType\r\nSpecifies the policy for resource's placement in availability zone. Possible values are: Any (used\r\nfor Virtual Machines), Auto (used for Virtual Machine Scale Sets) - An availability zone will be\r\nautomatically picked by system as part of resource creation.\r\nAdditionalCapabilities\r\nObject\r\nEnables or disables a capability on the virtual machine or virtual machine scale set.\r\nName Type Description\r\nenableFips1403Encryption boolean\r\nThe flag enables the usage of FIPS 140-3 compliant cryptography on the\r\nprotectedSettings of an extension. Learn more at:\r\nhttps://aka.ms/linuxagentfipssupport.\r\nhibernationEnabled boolean The flag that enables or disables hibernation capability on the VM.\r\nultraSSDEnabled boolean\r\nThe flag that enables or disables a capability to have one or more managed\r\ndata disks with UltraSSD_LRS storage account type on the VM or VMSS.\r\nManaged disks with storage account type UltraSSD_LRS can be added to a\r\nvirtual machine or virtual machine scale set only if this property is enabled.\r\nAdditionalUnattendContent\r\nObject\r\nSpecifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows\r\nSetup. Contents are defined by setting name, component name, and the pass in which the content is applied.\r\nName Type Description\r\ncomponentName\r\nComponent\r\nNames\r\nThe component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.\r\ncontent string\r\nSpecifies the XML formatted content that is added to the unattend.xml file for the\r\nspecified path and component. The XML must be less than 4KB and must include\r\nthe root element for the setting or feature that is being inserted.\r\npassName PassNames The pass name. Currently, the only allowable value is OobeSystem.\r\nsettingName\r\nSetting\r\nNames\r\nSpecifies the name of the setting to which the content applies. Possible values are:\r\nFirstLogonCommands and AutoLogon.\r\nAllInstancesDown\r\nObject\r\nSpecifies if Scheduled Events should be auto-approved when all instances are down.\r\nName Type Description\r\nautomaticallyApprove boolean\r\nSpecifies if Scheduled Events should be auto-approved when all instances are\r\ndown. its default value is true\r\nApiEntityReference\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 17 of 65\n\nThe API entity reference.\r\nName Type Description\r\nid string\r\nThe ARM resource id in the form of\r\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...\r\nApiError\r\nObject\r\nApi error.\r\nName Type Description\r\ncode string The error code.\r\ndetails ApiErrorBase[] The Api error details\r\ninnererror InnerError The Api inner error\r\nmessage string The error message.\r\ntarget string The target of the particular error.\r\nApiErrorBase\r\nObject\r\nApi error base.\r\nName Type Description\r\ncode string The error code.\r\nmessage string The error message.\r\ntarget string The target of the particular error.\r\nApplicationProfile\r\nObject\r\nContains the list of gallery applications that should be made available to the VM/VMSS\r\nName Type Description\r\ngalleryApplications\r\nVMGallery\r\nApplication[]\r\nSpecifies the gallery applications that should be made available to the\r\nVM/VMSS\r\nAvailablePatchSummary\r\nObject\r\nDescribes the properties of an virtual machine instance view for available patch summary.\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 18 of 65\n\nassessmentActivityId string\r\nThe activity ID of the operation that produced this result. It is used to\r\ncorrelate across CRP and extension logs.\r\ncriticalAndSecurityPatchCount\r\ninteger\r\n(int32)\r\nThe number of critical or security patches that have been detected as\r\navailable and not yet installed.\r\nerror ApiError\r\nThe errors that were encountered during execution of the operation.\r\nThe details array contains the list of them.\r\nlastModifiedTime\r\nstring (date-time)\r\nThe UTC timestamp when the operation began.\r\notherPatchCount\r\ninteger\r\n(int32)\r\nThe number of all available patches excluding critical and security.\r\nrebootPending boolean\r\nThe overall reboot status of the VM. It will be true when partially\r\ninstalled patches require a reboot to complete installation but the\r\nreboot has not yet occurred.\r\nstartTime\r\nstring (date-time)\r\nThe UTC timestamp when the operation began.\r\nstatus\r\nPatch\r\nOperation\r\nStatus\r\nThe overall success or failure status of the operation. It remains\r\n\"InProgress\" until the operation completes. At that point it will\r\nbecome \"Unknown\", \"Failed\", \"Succeeded\", or\r\n\"CompletedWithWarnings.\"\r\nBillingProfile\r\nObject\r\nSpecifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01.\r\nName Type Description\r\nmaxPrice\r\nnumber\r\n(double)\r\nSpecifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price\r\nis in US Dollars.\r\nThis price will be compared with the current Azure Spot price for the VM size. Also, the\r\nprices are compared at the time of create/update of Azure Spot VM/VMSS and the operation\r\nwill only succeed if the maxPrice is greater than the current Azure Spot price.\r\nThe maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure\r\nSpot price goes beyond the maxPrice after creation of VM/VMSS.\r\nPossible values are:\r\n- Any decimal value greater than zero. Example: 0.01538\r\n-1 – indicates default price to be up-to on-demand.\r\nYou can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be\r\nevicted for price reasons. Also, the default max price is -1 if it is not provided by you.\r\nMinimum api-version: 2019-03-01.\r\nBootDiagnostics\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 19 of 65\n\nBoot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.\r\nYou can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the\r\nhypervisor.\r\nName Type Description\r\nenabled boolean Whether boot diagnostics should be enabled on the Virtual Machine.\r\nstorageUri string\r\nUri of the storage account to use for placing the console output and screenshot. If storageUri is\r\nnot specified while enabling boot diagnostics, managed storage will be used.\r\nBootDiagnosticsInstanceView\r\nObject\r\nThe instance view of a virtual machine boot diagnostics.\r\nName Type Description\r\nconsoleScreenshotBlobUri string\r\nThe console screenshot blob URI. Note: This will not be set if boot\r\ndiagnostics is currently enabled with managed storage.\r\nserialConsoleLogBlobUri string\r\nThe serial console log blob Uri. Note: This will not be set if boot\r\ndiagnostics is currently enabled with managed storage.\r\nstatus\r\nInstanceView\r\nStatus\r\nThe boot diagnostics status information for the VM. Note: It will be set\r\nonly if there are errors encountered in enabling boot diagnostics.\r\nCachingTypes\r\nEnumeration\r\nSpecifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for\r\nStandard storage. ReadOnly for Premium storage\r\nValue Description\r\nNone\r\nReadOnly\r\nReadWrite\r\nCapacityReservationProfile\r\nObject\r\nThe parameters of a capacity reservation Profile.\r\nName Type Description\r\ncapacityReservationGroup\r\nSub\r\nResource\r\nSpecifies the capacity reservation group resource id that should be used for\r\nallocating the virtual machine or scaleset vm instances provided enough\r\ncapacity has been reserved. Please refer to\r\nhttps://aka.ms/CapacityReservation for more details.\r\nCloudError\r\nObject\r\nAn error response from the Compute service.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 20 of 65\n\nName Type Description\r\nerror ApiError Api error.\r\nCommon.UserAssignedIdentitiesValue\r\nObject\r\nName Type Description\r\nclientId string The client id of user assigned identity.\r\nprincipalId string The principal id of user assigned identity.\r\nComponentNames\r\nEnumeration\r\nValue Description\r\nMicrosoft-Windows-Shell-Setup\r\ncreatedByType\r\nEnumeration\r\nThe type of identity that created the resource.\r\nValue Description\r\nUser\r\nApplication\r\nManagedIdentity\r\nKey\r\nDataDisk\r\nObject\r\nDescribes a data disk.\r\nName Type Description\r\ncaching\r\nCaching\r\nTypes\r\nSpecifies the caching requirements. Possible values are: None, ReadOnly,\r\nReadWrite. The defaulting behavior is: None for Standard storage.\r\nReadOnly for Premium storage.\r\ncreateOption\r\nDiskCreate\r\nOption\r\nTypes\r\nSpecifies how the virtual machine disk should be created. Possible values\r\nare Attach: This value is used when you are using a specialized disk to\r\ncreate the virtual machine. FromImage: This value is used when you are\r\nusing an image to create the virtual machine data disk. If you are using a\r\nplatform image, you should also use the imageReference element described\r\nabove. If you are using a marketplace image, you should also use the plan\r\nelement previously described. Empty: This value is used when creating an\r\nempty data disk. Copy: This value is used to create a data disk from a\r\nsnapshot or another disk. Restore: This value is used to create a data disk\r\nfrom a disk restore point.\r\ndeleteOption\r\nDiskDelete\r\nOption\r\nSpecifies whether data disk should be deleted or detached upon VM\r\ndeletion. Possible values are: Delete. If this value is used, the data disk is\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 21 of 65\n\nTypes deleted when VM is deleted. Detach. If this value is used, the data disk is\r\nretained after VM is deleted. The default value is set to Detach.\r\ndetachOption\r\nDiskDetach\r\nOption\r\nTypes\r\nSpecifies the detach behavior to be used while detaching a disk or which is\r\nalready in the process of detachment from the virtual machine. Supported\r\nvalues: ForceDetach. detachOption: ForceDetach is applicable only for\r\nmanaged data disks. If a previous detachment attempt of the data disk did\r\nnot complete due to an unexpected failure from the virtual machine and the\r\ndisk is still not released then use force-detach as a last resort option to\r\ndetach the disk forcibly from the VM. All writes might not have been\r\nflushed when using this detach behavior. This feature is still in preview. To\r\nforce-detach a data disk update toBeDetached to 'true' along with setting\r\ndetachOption: 'ForceDetach'.\r\ndiskIOPSReadWrite\r\ninteger\r\n(int64)\r\nSpecifies the Read-Write IOPS for the managed disk when\r\nStorageAccountType is UltraSSD_LRS.\r\ndiskMBpsReadWrite\r\ninteger\r\n(int64)\r\nSpecifies the bandwidth in MB per second for the managed disk when\r\nStorageAccountType is UltraSSD_LRS.\r\ndiskSizeGB\r\ninteger\r\n(int32)\r\nSpecifies the size of an empty data disk in gigabytes. This element can be\r\nused to overwrite the size of the disk in a virtual machine image. The\r\nproperty 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the\r\nvalue cannot be larger than 1023.\r\nimage\r\nVirtual\r\nHardDisk\r\nThe source user image virtual hard disk. The virtual hard disk will be copied\r\nbefore being attached to the virtual machine. If SourceImage is provided,\r\nthe destination virtual hard drive must not exist.\r\nlun\r\ninteger\r\n(int32)\r\nSpecifies the logical unit number of the data disk. This value is used to\r\nidentify data disks within the VM and therefore must be unique for each\r\ndata disk attached to a VM.\r\nmanagedDisk\r\nManaged\r\nDisk\r\nParameters\r\nThe managed disk parameters.\r\nname string The disk name.\r\nsourceResource\r\nApiEntity\r\nReference\r\nThe source resource identifier. It can be a snapshot, or disk restore point\r\nfrom which to create a disk.\r\ntoBeDetached boolean\r\nSpecifies whether the data disk is in process of detachment from the\r\nVirtualMachine/VirtualMachineScaleset\r\nvhd\r\nVirtual\r\nHardDisk\r\nThe virtual hard disk.\r\nwriteAcceleratorEnabled boolean\r\nSpecifies whether writeAccelerator should be enabled or disabled on the\r\ndisk.\r\nDeleteOptions\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 22 of 65\n\nEnumeration\r\nSpecify what happens to the network interface when the VM is deleted\r\nValue Description\r\nDelete\r\nDetach\r\nDiagnosticsProfile\r\nObject\r\nSpecifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.\r\nName Type Description\r\nbootDiagnostics\r\nBoot\r\nDiagnostics\r\nBoot Diagnostics is a debugging feature which allows you to view Console Output\r\nand Screenshot to diagnose VM status. NOTE: If storageUri is being specified then\r\nensure that the storage account is in the same region and subscription as the VM.\r\nYou can easily view the output of your console log. Azure also enables you to see a\r\nscreenshot of the VM from the hypervisor.\r\nDiffDiskOptions\r\nEnumeration\r\nSpecifies the ephemeral disk option for operating system disk.\r\nDiffDiskPlacement\r\nEnumeration\r\nSpecifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose\r\nthe location i.e, cache disk, resource disk or nvme disk space for Ephemeral OS disk provisioning. For more information on\r\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at\r\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at\r\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Minimum api-version for\r\nNvmeDisk: 2024-03-01.\r\nValue Description\r\nCacheDisk\r\nResourceDisk\r\nNvmeDisk\r\nDiffDiskSettings\r\nObject\r\nDescribes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral\r\ndisk settings can only be specified for managed disk.\r\nDiskControllerTypes\r\nEnumeration\r\nSpecifies the disk controller type configured for the VM and VirtualMachineScaleSet. This property is only supported for\r\nvirtual 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\r\ncapabilities in the response of Microsoft.Compute SKUs api for the region contains V2\r\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more information about Disk Controller Types\r\nsupported please refer to https://aka.ms/azure-diskcontrollertypes.\r\nValue Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 23 of 65\n\nSCSI\r\nNVMe\r\nDiskCreateOptionTypes\r\nEnumeration\r\nSpecifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using\r\na specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the\r\nvirtual machine. If you are using a platform image, you should also use the imageReference element described above. If you\r\nare using a marketplace image, you should also use the plan element previously described. Empty: This value is used when\r\ncreating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This\r\nvalue is used to create a data disk from a disk restore point.\r\nValue Description\r\nFromImage\r\nEmpty\r\nAttach\r\nCopy\r\nRestore\r\nDiskDeleteOptionTypes\r\nEnumeration\r\nSpecifies the behavior of the managed disk when the VM gets deleted, for example whether the managed disk is deleted or\r\ndetached. Supported values are: Delete. If this value is used, the managed disk is deleted when VM gets deleted. Detach. If\r\nthis value is used, the managed disk is retained after VM gets deleted. Minimum api-version: 2021-03-01.\r\nValue Description\r\nDelete\r\nDetach\r\nDiskDetachOptionTypes\r\nEnumeration\r\nSpecifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the\r\nvirtual machine. Supported values are: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks.\r\nIf a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and\r\nthe disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes\r\nmight not have been flushed when using this detach behavior. This feature is still in preview. To force-detach a data disk\r\nupdate toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.\r\nValue Description\r\nForceDetach\r\nDiskEncryptionSetParameters\r\nObject\r\nDescribes the parameter of customer managed disk encryption set resource id that can be specified for disk. Note: The disk\r\nencryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for\r\nmore details.\r\nName Type Description\r\nid string Resource Id\r\nDiskEncryptionSettings\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 24 of 65\n\nObject\r\nDescribes a Encryption Settings for a Disk\r\nName Type Description\r\ndiskEncryptionKey\r\nKeyVaultSecret\r\nReference\r\nSpecifies the location of the disk encryption key, which is a Key\r\nVault Secret.\r\nenabled boolean\r\nSpecifies whether disk encryption should be enabled on the virtual\r\nmachine.\r\nkeyEncryptionKey KeyVaultKeyReference Specifies the location of the key encryption key in Key Vault.\r\nDiskInstanceView\r\nObject\r\nThe instance view of the disk.\r\nName Type Description\r\nencryptionSettings DiskEncryptionSettings[]\r\nSpecifies the encryption settings for the OS Disk.\r\nMinimum api-version: 2015-06-15\r\nname string The disk name.\r\nstatuses InstanceViewStatus[] The resource status information.\r\nDomainNameLabelScopeTypes\r\nEnumeration\r\nThe Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy\r\nfrom domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be\r\ncreated\r\nValue Description\r\nTenantReuse\r\nSubscriptionReuse\r\nResourceGroupReuse\r\nNoReuse\r\nEncryptionIdentity\r\nObject\r\nSpecifies the Managed Identity used by ADE to get access token for keyvault operations.\r\nName Type Description\r\nuserAssignedIdentityResourceId string\r\nSpecifies ARM Resource ID of one of the user identities associated with\r\nthe VM.\r\nEventGridAndResourceGraph\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 25 of 65\n\nSpecifies eventGridAndResourceGraph related Scheduled Event related configurations.\r\nName Type Description\r\nenable boolean\r\nSpecifies if event grid and resource graph is enabled for Scheduled event\r\nrelated configurations.\r\nscheduledEventsApiVersion string\r\nSpecifies the api-version to determine which Scheduled Events configuration\r\nschema version will be delivered.\r\nExtendedLocation\r\nObject\r\nThe complex type of the extended location.\r\nName Type Description\r\nname string The name of the extended location.\r\ntype ExtendedLocationTypes The type of the extended location.\r\nExtendedLocationTypes\r\nEnumeration\r\nThe type of the extended location.\r\nValue Description\r\nEdgeZone\r\nHardwareProfile\r\nObject\r\nSpecifies the hardware settings for the virtual machine.\r\nHostEndpointSettings\r\nObject\r\nSpecifies particular host endpoint settings.\r\nName Type Description\r\ninVMAccessControlProfileReferenceId string\r\nSpecifies the InVMAccessControlProfileVersion resource id in the format of\r\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Com\r\nmode Modes\r\nSpecifies the execution mode. In Audit mode, the system acts as if it is enforcing the access contro\r\nany requests to host endpoints. In Enforce mode, the system will enforce the access control and it\r\nHyperVGenerationType\r\nEnumeration\r\nSpecifies the HyperVGeneration Type associated with a resource\r\nImageReference\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 26 of 65\n\nSpecifies information about the image to use. You can specify information about platform images, marketplace images, or\r\nvirtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual\r\nmachine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set\r\nwhen you create the scale set.\r\nName Type Description\r\ncommunityGalleryImageId string Specified the community gallery image unique id for vm deployment. This can be fetched from community gall\r\nexactVersion string\r\nSpecifies in decimal numbers, the version of platform image or marketplace image used to create the virtual ma\r\n'version', only if the value specified in 'version' field is 'latest'.\r\nid string Resource Id\r\noffer string Specifies the offer of the platform image or marketplace image used to create the virtual machine.\r\npublisher string The image publisher.\r\nsharedGalleryImageId string Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image\r\nsku string The image SKU.\r\nversion string\r\nSpecifies the version of the platform image or marketplace image used to create the virtual machine. The allowe\r\n'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image availa\r\n'latest', the VM image will not automatically update after deploy time even if a new version becomes available.\r\ngallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of ga\r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries\r\nin the 'id' field without version input.\r\nInnerError\r\nObject\r\nInner error details.\r\nName Type Description\r\nerrordetail string The internal error message or exception dump.\r\nexceptiontype string The exception type.\r\nInstanceViewStatus\r\nObject\r\nInstance view status.\r\nName Type Description\r\ncode string The status code.\r\ndisplayStatus string The short localizable label for the status.\r\nlevel StatusLevelTypes The level code.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 27 of 65\n\nmessage string The detailed status message, including for alerts and error messages.\r\ntime string (date-time) The time of the status.\r\nInstanceViewTypes\r\nEnumeration\r\nValue Description\r\ninstanceView\r\nuserData\r\nresiliencyView\r\nIPVersions\r\nEnumeration\r\nAvailable from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default\r\nis taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.\r\nValue Description\r\nIPv4\r\nIPv6\r\nKeyVaultKeyReference\r\nObject\r\nDescribes a reference to Key Vault Key\r\nName Type Description\r\nkeyUrl string The URL referencing a key encryption key in Key Vault.\r\nsourceVault SubResource The relative URL of the Key Vault containing the key.\r\nKeyVaultSecretReference\r\nObject\r\nDescribes a reference to Key Vault Secret\r\nName Type Description\r\nsecretUrl string The URL referencing a secret in a Key Vault.\r\nsourceVault SubResource The relative URL of the Key Vault containing the secret.\r\nLastPatchInstallationSummary\r\nObject\r\nDescribes the properties of the last installed patch summary.\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 28 of 65\n\nerror ApiError\r\nThe errors that were encountered during execution of the operation.\r\nThe details array contains the list of them.\r\nexcludedPatchCount\r\ninteger\r\n(int32)\r\nThe number of all available patches but excluded explicitly by a\r\ncustomer-specified exclusion list match.\r\nfailedPatchCount\r\ninteger\r\n(int32)\r\nThe count of patches that failed installation.\r\ninstallationActivityId string\r\nThe activity ID of the operation that produced this result. It is used to\r\ncorrelate across CRP and extension logs.\r\ninstalledPatchCount\r\ninteger\r\n(int32)\r\nThe count of patches that successfully installed.\r\nlastModifiedTime\r\nstring (date-time)\r\nThe UTC timestamp when the operation began.\r\nmaintenanceWindowExceeded boolean\r\nDescribes whether the operation ran out of time before it completed\r\nall its intended actions\r\nnotSelectedPatchCount\r\ninteger\r\n(int32)\r\nThe number of all available patches but not going to be installed\r\nbecause it didn't match a classification or inclusion list entry.\r\npendingPatchCount\r\ninteger\r\n(int32)\r\nThe number of all available patches expected to be installed over the\r\ncourse of the patch installation operation.\r\nstartTime\r\nstring (date-time)\r\nThe UTC timestamp when the operation began.\r\nstatus\r\nPatch\r\nOperation\r\nStatus\r\nThe overall success or failure status of the operation. It remains\r\n\"InProgress\" until the operation completes. At that point it will\r\nbecome \"Unknown\", \"Failed\", \"Succeeded\", or\r\n\"CompletedWithWarnings.\"\r\nLinuxConfiguration\r\nObject\r\nSpecifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux\r\non Azure-Endorsed Distributions.\r\nName Type Description\r\ndisablePasswordAuthentication boolean Specifies whether password authentication should be disabled.\r\nenableVMAgentPlatformUpdates boolean\r\nIndicates whether VMAgent Platform Updates is enabled for the\r\nLinux virtual machine. Default value is false.\r\npatchSettings\r\nLinuxPatch\r\nSettings\r\n[Preview Feature] Specifies settings related to VM Guest\r\nPatching on Linux.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 29 of 65\n\nprovisionVMAgent boolean\r\nIndicates whether virtual machine agent should be provisioned\r\non the virtual machine. When this property is not specified in\r\nthe request body, default behavior is to set it to true. This will\r\nensure that VM Agent is installed on the VM so that extensions\r\ncan be added to the VM later.\r\nssh\r\nSsh\r\nConfiguration\r\nSpecifies the ssh key configuration for a Linux OS.\r\nLinuxPatchAssessmentMode\r\nEnumeration\r\nSpecifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments on a virtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be\r\ntrue.\r\nValue Description\r\nImageDefault\r\nAutomaticByPlatform\r\nLinuxPatchSettings\r\nObject\r\nSpecifies settings related to VM Guest Patching on Linux.\r\nName Type Description\r\nassessmentMode\r\nLinuxPatch\r\nAssessmentMode\r\nSpecifies the mode of VM Guest Patch Assessment for the\r\nIaaS virtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments\r\non a virtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic\r\npatch assessments. The property provisionVMAgent must be\r\ntrue.\r\nautomaticByPlatformSettings\r\nLinuxVMGuestPatch\r\nAutomaticByPlatform\r\nSettings\r\nSpecifies additional settings for patch mode\r\nAutomaticByPlatform in VM Guest Patching on Linux.\r\npatchMode\r\nLinuxVMGuestPatch\r\nMode\r\nSpecifies the mode of VM Guest Patching to IaaS virtual\r\nmachine or virtual machines associated to virtual machine\r\nscale set with OrchestrationMode as Flexible.\r\nPossible values are:\r\nImageDefault - The virtual machine's default patching\r\nconfiguration is used.\r\nAutomaticByPlatform - The virtual machine will be\r\nautomatically updated by the platform. The property\r\nprovisionVMAgent must be true\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 30 of 65\n\nLinuxVMGuestPatchAutomaticByPlatformRebootSetting\r\nEnumeration\r\nSpecifies the reboot setting for all AutomaticByPlatform patch installation operations.\r\nValue Description\r\nUnknown\r\nIfRequired\r\nNever\r\nAlways\r\nLinuxVMGuestPatchAutomaticByPlatformSettings\r\nObject\r\nSpecifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings.\r\nName Type Description\r\nbypassPlatformSafetyChecksOnUserSchedule boolean\r\nEnables customer to schedule patching\r\nwithout accidental upgrades\r\nrebootSetting\r\nLinuxVMGuestPatch\r\nAutomaticByPlatform\r\nRebootSetting\r\nSpecifies the reboot setting for all\r\nAutomaticByPlatform patch installation\r\noperations.\r\nLinuxVMGuestPatchMode\r\nEnumeration\r\nSpecifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set\r\nwith OrchestrationMode as Flexible.\r\nPossible values are:\r\nImageDefault - The virtual machine's default patching configuration is used.\r\nAutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property\r\nprovisionVMAgent must be true\r\nValue Description\r\nImageDefault\r\nAutomaticByPlatform\r\nMaintenanceOperationResultCodeTypes\r\nEnumeration\r\nThe Last Maintenance Operation Result Code.\r\nValue Description\r\nNone\r\nRetryLater\r\nMaintenanceAborted\r\nMaintenanceCompleted\r\nMaintenanceRedeployStatus\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 31 of 65\n\nMaintenance Operation Status.\r\nName Type Description\r\nisCustomerInitiatedMaintenanceAllowed boolean\r\nTrue, if customer is allowed to perform\r\nMaintenance.\r\nlastOperationMessage string Message returned for the last\r\nMaintenance Operation.\r\nlastOperationResultCode\r\nMaintenanceOperationResult\r\nCodeTypes\r\nThe Last Maintenance Operation Result\r\nCode.\r\nmaintenanceWindowEndTime string (date-time) End Time for the Maintenance Window.\r\nmaintenanceWindowStartTime string (date-time)\r\nStart Time for the Maintenance\r\nWindow.\r\npreMaintenanceWindowEndTime string (date-time)\r\nEnd Time for the Pre Maintenance\r\nWindow.\r\npreMaintenanceWindowStartTime string (date-time)\r\nStart Time for the Pre Maintenance\r\nWindow.\r\nManagedDiskParameters\r\nObject\r\nThe parameters of a managed disk.\r\nName Type Description\r\ndiskEncryptionSet\r\nDiskEncryptionSet\r\nParameters\r\nSpecifies the customer managed disk encryption set resource id for the\r\nmanaged disk.\r\nid string Resource Id\r\nsecurityProfile\r\nVMDiskSecurity\r\nProfile\r\nSpecifies the security profile for the managed disk.\r\nstorageAccountType\r\nStorageAccount\r\nTypes\r\nSpecifies the storage account type for the managed disk. NOTE:\r\nUltraSSD_LRS can only be used with data disks, it cannot be used with\r\nOS Disk.\r\nMode\r\nEnumeration\r\nSpecifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but\r\nnot enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access\r\ncontrol. The default value is Enforce mode.\r\nValue Description\r\nAudit\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 32 of 65\n\nEnforce\r\nModes\r\nEnumeration\r\nSpecifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including\r\nemitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the\r\nsystem will enforce the access control and it is the recommended mode of operation.\r\nValue Description\r\nAudit\r\nEnforce\r\nDisabled\r\nNetworkApiVersion\r\nEnumeration\r\nspecifies the Microsoft.Network API version used when creating networking resources in the Network Interface\r\nConfigurations\r\nValue Description\r\n2020-11-01\r\n2022-11-01\r\nNetworkInterfaceAuxiliaryMode\r\nEnumeration\r\nSpecifies whether the Auxiliary mode is enabled for the Network Interface resource.\r\nValue Description\r\nNone\r\nAcceleratedConnections\r\nFloating\r\nNetworkInterfaceAuxiliarySku\r\nEnumeration\r\nSpecifies whether the Auxiliary sku is enabled for the Network Interface resource.\r\nValue Description\r\nNone\r\nA1\r\nA2\r\nA4\r\nA8\r\nNetworkInterfaceReference\r\nObject\r\nDescribes a network interface reference.\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 33 of 65\n\nid string Resource Id\r\nproperties.deleteOption\r\nDelete\r\nOptions\r\nSpecify what happens to the network interface when the VM is deleted\r\nproperties.primary boolean\r\nSpecifies the primary network interface in case the virtual machine has more\r\nthan 1 network interface.\r\nNetworkProfile\r\nObject\r\nSpecifies the network interfaces or the networking configuration of the virtual machine.\r\nName Type Description\r\nnetworkApiVersion NetworkApiVersion\r\nspecifies the Microsoft.Network API version used\r\nwhen creating networking resources in the Network\r\nInterface Configurations\r\nnetworkInterfaceConfigurations\r\nVirtualMachineNetwork\r\nInterfaceConfiguration[]\r\nSpecifies the networking configurations that will be\r\nused to create the virtual machine networking\r\nresources.\r\nnetworkInterfaces\r\nNetworkInterface\r\nReference[]\r\nSpecifies the list of resource Ids for the network\r\ninterfaces associated with the virtual machine.\r\nOperatingSystemTypes\r\nEnumeration\r\nThis property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.\r\nPossible values are: Windows, Linux.\r\nValue Description\r\nWindows\r\nLinux\r\nOSDisk\r\nObject\r\nSpecifies information about the operating system disk used by the virtual machine. For more information about disks, see\r\nAbout disks and VHDs for Azure virtual machines.\r\nName Type Description\r\ncaching\r\nCaching\r\nTypes\r\nSpecifies the caching requirements. Possible values are: None, ReadOnly,\r\nReadWrite. The defaulting behavior is: None for Standard storage.\r\nReadOnly for Premium storage.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 34 of 65\n\ncreateOption\r\nDiskCreate\r\nOptionTypes\r\nSpecifies how the virtual machine disk should be created. Possible values\r\nare Attach: This value is used when you are using a specialized disk to\r\ncreate the virtual machine. FromImage: This value is used when you are\r\nusing an image to create the virtual machine. If you are using a platform\r\nimage, you should also use the imageReference element described above.\r\nIf you are using a marketplace image, you should also use the plan element\r\npreviously described.\r\ndeleteOption\r\nDiskDelete\r\nOptionTypes\r\nSpecifies whether OS Disk should be deleted or detached upon VM\r\ndeletion. Possible values are: Delete. If this value is used, the OS disk is\r\ndeleted when VM is deleted. Detach. If this value is used, the os disk is\r\nretained after VM is deleted. The default value is set to Detach. For an\r\nephemeral OS Disk, the default value is set to Delete. The user cannot\r\nchange the delete option for an ephemeral OS Disk.\r\ndiffDiskSettings\r\nDiffDisk\r\nSettings\r\nSpecifies the ephemeral Disk Settings for the operating system disk used\r\nby the virtual machine.\r\ndiskSizeGB\r\ninteger\r\n(int32)\r\nSpecifies the size of an empty data disk in gigabytes. This element can be\r\nused to overwrite the size of the disk in a virtual machine image. The\r\nproperty 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the\r\nvalue cannot be larger than 1023.\r\nencryptionSettings\r\nDisk\r\nEncryption\r\nSettings\r\nSpecifies the encryption settings for the OS Disk. Minimum api-version:\r\n2015-06-15.\r\nimage\r\nVirtualHard\r\nDisk\r\nThe source user image virtual hard disk. The virtual hard disk will be\r\ncopied before being attached to the virtual machine. If SourceImage is\r\nprovided, the destination virtual hard drive must not exist.\r\nmanagedDisk\r\nManaged\r\nDisk\r\nParameters\r\nThe managed disk parameters.\r\nname string The disk name.\r\nosType\r\nOperating\r\nSystem\r\nTypes\r\nThis property allows you to specify the type of the OS that is included in\r\nthe disk if creating a VM from user-image or a specialized VHD. Possible\r\nvalues are: Windows, Linux.\r\nvhd\r\nVirtualHard\r\nDisk\r\nThe virtual hard disk.\r\nwriteAcceleratorEnabled boolean\r\nSpecifies whether writeAccelerator should be enabled or disabled on the\r\ndisk.\r\nOSImageNotificationProfile\r\nObject\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 35 of 65\n\nenable boolean Specifies whether the OS Image Scheduled event is enabled or disabled.\r\nnotBeforeTimeout string\r\nLength of time a Virtual Machine being reimaged or having its OS upgraded will have\r\nto potentially approve the OS Image Scheduled Event before the event is auto\r\napproved (timed out). The configuration is specified in ISO 8601 format, and the value\r\nmust be 15 minutes (PT15M)\r\nOSProfile\r\nObject\r\nSpecifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is\r\nprovisioned.\r\nName Type Description\r\nadminPassword\r\nstring\r\n(password)\r\nSpecifies the password of the administrator account.\r\nMinimum-length (Windows): 8 characters\r\nMinimum-length (Linux): 6 characters\r\nMax-length (Windows): 123 characters\r\nMax-length (Linux): 72 characters\r\nComplexity requirements: 3 out of 4 conditions below need to be\r\nfulfilled\r\nHas lower characters\r\nHas upper characters\r\nHas a digit\r\nHas a special character (Regex match [\\W_])\r\nDisallowed values: \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\r\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\",\r\n\"Password1\", \"Password22\", \"iloveyou!\"\r\nFor resetting the password, see How to reset the Remote Desktop\r\nservice or its login password in a Windows VM\r\nFor resetting root password, see Manage users, SSH, and check or\r\nrepair disks on Azure Linux VMs using the VMAccess Extension\r\nadminUsername string\r\nSpecifies the name of the administrator account.\r\nThis property cannot be updated after the VM is created.\r\nWindows-only restriction: Cannot end in \".\"\r\nDisallowed values: \"administrator\", \"admin\", \"user\", \"user1\", \"test\",\r\n\"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\",\r\n\"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\",\r\n\"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\",\r\n\"sys\", \"test2\", \"test3\", \"user4\", \"user5\".\r\nMinimum-length (Linux): 1 character\r\nMax-length (Linux): 64 characters\r\nMax-length (Windows): 20 characters.\r\nallowExtensionOperations boolean\r\nSpecifies whether extension operations should be allowed on the\r\nvirtual machine. This may only be set to False when no extensions\r\nare present on the virtual machine.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 36 of 65\n\ncomputerName string\r\nSpecifies the host OS name of the virtual machine. This name cannot\r\nbe updated after the VM is created. Max-length (Windows): 15\r\ncharacters. Max-length (Linux): 64 characters. For naming\r\nconventions and restrictions see Azure infrastructure services\r\nimplementation guidelines.\r\ncustomData string\r\nSpecifies a base-64 encoded string of custom data. The base-64\r\nencoded string is decoded to a binary array that is saved as a file on\r\nthe Virtual Machine. The maximum length of the binary array is\r\n65535 bytes. Note: Do not pass any secrets or passwords in\r\ncustomData property. This property cannot be updated after the VM\r\nis created. The property 'customData' is passed to the VM to be saved\r\nas a file, for more information see Custom Data on Azure VMs. For\r\nusing cloud-init for your Linux VM, see Using cloud-init to\r\ncustomize a Linux VM during creation.\r\nlinuxConfiguration\r\nLinux\r\nConfiguration\r\nSpecifies the Linux operating system settings on the virtual machine.\r\nFor a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.\r\nrequireGuestProvisionSignal boolean Optional property which must either be set to True or omitted.\r\nsecrets\r\nVaultSecret\r\nGroup[]\r\nSpecifies set of certificates that should be installed onto the virtual\r\nmachine. To install certificates on a virtual machine it is\r\nrecommended to use the Azure Key Vault virtual machine extension\r\nfor Linux or the Azure Key Vault virtual machine extension for\r\nWindows.\r\nwindowsConfiguration\r\nWindows\r\nConfiguration\r\nSpecifies Windows operating system settings on the virtual machine.\r\nPassNames\r\nEnumeration\r\nValue Description\r\nOobeSystem\r\nPatchOperationStatus\r\nEnumeration\r\nThe overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it\r\nwill become \"Unknown\", \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"\r\nValue Description\r\nUnknown\r\nInProgress\r\nFailed\r\nSucceeded\r\nCompletedWithWarnings\r\nPatchSettings\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 37 of 65\n\nSpecifies settings related to VM Guest Patching on Windows.\r\nName Type Description\r\nassessmentMode\r\nWindowsPatch\r\nAssessment\r\nMode\r\nSpecifies the mode of VM Guest patch assessment for the IaaS\r\nvirtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments on a\r\nvirtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic patch\r\nassessments. The property provisionVMAgent must be true.\r\nautomaticByPlatformSettings\r\nWindows\r\nVMGuestPatch\r\nAutomatic\r\nByPlatform\r\nSettings\r\nSpecifies additional settings for patch mode AutomaticByPlatform\r\nin VM Guest Patching on Windows.\r\nenableHotpatching boolean\r\nEnables customers to patch their Azure VMs without requiring a\r\nreboot. For enableHotpatching, the 'provisionVMAgent' must be set\r\nto true and 'patchMode' must be set to 'AutomaticByPlatform'.\r\npatchMode\r\nWindows\r\nVMGuestPatch\r\nMode\r\nSpecifies the mode of VM Guest Patching to IaaS virtual machine\r\nor virtual machines associated to virtual machine scale set with\r\nOrchestrationMode as Flexible.\r\nPossible values are:\r\nManual - You control the application of patches to a virtual\r\nmachine. You do this by applying patches manually inside the VM.\r\nIn this mode, automatic updates are disabled; the property\r\nWindowsConfiguration.enableAutomaticUpdates must be false\r\nAutomaticByOS - The virtual machine will automatically be\r\nupdated by the OS. The property\r\nWindowsConfiguration.enableAutomaticUpdates must be true.\r\nAutomaticByPlatform - the virtual machine will automatically\r\nupdated by the platform. The properties provisionVMAgent and\r\nWindowsConfiguration.enableAutomaticUpdates must be true\r\nPlacement\r\nObject\r\nDescribes the user-defined constraints for resource hardware placement.\r\nName Type Description\r\nexcludeZones string[]\r\nThis property supplements the 'zonePlacementPolicy' property. If\r\n'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the\r\nsystem must not be present in the list of availability zones passed with\r\n'excludeZones'. If 'excludeZones' is not provided, all availability zones in\r\nregion will be considered for selection.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 38 of 65\n\nincludeZones string[]\r\nThis property supplements the 'zonePlacementPolicy' property. If\r\n'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the\r\nsystem must be present in the list of availability zones passed with\r\n'includeZones'. If 'includeZones' is not provided, all availability zones in\r\nregion will be considered for selection.\r\nzonePlacementPolicy\r\nZone\r\nPlacement\r\nPolicyType\r\nSpecifies the policy for resource's placement in availability zone. Possible\r\nvalues are: Any (used for Virtual Machines), Auto (used for Virtual Machine\r\nScale Sets) - An availability zone will be automatically picked by system as\r\npart of resource creation.\r\nPlan\r\nObject\r\nSpecifies information about the marketplace image used to create the virtual machine. This element is only used for\r\nmarketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic\r\nuse. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically,\r\nGet Started -\u003e. Enter any required information and then click Save.\r\nName Type Description\r\nname string The plan ID.\r\nproduct string\r\nSpecifies the product of the image from the marketplace. This is the same value as Offer\r\nunder the imageReference element.\r\npromotionCode string The promotion code.\r\npublisher string The publisher ID.\r\nProtocolTypes\r\nEnumeration\r\nSpecifies the protocol of WinRM listener. Possible values are: http, https.\r\nValue Description\r\nHttp\r\nHttps\r\nProxyAgentSettings\r\nObject\r\nSpecifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.\r\nName Type Description\r\naddProxyAgentExtension boolean\r\nSpecify whether to implicitly install the ProxyAgent Extension. This\r\noption is currently applicable only for Linux Os.\r\nenabled boolean\r\nSpecifies whether ProxyAgent feature should be enabled on the virtual\r\nmachine or virtual machine scale set.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 39 of 65\n\nimds\r\nHostEndpoint\r\nSettings\r\nSpecifies the IMDS endpoint settings while creating the virtual machine\r\nor virtual machine scale set. Minimum api-version: 2024-03-01.\r\nkeyIncarnationId integer (int32)\r\nIncrease the value of this property allows users to reset the key used for\r\nsecuring communication channel between guest and host.\r\nmode Mode\r\nSpecifies the mode that ProxyAgent will execute on. Warning: this\r\nproperty has been deprecated, please specify 'mode' under particular\r\nhostendpoint setting.\r\nwireServer\r\nHostEndpoint\r\nSettings\r\nSpecifies the Wire Server endpoint settings while creating the virtual\r\nmachine or virtual machine scale set. Minimum api-version: 2024-03-01.\r\nPublicIPAddressSku\r\nObject\r\nDescribes the public IP Sku. It can only be set with OrchestrationMode as Flexible.\r\nName Type Description\r\nname PublicIPAddressSkuName Specify public IP sku name\r\ntier PublicIPAddressSkuTier Specify public IP sku tier\r\nPublicIPAddressSkuName\r\nEnumeration\r\nSpecify public IP sku name\r\nValue Description\r\nBasic\r\nStandard\r\nPublicIPAddressSkuTier\r\nEnumeration\r\nSpecify public IP sku tier\r\nValue Description\r\nRegional\r\nGlobal\r\nPublicIPAllocationMethod\r\nEnumeration\r\nSpecify the public IP allocation type\r\nValue Description\r\nDynamic\r\nStatic\r\nResourceIdentityType\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 40 of 65\n\nEnumeration\r\nThe type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly\r\ncreated identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.\r\nValue Description\r\nSystemAssigned\r\nUserAssigned\r\nSystemAssigned, UserAssigned\r\nNone\r\nScheduledEventsAdditionalPublishingTargets\r\nObject\r\nName Type Description\r\neventGridAndResourceGraph\r\nEventGridAnd\r\nResourceGraph\r\nThe configuration parameters used while creating\r\neventGridAndResourceGraph Scheduled Event setting.\r\nScheduledEventsPolicy\r\nObject\r\nSpecifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations.\r\nName Type Description\r\nallInstancesDown\r\nAllInstances\r\nDown\r\nThe configuration parameters used while creating\r\nAllInstancesDown scheduled event setting creation.\r\nscheduledEventsAdditionalPublishingTargets\r\nScheduled\r\nEvents\r\nAdditional\r\nPublishing\r\nTargets\r\nThe configuration parameters used while publishing\r\nscheduledEventsAdditionalPublishingTargets.\r\nuserInitiatedReboot\r\nUserInitiated\r\nReboot\r\nThe configuration parameters used while creating\r\nuserInitiatedReboot scheduled event setting creation.\r\nuserInitiatedRedeploy\r\nUserInitiated\r\nRedeploy\r\nThe configuration parameters used while creating\r\nuserInitiatedRedeploy scheduled event setting\r\ncreation.\r\nScheduledEventsProfile\r\nObject\r\nName Type Description\r\nosImageNotificationProfile\r\nOSImageNotification\r\nProfile\r\nSpecifies OS Image Scheduled Event related\r\nconfigurations.\r\nterminateNotificationProfile\r\nTerminateNotification\r\nProfile\r\nSpecifies Terminate Scheduled Event related\r\nconfigurations.\r\nSecurityEncryptionTypes\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 41 of 65\n\nEnumeration\r\nSpecifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk\r\nalong with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM\r\nfor not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.\r\nValue Description\r\nVMGuestStateOnly\r\nDiskWithVMGuestState\r\nNonPersistedTPM\r\nSecurityProfile\r\nObject\r\nSpecifies the Security profile settings for the virtual machine or virtual machine scale set.\r\nName Type Description\r\nencryptionAtHost boolean\r\nThis property can be used by user in the request to enable or disable the Host\r\nEncryption for the virtual machine or virtual machine scale set. This will enable\r\nthe encryption for all the disks including Resource/Temp disk at host itself. The\r\ndefault behavior is: The Encryption at host will be disabled unless this property\r\nis set to true for the resource.\r\nencryptionIdentity\r\nEncryption\r\nIdentity\r\nSpecifies the Managed Identity used by ADE to get access token for keyvault\r\noperations.\r\nproxyAgentSettings\r\nProxyAgent\r\nSettings\r\nSpecifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.\r\nsecurityType\r\nSecurity\r\nTypes\r\nSpecifies the SecurityType of the virtual machine. It has to be set to any\r\nspecified value to enable UefiSettings. The default behavior is: UefiSettings will\r\nnot be enabled unless this property is set.\r\nuefiSettings UefiSettings\r\nSpecifies the security settings like secure boot and vTPM used while creating\r\nthe virtual machine. Minimum api-version: 2020-12-01.\r\nSecurityTypes\r\nEnumeration\r\nSpecifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default\r\nbehavior is: UefiSettings will not be enabled unless this property is set.\r\nValue Description\r\nTrustedLaunch\r\nConfidentialVM\r\nSettingNames\r\nEnumeration\r\nSpecifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.\r\nValue Description\r\nAutoLogon\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 42 of 65\n\nFirstLogonCommands\r\nSshConfiguration\r\nObject\r\nSSH configuration for Linux based VMs running on Azure\r\nName Type Description\r\npublicKeys SshPublicKey[] The list of SSH public keys used to authenticate with linux based VMs.\r\nSshPublicKey\r\nObject\r\nContains information about SSH certificate public key and the path on the Linux VM where the public key is placed.\r\nName Type Description\r\nkeyData string\r\nSSH public key certificate used to authenticate with the VM through ssh. The key needs to be at\r\nleast 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and\r\nMac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).\r\npath string\r\nSpecifies the full path on the created VM where ssh public key is stored. If the file already exists,\r\nthe specified key is appended to the file. Example: /home/user/.ssh/authorized_keys\r\nStatusLevelTypes\r\nEnumeration\r\nThe level code.\r\nValue Description\r\nInfo\r\nWarning\r\nError\r\nStorageAccountTypes\r\nEnumeration\r\nSpecifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you\r\ncreate the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS\r\nuses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra\r\ndisk. Premium_ZRS uses Premium SSD zone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant\r\nstorage. For more information regarding disks supported for Windows Virtual Machines, refer to\r\nhttps://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to\r\nhttps://docs.microsoft.com/azure/virtual-machines/linux/disks-types\r\nValue Description\r\nStandard_LRS\r\nPremium_LRS\r\nStandardSSD_LRS\r\nUltraSSD_LRS\r\nPremium_ZRS\r\nStandardSSD_ZRS\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 43 of 65\n\nPremiumV2_LRS\r\nStorageProfile\r\nObject\r\nSpecifies the storage settings for the virtual machine disks.\r\nName Type Description\r\nalignRegionalDisksToVMZone boolean\r\nSpecifies whether the regional disks should be aligned/moved to the\r\nVM zone. This is applicable only for VMs with placement property\r\nset. Please note that this change is irreversible. Minimum api-version:\r\n2024-11-01.\r\ndataDisks DataDisk[]\r\nSpecifies the parameters that are used to add a data disk to a virtual\r\nmachine. For more information about disks, see About disks and\r\nVHDs for Azure virtual machines.\r\ndiskControllerType\r\nDisk\r\nController\r\nTypes\r\nSpecifies the disk controller type configured for the VM. Note: This\r\nproperty will be set to the default disk controller type if not specified\r\nprovided virtual machine is being created with 'hyperVGeneration' set\r\nto V2 based on the capabilities of the operating system disk and VM\r\nsize from the the specified minimum api version. You need to\r\ndeallocate the VM before updating its disk controller type unless you\r\nare updating the VM size in the VM configuration which implicitly\r\ndeallocates and reallocates the VM. Minimum api-version: 2022-08-\r\n01.\r\nimageReference\r\nImage\r\nReference\r\nSpecifies information about the image to use. You can specify\r\ninformation about platform images, marketplace images, or virtual\r\nmachine images. This element is required when you want to use a\r\nplatform image, marketplace image, or virtual machine image, but is\r\nnot used in other creation operations.\r\nosDisk OSDisk\r\nSpecifies information about the operating system disk used by the\r\nvirtual machine. For more information about disks, see About disks\r\nand VHDs for Azure virtual machines.\r\nSubResource\r\nObject\r\nName Type Description\r\nid string Resource Id\r\nsystemData\r\nObject\r\nMetadata pertaining to creation and last modification of the resource.\r\nName Type Description\r\ncreatedAt string (date-time) The timestamp of resource creation (UTC).\r\ncreatedBy string The identity that created the resource.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 44 of 65\n\ncreatedByType createdByType The type of identity that created the resource.\r\nlastModifiedAt string (date-time) The timestamp of resource last modification (UTC)\r\nlastModifiedBy string The identity that last modified the resource.\r\nlastModifiedByType createdByType The type of identity that last modified the resource.\r\nTerminateNotificationProfile\r\nObject\r\nName Type Description\r\nenable boolean Specifies whether the Terminate Scheduled event is enabled or disabled.\r\nnotBeforeTimeout string\r\nConfigurable length of time a Virtual Machine being deleted will have to potentially\r\napprove the Terminate Scheduled Event before the event is auto approved (timed out).\r\nThe configuration must be specified in ISO 8601 format, the default value is 5 minutes\r\n(PT5M)\r\nUefiSettings\r\nObject\r\nSpecifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version:\r\n2020-12-01.\r\nName Type Description\r\nsecureBootEnabled boolean\r\nSpecifies whether secure boot should be enabled on the virtual machine. Minimum\r\napi-version: 2020-12-01.\r\nvTpmEnabled boolean\r\nSpecifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01.\r\nUserInitiatedReboot\r\nObject\r\nSpecifies Reboot related Scheduled Event related configurations.\r\nName Type Description\r\nautomaticallyApprove boolean Specifies Reboot Scheduled Event related configurations.\r\nUserInitiatedRedeploy\r\nObject\r\nSpecifies Redeploy related Scheduled Event related configurations.\r\nName Type Description\r\nautomaticallyApprove boolean Specifies Redeploy Scheduled Event related configurations.\r\nVaultCertificate\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 45 of 65\n\nObject\r\nDescribes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.\r\nName Type Description\r\ncertificateStore string\r\nFor Windows VMs, specifies the certificate store on the Virtual Machine to which the\r\ncertificate should be added. The specified certificate store is implicitly in the LocalMachine\r\naccount. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory,\r\nwith the file name \u003cUppercaseThumbprint\u003e.crt for the X509 certificate file and\r\n\u003cUppercaseThumbprint\u003e.prv for private key. Both of these files are .pem formatted.\r\ncertificateUrl string\r\nThis is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a\r\nsecret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate\r\nneeds to be It is the Base64 encoding of the following JSON Object which is encoded in\r\nUTF-8:\r\n{\r\n\"data\":\"\u003cBase64-encoded-certificate\u003e\",\r\n\"dataType\":\"pfx\",\r\n\"password\":\"\u003cpfx-file-password\u003e\"\r\n}\r\nTo install certificates on a virtual machine it is recommended to use the Azure Key Vault\r\nvirtual machine extension for Linux or the Azure Key Vault virtual machine extension for\r\nWindows.\r\nVaultSecretGroup\r\nObject\r\nDescribes a set of certificates which are all in the same Key Vault.\r\nName Type Description\r\nsourceVault SubResource\r\nThe relative URL of the Key Vault containing all of the certificates in\r\nVaultCertificates.\r\nvaultCertificates\r\nVault\r\nCertificate[]\r\nThe list of key vault references in SourceVault which contain certificates.\r\nVirtualHardDisk\r\nObject\r\nDescribes the uri of a disk.\r\nName Type Description\r\nuri string Specifies the virtual hard disk's uri.\r\nVirtualMachine\r\nObject\r\nDescribes a Virtual Machine.\r\nName Type Description\r\netag string Etag is property returned in Create/Update/Get response of the VM, so that customer can supply\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 46 of 65\n\nextendedLocation\r\nExtended\r\nLocation\r\nThe extended location of the Virtual Machine.\r\nid string\r\nFully qualified resource ID for the resource. Ex -\r\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourcePro\r\nidentity\r\nVirtual\r\nMachine\r\nIdentity\r\nThe identity of the virtual machine, if configured.\r\nlocation string The geo-location where the resource lives\r\nmanagedBy string ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is par\r\nfor internal resource group delete optimization.\r\nname string The name of the resource\r\nplacement Placement\r\nPlacement section specifies the user-defined constraints for virtual machine hardware placemen\r\nprovisioned. Minimum api-version: 2024-11-01.\r\nplan Plan\r\nSpecifies information about the marketplace image used to create the virtual machine. This elem\r\nyou can use a marketplace image from an API, you must enable the image for programmatic us\r\nthat you want to use and then click Want to deploy programmatically, Get Started -\u003e. Enter\r\nproperties.additionalCapabilities\r\nAdditional\r\nCapabilities\r\nSpecifies additional capabilities enabled or disabled on the virtual machine.\r\nproperties.applicationProfile\r\nApplication\r\nProfile\r\nSpecifies the gallery applications that should be made available to the VM/VMSS.\r\nproperties.availabilitySet\r\nSub\r\nResource\r\nSpecifies information about the availability set that the virtual machine should be assigned to. V\r\nset are allocated to different nodes to maximize availability. For more information about availab\r\ninformation on Azure planned maintenance, see Maintenance and updates for Virtual Machines\r\navailability set at creation time. The availability set to which the VM is being added should be u\r\nresource. An existing VM cannot be added to an availability set. This property cannot exist alon\r\nproperties.virtualMachineScaleSet reference.\r\nproperties.billingProfile\r\nBilling\r\nProfile\r\nSpecifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 201\r\nproperties.capacityReservation\r\nCapacity\r\nReservation\r\nProfile\r\nSpecifies information about the capacity reservation that is used to allocate virtual machine. Mi\r\nproperties.diagnosticsProfile\r\nDiagnostics\r\nProfile\r\nSpecifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.\r\nproperties.evictionPolicy\r\nVirtual\r\nMachine\r\nEviction\r\nSpecifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For A\r\n'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, b\r\nminimum api-version is 2017-10-30-preview.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 47 of 65\n\nPolicy\r\nTypes\r\nproperties.extensionsTimeBudget string\r\nSpecifies the time alloted for all extensions to start. The time duration should be between 15 mi\r\nspecified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-versi\r\nproperties.hardwareProfile\r\nHardware\r\nProfile\r\nSpecifies the hardware settings for the virtual machine.\r\nproperties.host\r\nSub\r\nResource\r\nSpecifies information about the dedicated host that the virtual machine resides in. Minimum api\r\nproperties.hostGroup\r\nSub\r\nResource\r\nSpecifies information about the dedicated host group that the virtual machine resides in. Note: U\r\nproperties. Minimum api-version: 2020-06-01.\r\nproperties.instanceView\r\nVirtual\r\nMachine\r\nInstance\r\nView\r\nThe virtual machine instance view.\r\nproperties.licenseType string\r\nSpecifies that the image or disk that is being used was licensed on-premises.\r\nPossible values for Windows Server operating system are:\r\nWindows_Client\r\nWindows_Server\r\nPossible values for Linux Server operating system are:\r\nRHEL_BYOS (for RHEL)\r\nSLES_BYOS (for SUSE)\r\nFor more information, see Azure Hybrid Use Benefit for Windows Server\r\nAzure Hybrid Use Benefit for Linux Server\r\nMinimum api-version: 2015-06-15\r\nproperties.networkProfile\r\nNetwork\r\nProfile\r\nSpecifies the network interfaces of the virtual machine.\r\nproperties.osProfile OSProfile Specifies the operating system settings used while creating the virtual machine. Some of the set\r\nproperties.platformFaultDomain\r\ninteger\r\n(int32)\r\nSpecifies the scale set logical fault domain into which the Virtual Machine will be created. By d\r\nassigned to a fault domain that best maintains balance across available fault domains. This is ap\r\nproperty of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must h\r\nThis property cannot be updated once the Virtual Machine is created. Fault domain assignment\r\nView. Minimum api‐version: 2020‐12‐01.\r\nproperties.priority\r\nVirtual\r\nMachine\r\nPriority\r\nTypes\r\nSpecifies the priority for the virtual machine. Minimum api-version: 2019-03-01\r\nproperties.provisioningState string The provisioning state, which only appears in the response.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 48 of 65\n\nproperties.proximityPlacementGroup\r\nSub\r\nResource\r\nSpecifies information about the proximity placement group that the virtual machine should be a\r\nproperties.scheduledEventsPolicy\r\nScheduled\r\nEvents\r\nPolicy\r\nSpecifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Even\r\nproperties.scheduledEventsProfile\r\nScheduled\r\nEvents\r\nProfile\r\nSpecifies Scheduled Event related configurations.\r\nproperties.securityProfile\r\nSecurity\r\nProfile\r\nSpecifies the Security related profile settings for the virtual machine.\r\nproperties.storageProfile\r\nStorage\r\nProfile\r\nSpecifies the storage settings for the virtual machine disks.\r\nproperties.timeCreated\r\nstring\r\n(date-time)\r\nSpecifies the time at which the Virtual Machine resource was created. Minimum api-version: 20\r\nproperties.userData string UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in\r\nproperties.virtualMachineScaleSet\r\nSub\r\nResource\r\nSpecifies information about the virtual machine scale set that the virtual machine should be assi\r\nvirtual machine scale set are allocated to different nodes to maximize availability. Currently, a V\r\ncreation time. An existing VM cannot be added to a virtual machine scale set. This property can\r\nproperties.availabilitySet reference. Minimum api‐version: 2019‐03‐01.\r\nproperties.vmId string\r\nSpecifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azur\r\nplatform BIOS commands.\r\nresources\r\nVirtual\r\nMachine\r\nExtension[]\r\nThe virtual machine child extension resources.\r\nsystemData systemData Azure Resource Manager metadata containing createdBy and modifiedBy information.\r\ntags object Resource tags.\r\ntype string The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/stor\r\nzones string[] The availability zones.\r\nVirtualMachineAgentInstanceView\r\nObject\r\nThe instance view of the VM Agent running on the virtual machine.\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 49 of 65\n\nextensionHandlers\r\nVirtualMachineExtensionHandlerInstance\r\nView[]\r\nThe virtual machine extension handler instance\r\nview.\r\nstatuses InstanceViewStatus[] The resource status information.\r\nvmAgentVersion string The VM Agent full version.\r\nVirtualMachineEvictionPolicyTypes\r\nEnumeration\r\nSpecifies the eviction policy for the Azure Spot VM/VMSS\r\nValue Description\r\nDeallocate\r\nDelete\r\nVirtualMachineExtension\r\nObject\r\nDescribes a Virtual Machine Extension.\r\nName Type Description\r\nid string\r\nFully qualified resource ID for the resource. Ex -\r\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource\r\nlocation string The geo-location where the resource lives\r\nname string The name of the resource\r\nproperties.autoUpgradeMinorVersion boolean\r\nIndicates whether the extension should use a newer minor version if one is available at depl\r\nwill not upgrade minor versions unless redeployed, even with this property set to true.\r\nproperties.enableAutomaticUpgrade boolean Indicates whether the extension should be automatically upgraded by the platform if there is\r\nproperties.forceUpdateTag string How the extension handler should be forced to update even if the extension configuration ha\r\nproperties.instanceView\r\nVirtual\r\nMachine\r\nExtension\r\nInstance\r\nView\r\nThe virtual machine extension instance view.\r\nproperties.protectedSettings The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no\r\nproperties.protectedSettingsFromKeyVault\r\nKeyVault\r\nSecret\r\nReference\r\nThe extensions protected settings that are passed by reference, and consumed from key vaul\r\nproperties.provisionAfterExtensions string[] Collection of extension names after which this extension needs to be provisioned.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 50 of 65\n\nproperties.provisioningState string The provisioning state, which only appears in the response.\r\nproperties.publisher string The name of the extension handler publisher.\r\nproperties.settings Json formatted public settings for the extension.\r\nproperties.suppressFailures boolean\r\nIndicates whether failures stemming from the extension will be suppressed (Operational fail\r\nsuppressed regardless of this value). The default is false.\r\nproperties.type string Specifies the type of the extension; an example is \"CustomScriptExtension\".\r\nproperties.typeHandlerVersion string Specifies the version of the script handler.\r\nsystemData\r\nsystem\r\nData\r\nAzure Resource Manager metadata containing createdBy and modifiedBy information.\r\ntags object Resource tags.\r\ntype string The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/\r\nVirtualMachineExtensionHandlerInstanceView\r\nObject\r\nThe instance view of a virtual machine extension handler.\r\nName Type Description\r\nstatus\r\nInstanceView\r\nStatus\r\nThe extension handler status.\r\ntype string\r\nSpecifies the type of the extension; an example is\r\n\"CustomScriptExtension\".\r\ntypeHandlerVersion string Specifies the version of the script handler.\r\nVirtualMachineExtensionInstanceView\r\nObject\r\nThe instance view of a virtual machine extension.\r\nName Type Description\r\nname string The virtual machine extension name.\r\nstatuses\r\nInstanceView\r\nStatus[]\r\nThe resource status information.\r\nsubstatuses\r\nInstanceView\r\nStatus[]\r\nThe resource status information.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 51 of 65\n\ntype string\r\nSpecifies the type of the extension; an example is\r\n\"CustomScriptExtension\".\r\ntypeHandlerVersion string Specifies the version of the script handler.\r\nVirtualMachineHealthStatus\r\nObject\r\nThe health status of the VM.\r\nName Type Description\r\nstatus InstanceViewStatus The health status information for the VM.\r\nVirtualMachineIdentity\r\nObject\r\nIdentity for the virtual machine.\r\nName Type Description\r\nprincipalId string The principal id of virtual machine identity. This property will only be provided for a system assigned identity.\r\ntenantId string The tenant id associated with the virtual machine. This property will only be provided for a system assigned iden\r\ntype\r\nResource\r\nIdentity\r\nType\r\nThe type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an im\r\nuser assigned identities. The type 'None' will remove any identities from the virtual machine.\r\nuserAssignedIdentities\r\n\u003cstring, \r\nCommon.\r\nUser\r\nAssigned\r\nIdentities\r\nValue\u003e\r\nThe list of user identities associated with the Virtual Machine. The user identity dictionary key references will b\r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/u\r\nVirtualMachineInstanceView\r\nObject\r\nThe instance view of a virtual machine.\r\nName Type Description\r\nassignedHost string\r\nResource id of the dedicated host, on which the virtual machine is\r\nallocated through automatic placement, when the virtual machine\r\nis associated with a dedicated host group that has automatic\r\nplacement enabled. Minimum api-version: 2020-06-01.\r\nbootDiagnostics\r\nBootDiagnostics\r\nInstanceView\r\nBoot Diagnostics is a debugging feature which allows you to view\r\nConsole Output and Screenshot to diagnose VM status. You can\r\neasily view the output of your console log. Azure also enables you\r\nto see a screenshot of the VM from the hypervisor.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 52 of 65\n\ncomputerName string The computer name assigned to the virtual machine.\r\ndisks\r\nDiskInstance\r\nView[]\r\nThe virtual machine disk information.\r\nextensions\r\nVirtualMachine\r\nExtensionInstance\r\nView[]\r\nThe extensions information.\r\nhyperVGeneration\r\nHyper\r\nVGenerationType\r\nSpecifies the HyperVGeneration Type associated with a resource\r\nisVMInStandbyPool boolean\r\n[Preview Feature] Specifies whether the VM is currently in or out\r\nof the Standby Pool.\r\nmaintenanceRedeployStatus\r\nMaintenance\r\nRedeployStatus\r\nThe Maintenance Operation status on the virtual machine.\r\nosName string The Operating System running on the virtual machine.\r\nosVersion string The version of Operating System running on the virtual machine.\r\npatchStatus\r\nVirtualMachine\r\nPatchStatus\r\n[Preview Feature] The status of virtual machine patch operations.\r\nplatformFaultDomain integer (int32) Specifies the fault domain of the virtual machine.\r\nplatformUpdateDomain integer (int32) Specifies the update domain of the virtual machine.\r\nrdpThumbPrint string The Remote desktop certificate thumbprint.\r\nstatuses\r\nInstanceView\r\nStatus[]\r\nThe resource status information.\r\nvmAgent\r\nVirtualMachine\r\nAgentInstance\r\nView\r\nThe VM Agent running on the virtual machine.\r\nvmHealth\r\nVirtualMachine\r\nHealthStatus\r\nThe health status for the VM.\r\nVirtualMachineIpTag\r\nObject\r\nContains the IP tag associated with the public IP address.\r\nName Type Description\r\nipTagType string IP tag type. Example: FirstPartyUsage.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 53 of 65\n\ntag string IP tag associated with the public IP. Example: SQL, Storage etc.\r\nVirtualMachineNetworkInterfaceConfiguration\r\nObject\r\nDescribes a virtual machine network interface configurations.\r\nName Type Description\r\nname string The network interface configuration name.\r\nproperties.auxiliaryMode\r\nNetworkInterface\r\nAuxiliaryMode\r\nSpecifies whether the Auxiliary mode is\r\nenabled for the Network Interface resource.\r\nproperties.auxiliarySku\r\nNetworkInterface\r\nAuxiliarySku\r\nSpecifies whether the Auxiliary sku is\r\nenabled for the Network Interface resource.\r\nproperties.deleteOption DeleteOptions\r\nSpecify what happens to the network\r\ninterface when the VM is deleted\r\nproperties.disableTcpStateTracking boolean\r\nSpecifies whether the network interface is\r\ndisabled for tcp state tracking.\r\nproperties.dnsSettings\r\nVirtualMachineNetwork\r\nInterfaceDnsSettings\r\nConfiguration\r\nThe dns settings to be applied on the network\r\ninterfaces.\r\nproperties.dscpConfiguration SubResource\r\nproperties.enableAcceleratedNetworking boolean\r\nSpecifies whether the network interface is\r\naccelerated networking-enabled.\r\nproperties.enableFpga boolean\r\nSpecifies whether the network interface is\r\nFPGA networking-enabled.\r\nproperties.enableIPForwarding boolean Whether IP forwarding enabled on this NIC.\r\nproperties.ipConfigurations\r\nVirtualMachineNetwork\r\nInterface\r\nIPConfiguration[]\r\nSpecifies the IP configurations of the network\r\ninterface.\r\nproperties.networkSecurityGroup SubResource The network security group.\r\nproperties.primary boolean\r\nSpecifies the primary network interface in\r\ncase the virtual machine has more than 1\r\nnetwork interface.\r\ntags object\r\nResource tags applied to the networkInterface\r\naddress created by this\r\nNetworkInterfaceConfiguration\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 54 of 65\n\nVirtualMachineNetworkInterfaceDnsSettingsConfiguration\r\nObject\r\nDescribes a virtual machines network configuration's DNS settings.\r\nName Type Description\r\ndnsServers string[] List of DNS servers IP addresses\r\nVirtualMachineNetworkInterfaceIPConfiguration\r\nObject\r\nDescribes a virtual machine network profile's IP configuration.\r\nName Type Description\r\nname string The IP configuration name.\r\nproperties.applicationGatewayBackendAddressPools SubResource[]\r\nSpecifies an array of references to backend\r\naddress pools of application gateways. A\r\nvirtual machine can reference backend\r\naddress pools of multiple application\r\ngateways. Multiple virtual machines cannot\r\nuse the same application gateway.\r\nproperties.applicationSecurityGroups SubResource[]\r\nSpecifies an array of references to\r\napplication security group.\r\nproperties.loadBalancerBackendAddressPools SubResource[]\r\nSpecifies an array of references to backend\r\naddress pools of load balancers. A virtual\r\nmachine can reference backend address\r\npools of one public and one internal load\r\nbalancer. [Multiple virtual machines cannot\r\nuse the same basic sku load balancer].\r\nproperties.primary boolean\r\nSpecifies the primary network interface in\r\ncase the virtual machine has more than 1\r\nnetwork interface.\r\nproperties.privateIPAddressVersion IPVersions\r\nAvailable from Api-Version 2017-03-30\r\nonwards, it represents whether the specific\r\nipconfiguration is IPv4 or IPv6. Default is\r\ntaken as IPv4. Possible values are: 'IPv4'\r\nand 'IPv6'.\r\nproperties.publicIPAddressConfiguration\r\nVirtualMachine\r\nPublic\r\nIPAddress\r\nConfiguration\r\nThe publicIPAddressConfiguration.\r\nproperties.subnet SubResource Specifies the identifier of the subnet.\r\nVirtualMachinePatchStatus\r\nObject\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 55 of 65\n\nThe status of virtual machine patch operations.\r\nName Type Description\r\navailablePatchSummary\r\nAvailablePatch\r\nSummary\r\nThe available patch summary of the latest assessment\r\noperation for the virtual machine.\r\nconfigurationStatuses InstanceViewStatus[] The enablement status of the specified patchMode\r\nlastPatchInstallationSummary\r\nLastPatchInstallation\r\nSummary\r\nThe installation summary of the latest installation operation\r\nfor the virtual machine.\r\nVirtualMachinePriorityTypes\r\nEnumeration\r\nSpecifies the priority for a standalone virtual machine or the virtual machines in the scale set. 'Low' enum will be deprecated\r\nin the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.\r\nValue Description\r\nRegular\r\nLow\r\nSpot\r\nVirtualMachinePublicIPAddressConfiguration\r\nObject\r\nDescribes a virtual machines IP Configuration's PublicIPAddress configuration\r\nName Type Description\r\nname string The publicIP address configuration name.\r\nproperties.deleteOption DeleteOptions\r\nSpecify what happens to the public IP address when\r\nthe VM is deleted\r\nproperties.dnsSettings\r\nVirtualMachine\r\nPublicIPAddressDns\r\nSettings\r\nConfiguration\r\nThe dns settings to be applied on the publicIP\r\naddresses .\r\nproperties.idleTimeoutInMinutes integer (int32) The idle timeout of the public IP address.\r\nproperties.ipTags\r\nVirtualMachine\r\nIpTag[]\r\nThe list of IP tags associated with the public IP\r\naddress.\r\nproperties.publicIPAddressVersion IPVersions\r\nAvailable from Api-Version 2019-07-01 onwards, it\r\nrepresents whether the specific ipconfiguration is IPv4\r\nor IPv6. Default is taken as IPv4. Possible values are:\r\n'IPv4' and 'IPv6'.\r\nproperties.publicIPAllocationMethod\r\nPublicIPAllocation\r\nMethod\r\nSpecify the public IP allocation type\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 56 of 65\n\nproperties.publicIPPrefix SubResource\r\nThe PublicIPPrefix from which to allocate publicIP\r\naddresses.\r\nsku PublicIPAddressSku\r\nDescribes the public IP Sku. It can only be set with\r\nOrchestrationMode as Flexible.\r\ntags object\r\nResource tags applied to the publicIP address created\r\nby this PublicIPAddressConfiguration\r\nVirtualMachinePublicIPAddressDnsSettingsConfiguration\r\nObject\r\nDescribes a virtual machines network configuration's DNS settings.\r\nName Type Description\r\ndomainNameLabel string\r\nThe Domain name label prefix of the PublicIPAddress resources that will\r\nbe created. The generated name label is the concatenation of the domain\r\nname label and vm network profile unique ID.\r\ndomainNameLabelScope\r\nDomain\r\nNameLabel\r\nScopeTypes\r\nThe Domain name label scope of the PublicIPAddress resources that will\r\nbe created. The generated name label is the concatenation of the hashed\r\ndomain name label with policy according to the domain name label scope\r\nand vm network profile unique ID.\r\nVirtualMachineSizeTypes\r\nEnumeration\r\nSpecifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd\r\n2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in\r\nan availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing.\r\nFor more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region\r\nand availability set.\r\nValue Description\r\nBasic_A0\r\nBasic_A1\r\nBasic_A2\r\nBasic_A3\r\nBasic_A4\r\nStandard_A0\r\nStandard_A1\r\nStandard_A2\r\nStandard_A3\r\nStandard_A4\r\nStandard_A5\r\nStandard_A6\r\nStandard_A7\r\nStandard_A8\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 57 of 65\n\nStandard_A9\r\nStandard_A10\r\nStandard_A11\r\nStandard_A1_v2\r\nStandard_A2_v2\r\nStandard_A4_v2\r\nStandard_A8_v2\r\nStandard_A2m_v2\r\nStandard_A4m_v2\r\nStandard_A8m_v2\r\nStandard_B1s\r\nStandard_B1ms\r\nStandard_B2s\r\nStandard_B2ms\r\nStandard_B4ms\r\nStandard_B8ms\r\nStandard_D1\r\nStandard_D2\r\nStandard_D3\r\nStandard_D4\r\nStandard_D11\r\nStandard_D12\r\nStandard_D13\r\nStandard_D14\r\nStandard_D1_v2\r\nStandard_D2_v2\r\nStandard_D3_v2\r\nStandard_D4_v2\r\nStandard_D5_v2\r\nStandard_D2_v3\r\nStandard_D4_v3\r\nStandard_D8_v3\r\nStandard_D16_v3\r\nStandard_D32_v3\r\nStandard_D64_v3\r\nStandard_D2s_v3\r\nStandard_D4s_v3\r\nStandard_D8s_v3\r\nStandard_D16s_v3\r\nStandard_D32s_v3\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 58 of 65\n\nStandard_D64s_v3\r\nStandard_D11_v2\r\nStandard_D12_v2\r\nStandard_D13_v2\r\nStandard_D14_v2\r\nStandard_D15_v2\r\nStandard_DS1\r\nStandard_DS2\r\nStandard_DS3\r\nStandard_DS4\r\nStandard_DS11\r\nStandard_DS12\r\nStandard_DS13\r\nStandard_DS14\r\nStandard_DS1_v2\r\nStandard_DS2_v2\r\nStandard_DS3_v2\r\nStandard_DS4_v2\r\nStandard_DS5_v2\r\nStandard_DS11_v2\r\nStandard_DS12_v2\r\nStandard_DS13_v2\r\nStandard_DS14_v2\r\nStandard_DS15_v2\r\nStandard_DS13-4_v2\r\nStandard_DS13-2_v2\r\nStandard_DS14-8_v2\r\nStandard_DS14-4_v2\r\nStandard_E2_v3\r\nStandard_E4_v3\r\nStandard_E8_v3\r\nStandard_E16_v3\r\nStandard_E32_v3\r\nStandard_E64_v3\r\nStandard_E2s_v3\r\nStandard_E4s_v3\r\nStandard_E8s_v3\r\nStandard_E16s_v3\r\nStandard_E32s_v3\r\nStandard_E64s_v3\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 59 of 65\n\nStandard_E32-16_v3\r\nStandard_E32-8s_v3\r\nStandard_E64-32s_v3\r\nStandard_E64-16s_v3\r\nStandard_F1\r\nStandard_F2\r\nStandard_F4\r\nStandard_F8\r\nStandard_F16\r\nStandard_F1s\r\nStandard_F2s\r\nStandard_F4s\r\nStandard_F8s\r\nStandard_F16s\r\nStandard_F2s_v2\r\nStandard_F4s_v2\r\nStandard_F8s_v2\r\nStandard_F16s_v2\r\nStandard_F32s_v2\r\nStandard_F64s_v2\r\nStandard_F72s_v2\r\nStandard_G1\r\nStandard_G2\r\nStandard_G3\r\nStandard_G4\r\nStandard_G5\r\nStandard_GS1\r\nStandard_GS2\r\nStandard_GS3\r\nStandard_GS4\r\nStandard_GS5\r\nStandard_GS4-8\r\nStandard_GS4-4\r\nStandard_GS5-16\r\nStandard_GS5-8\r\nStandard_H8\r\nStandard_H16\r\nStandard_H8m\r\nStandard_H16m\r\nStandard_H16r\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 60 of 65\n\nStandard_H16mr\r\nStandard_L4s\r\nStandard_L8s\r\nStandard_L16s\r\nStandard_L32s\r\nStandard_M64s\r\nStandard_M64ms\r\nStandard_M128s\r\nStandard_M128ms\r\nStandard_M64-32ms\r\nStandard_M64-16ms\r\nStandard_M128-64ms\r\nStandard_M128-32ms\r\nStandard_NC6\r\nStandard_NC12\r\nStandard_NC24\r\nStandard_NC24r\r\nStandard_NC6s_v2\r\nStandard_NC12s_v2\r\nStandard_NC24s_v2\r\nStandard_NC24rs_v2\r\nStandard_NC6s_v3\r\nStandard_NC12s_v3\r\nStandard_NC24s_v3\r\nStandard_NC24rs_v3\r\nStandard_ND6s\r\nStandard_ND12s\r\nStandard_ND24s\r\nStandard_ND24rs\r\nStandard_NV6\r\nStandard_NV12\r\nStandard_NV24\r\nVMDiskSecurityProfile\r\nObject\r\nSpecifies the security profile settings for the managed disk. Note: It can only be set for Confidential VMs.\r\nName Type Description\r\ndiskEncryptionSet\r\nDisk\r\nEncryption\r\nSet\r\nParameters\r\nSpecifies the customer managed disk encryption set resource id for the\r\nmanaged disk that is used for Customer Managed Key encrypted\r\nConfidentialVM OS Disk and VMGuest blob.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 61 of 65\n\nsecurityEncryptionType\r\nSecurity\r\nEncryption\r\nTypes\r\nSpecifies the EncryptionType of the managed disk. It is set to\r\nDiskWithVMGuestState for encryption of the managed disk along with\r\nVMGuestState blob, VMGuestStateOnly for encryption of just the\r\nVMGuestState blob, and NonPersistedTPM for not persisting firmware\r\nstate in the VMGuestState blob.. Note: It can be set for only Confidential\r\nVMs.\r\nVMGalleryApplication\r\nObject\r\nSpecifies the required information to reference a compute gallery application version\r\nName Type Description\r\nconfigurationReference string Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if\r\nenableAutomaticUpgrade boolean If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically u\r\norder\r\ninteger\r\n(int32)\r\nOptional, Specifies the order in which the packages have to be installed\r\npackageReferenceId string\r\nSpecifies the GalleryApplicationVersion resource id on the form of\r\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute\r\ntags string Optional, Specifies a passthrough value for more generic context.\r\ntreatFailureAsDeploymentFailure boolean Optional, If true, any failure for any operation in the VmApplication will fail the deployment\r\nVMSizeProperties\r\nObject\r\nSpecifies VM Size Property settings on the virtual machine.\r\nName Type Description\r\nvCPUsAvailable\r\ninteger\r\n(int32)\r\nSpecifies the number of vCPUs available for the VM. When this property is not\r\nspecified in the request body the default behavior is to set it to the value of vCPUs\r\navailable for that VM size exposed in api response of List all available virtual machine\r\nsizes in a region.\r\nvCPUsPerCore\r\ninteger\r\n(int32)\r\nSpecifies the vCPU to physical core ratio. When this property is not specified in the\r\nrequest body the default behavior is set to the value of vCPUsPerCore for the VM Size\r\nexposed in api response of List all available virtual machine sizes in a region. Setting\r\nthis property to 1 also means that hyper-threading is disabled.\r\nWindowsConfiguration\r\nObject\r\nSpecifies Windows operating system settings on the virtual machine.\r\nName Type Description\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 62 of 65\n\nadditionalUnattendContent\r\nAdditional\r\nUnattendContent[]\r\nSpecifies additional base-64 encoded XML formatted\r\ninformation that can be included in the Unattend.xml file,\r\nwhich is used by Windows Setup.\r\nenableAutomaticUpdates boolean\r\nIndicates whether Automatic Updates is enabled for the\r\nWindows virtual machine. Default value is true. For virtual\r\nmachine scale sets, this property can be updated and updates\r\nwill take effect on OS reprovisioning.\r\nenableVMAgentPlatformUpdates boolean\r\nIndicates whether VMAgent Platform Updates are enabled\r\nfor the Windows Virtual Machine.\r\npatchSettings PatchSettings\r\n[Preview Feature] Specifies settings related to VM Guest\r\nPatching on Windows.\r\nprovisionVMAgent boolean\r\nIndicates whether virtual machine agent should be\r\nprovisioned on the virtual machine. When this property is\r\nnot specified in the request body, it is set to true by default.\r\nThis will ensure that VM Agent is installed on the VM so\r\nthat extensions can be added to the VM later.\r\ntimeZone string\r\nSpecifies the time zone of the virtual machine. e.g. \"Pacific\r\nStandard Time\". Possible values can be TimeZoneInfo.Id\r\nvalue from time zones returned by\r\nTimeZoneInfo.GetSystemTimeZones.\r\nwinRM\r\nWin\r\nRMConfiguration\r\nSpecifies the Windows Remote Management listeners. This\r\nenables remote Windows PowerShell.\r\nWindowsPatchAssessmentMode\r\nEnumeration\r\nSpecifies the mode of VM Guest patch assessment for the IaaS virtual machine.\r\nPossible values are:\r\nImageDefault - You control the timing of patch assessments on a virtual machine.\r\nAutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be\r\ntrue.\r\nValue Description\r\nImageDefault\r\nAutomaticByPlatform\r\nWindowsVMGuestPatchAutomaticByPlatformRebootSetting\r\nEnumeration\r\nSpecifies the reboot setting for all AutomaticByPlatform patch installation operations.\r\nValue Description\r\nUnknown\r\nIfRequired\r\nNever\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 63 of 65\n\nAlways\r\nWindowsVMGuestPatchAutomaticByPlatformSettings\r\nObject\r\nSpecifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings.\r\nName Type Description\r\nbypassPlatformSafetyChecksOnUserSchedule boolean\r\nEnables customer to schedule patching\r\nwithout accidental upgrades\r\nrebootSetting\r\nWindowsVMGuestPatch\r\nAutomaticByPlatform\r\nRebootSetting\r\nSpecifies the reboot setting for all\r\nAutomaticByPlatform patch installation\r\noperations.\r\nWindowsVMGuestPatchMode\r\nEnumeration\r\nSpecifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set\r\nwith OrchestrationMode as Flexible.\r\nPossible values are:\r\nManual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the\r\nVM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be\r\nfalse\r\nAutomaticByOS - The virtual machine will automatically be updated by the OS. The property\r\nWindowsConfiguration.enableAutomaticUpdates must be true.\r\nAutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent\r\nand WindowsConfiguration.enableAutomaticUpdates must be true\r\nValue Description\r\nManual\r\nAutomaticByOS\r\nAutomaticByPlatform\r\nWinRMConfiguration\r\nObject\r\nDescribes Windows Remote Management configuration of the VM\r\nName Type Description\r\nlisteners WinRMListener[] The list of Windows Remote Management listeners\r\nWinRMListener\r\nObject\r\nDescribes Protocol and thumbprint of Windows Remote Management listener\r\nZonePlacementPolicyType\r\nEnumeration\r\nSpecifies the policy for resource's placement in availability zone. Possible values are: Any (used for Virtual Machines),\r\nAuto (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource\r\ncreation.\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 64 of 65\n\nValue Description\r\nAny\r\nAuto Automatic zone placement in a Virtual Machine Scale Set.\r\nSource: https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nhttps://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get\r\nPage 65 of 65",
	"extraction_quality": 1,
	"language": "EN",
	"sources": [
		"MITRE"
	],
	"references": [
		"https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines/get"
	],
	"report_names": [
		"get"
	],
	"threat_actors": [],
	"ts_created_at": 1775434754,
	"ts_updated_at": 1775791234,
	"ts_creation_date": 0,
	"ts_modification_date": 0,
	"files": {
		"pdf": "https://archive.orkl.eu/0700fce473a7925e2e766d0bf2dc13af5edaaec1.pdf",
		"text": "https://archive.orkl.eu/0700fce473a7925e2e766d0bf2dc13af5edaaec1.txt",
		"img": "https://archive.orkl.eu/0700fce473a7925e2e766d0bf2dc13af5edaaec1.jpg"
	}
}