你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Virtual Machines - List
Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines?api-version=2024-07-01GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines?$filter={$filter}&$expand=instanceView&api-version=2024-07-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string |
The name of the resource group. |
|
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
api-version
|
query | True |
string |
Client Api Version. |
|
$expand
|
query |
The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified |
||
|
$filter
|
query |
string |
The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}' |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
|
Virtual |
|
Virtual |
VirtualMachine_List_MaximumSet_Gen
Sample request
Sample response
{
"value": [
{
"properties": {
"vmId": "{vmId}",
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hardwareProfile": {
"vmSize": "Standard_A0",
"vmSizeProperties": {
"vCPUsAvailable": 7,
"vCPUsPerCore": 14
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20170406",
"exactVersion": "aaaaaaaaaaaaa",
"sharedGalleryImageId": "aaaaaaaaaaaaaaa",
"communityGalleryImageId": "aaaa",
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"osDisk": {
"osType": "Windows",
"name": "test",
"createOption": "FromImage",
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"caching": "None",
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"securityProfile": {
"securityEncryptionType": "VMGuestStateOnly",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
},
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
},
"deleteOption": "Delete"
},
"dataDisks": []
},
"osProfile": {
"computerName": "Test",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"customData": "aaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaaaaaaaaaaaaaaaaaaaaa",
"keyData": "aaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"requireGuestProvisionSignal": true
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2022-05-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"disableTcpStateTracking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaaaaaaaaaaaaaa"
]
},
"ipConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 23,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"publicIPAllocationMethod": "Dynamic"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"dscpConfiguration": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
}
}
]
},
"provisioningState": "Succeeded",
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaaaaaaaaaa"
}
},
"virtualMachineScaleSet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"priority": "Regular",
"evictionPolicy": "Deallocate",
"billingProfile": {
"maxPrice": 26
},
"host": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hostGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"licenseType": "aaaaaaaaaaaaaaa",
"extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"platformFaultDomain": 8,
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
},
"osImageNotificationProfile": {
"notBeforeTimeout": "PT15M",
"enable": true
}
},
"userData": "aaa",
"capacityReservation": {
"capacityReservationGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"applicationProfile": {
"galleryApplications": [
{
"tags": "aaaaa",
"order": 4,
"packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
"configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
},
"timeCreated": "2022-01-14T16:43:41.683Z"
},
"type": "Microsoft.Compute/virtualMachines",
"location": "eastus",
"tags": {},
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
"name": "{virtualMachineName}",
"plan": {
"name": "aaaaaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaa"
},
"resources": [
{
"properties": {
"forceUpdateTag": "aaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaa",
"type": "aaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaa",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {},
"protectedSettings": {},
"provisioningState": "aaa",
"instanceView": {
"name": "aaaaaaaaaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaaa",
"substatuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
],
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
},
"suppressFailures": true,
"protectedSettingsFromKeyVault": {
"sourceVault": {
"id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
},
"secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
}
},
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"name": "aaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"location": "aaaaaaaaaaaaaaaa",
"tags": {
"key9428": "aaaaaaa"
}
}
],
"identity": {
"principalId": "aaaaaaaaaaaaaaaa",
"tenantId": "aaaaa",
"type": "SystemAssigned",
"userAssignedIdentities": {
"key5688": {
"principalId": "aaaaaaaaaaaaaaa",
"clientId": "aaaaaaaaaaa"
}
}
},
"zones": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaa"
],
"extendedLocation": {
"name": "aaaa",
"type": "EdgeZone"
}
},
{
"properties": {
"vmId": "{vmId}",
"availabilitySet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hardwareProfile": {
"vmSize": "Standard_A0",
"vmSizeProperties": {
"vCPUsAvailable": 7,
"vCPUsPerCore": 14
}
},
"storageProfile": {
"imageReference": {
"publisher": "MicrosoftWindowsServer",
"offer": "WindowsServer",
"sku": "2012-R2-Datacenter",
"version": "4.127.20170406",
"exactVersion": "aa",
"sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaa",
"communityGalleryImageId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"id": "aaaaaaaa"
},
"osDisk": {
"osType": "Windows",
"name": "test",
"createOption": "FromImage",
"vhd": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"caching": "None",
"diskSizeGB": 127,
"encryptionSettings": {
"diskEncryptionKey": {
"secretUrl": "aaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
},
"image": {
"uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
},
"writeAcceleratorEnabled": true,
"diffDiskSettings": {
"option": "Local",
"placement": "CacheDisk"
},
"managedDisk": {
"storageAccountType": "Standard_LRS",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"securityProfile": {
"securityEncryptionType": "VMGuestStateOnly",
"diskEncryptionSet": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
},
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/testingexcludedisk_OsDisk_1_74cdaedcea50483d9833c96adefa100f"
},
"deleteOption": "Delete"
},
"dataDisks": []
},
"osProfile": {
"computerName": "Test",
"adminUsername": "Foo12",
"windowsConfiguration": {
"provisionVMAgent": true,
"enableAutomaticUpdates": true,
"timeZone": "aaaaaaaaaaaaaaaaaaaa",
"additionalUnattendContent": [
{
"passName": "OobeSystem",
"componentName": "Microsoft-Windows-Shell-Setup",
"settingName": "AutoLogon",
"content": "aaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"patchSettings": {
"patchMode": "Manual",
"enableHotpatching": true,
"assessmentMode": "ImageDefault"
},
"winRM": {
"listeners": [
{
"protocol": "Http",
"certificateUrl": "aaaaaaaaaaaaaaaaaaaaa"
}
]
}
},
"secrets": [],
"allowExtensionOperations": true,
"customData": "aaaaaaaaaaaaaaaaaaaaaaa",
"linuxConfiguration": {
"disablePasswordAuthentication": true,
"ssh": {
"publicKeys": [
{
"path": "aaaaaaaaaaaaaaaaaaaaaa",
"keyData": "aaa"
}
]
},
"provisionVMAgent": true,
"patchSettings": {
"patchMode": "ImageDefault",
"assessmentMode": "ImageDefault"
}
},
"requireGuestProvisionSignal": true
},
"networkProfile": {
"networkInterfaces": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}",
"properties": {
"primary": true,
"deleteOption": "Delete"
}
}
],
"networkApiVersion": "2022-05-01",
"networkInterfaceConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"primary": true,
"deleteOption": "Delete",
"enableAcceleratedNetworking": true,
"disableTcpStateTracking": true,
"enableFpga": true,
"enableIPForwarding": true,
"networkSecurityGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"dnsSettings": {
"dnsServers": [
"aaaaaaaaaaaaaaaaaaaaaaaa"
]
},
"ipConfigurations": [
{
"name": "aaaaaaaa",
"properties": {
"subnet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"primary": true,
"publicIPAddressConfiguration": {
"name": "aaaaaaaaaaaaaaaaaa",
"properties": {
"idleTimeoutInMinutes": 23,
"deleteOption": "Delete",
"dnsSettings": {
"domainNameLabel": "aaaaa"
},
"ipTags": [
{
"ipTagType": "aaaaa",
"tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
],
"publicIPPrefix": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"publicIPAddressVersion": "IPv4",
"publicIPAllocationMethod": "Dynamic"
},
"sku": {
"name": "Basic",
"tier": "Regional"
}
},
"privateIPAddressVersion": "IPv4",
"applicationSecurityGroups": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"applicationGatewayBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
],
"loadBalancerBackendAddressPools": [
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
]
}
}
],
"dscpConfiguration": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
}
}
]
},
"provisioningState": "Succeeded",
"additionalCapabilities": {
"ultraSSDEnabled": true,
"hibernationEnabled": true
},
"securityProfile": {
"uefiSettings": {
"secureBootEnabled": true,
"vTpmEnabled": true
},
"encryptionAtHost": true,
"securityType": "TrustedLaunch"
},
"diagnosticsProfile": {
"bootDiagnostics": {
"enabled": true,
"storageUri": "aaaaaaaaaaaaaaaaaaaaa"
}
},
"virtualMachineScaleSet": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"proximityPlacementGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"priority": "Regular",
"evictionPolicy": "Deallocate",
"billingProfile": {
"maxPrice": 26
},
"host": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"hostGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
},
"instanceView": {
"platformUpdateDomain": 1,
"platformFaultDomain": 29,
"computerName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"osName": "aaaaaaaaaaa",
"osVersion": "aaaaaaaaaaaaaa",
"hyperVGeneration": "V1",
"rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaa",
"vmAgent": {
"vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"extensionHandlers": [
{
"type": "aaaaa",
"typeHandlerVersion": "aaaaaaaaaaaaaaaaaaa",
"status": {
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
}
],
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
},
"maintenanceRedeployStatus": {
"isCustomerInitiatedMaintenanceAllowed": true,
"preMaintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
"preMaintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
"maintenanceWindowStartTime": "2022-01-14T16:43:41.682Z",
"maintenanceWindowEndTime": "2022-01-14T16:43:41.682Z",
"lastOperationResultCode": "None",
"lastOperationMessage": "aa"
},
"disks": [
{
"name": "a",
"encryptionSettings": [
{
"diskEncryptionKey": {
"secretUrl": "aaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"keyEncryptionKey": {
"keyUrl": "aaaaaaaaaaaaa",
"sourceVault": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"enabled": true
}
],
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
}
],
"extensions": [
{
"name": "aaaaaaaaaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaaa",
"substatuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
],
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
}
],
"vmHealth": {
"status": {
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
},
"bootDiagnostics": {
"consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaa",
"serialConsoleLogBlobUri": "aaaaaaaaaaaaaaaaaaa",
"status": {
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
},
"assignedHost": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
],
"patchStatus": {
"availablePatchSummary": {
"status": "Unknown",
"assessmentActivityId": "aaaaaaaaaaaaaaaaaaa",
"rebootPending": true,
"criticalAndSecurityPatchCount": 22,
"otherPatchCount": 25,
"startTime": "2022-01-14T16:43:41.682Z",
"lastModifiedTime": "2022-01-14T16:43:41.683Z",
"error": {
"details": [
{
"code": "aaaaaaaaaaaaaaaaaaaaa",
"target": "aaaaaa",
"message": "aaaaaaaaaaaaa"
}
],
"innererror": {
"exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"code": "aaaaaa",
"target": "aaaaaaaaa",
"message": "aaa"
}
},
"lastPatchInstallationSummary": {
"status": "Unknown",
"installationActivityId": "aaaaaa",
"maintenanceWindowExceeded": true,
"notSelectedPatchCount": 20,
"excludedPatchCount": 1,
"pendingPatchCount": 2,
"installedPatchCount": 28,
"failedPatchCount": 30,
"startTime": "2022-01-14T16:43:41.683Z",
"lastModifiedTime": "2022-01-14T16:43:41.683Z",
"error": {
"details": [
{
"code": "aaaaaaaaaaaaaaaaaaaaa",
"target": "aaaaaa",
"message": "aaaaaaaaaaaaa"
}
],
"innererror": {
"exceptiontype": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"errordetail": "aaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
"code": "aaaaaa",
"target": "aaaaaaaaa",
"message": "aaa"
}
},
"configurationStatuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
},
"isVMInStandbyPool": false
},
"licenseType": "aaaaaaaaaaaaaa",
"extensionsTimeBudget": "aaaaaaaaaaaaaaaaaaaaaa",
"platformFaultDomain": 11,
"scheduledEventsProfile": {
"terminateNotificationProfile": {
"notBeforeTimeout": "PT10M",
"enable": true
},
"osImageNotificationProfile": {
"notBeforeTimeout": "PT15M",
"enable": true
}
},
"userData": "aaaaaaaaaaaaaaaaaaa",
"capacityReservation": {
"capacityReservationGroup": {
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
}
},
"applicationProfile": {
"galleryApplications": [
{
"tags": "aaaaa",
"order": 4,
"packageReferenceId": "aaaaaaaaaaaaaaaaaaaaaa",
"configurationReference": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
},
"timeCreated": "2022-01-14T16:43:41.685Z"
},
"type": "Microsoft.Compute/virtualMachines",
"location": "eastus",
"tags": {},
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
"name": "{virtualMachineName}",
"plan": {
"name": "aaaaaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaaa",
"product": "aaaaaaaaaaaaaaaaaaaaaa",
"promotionCode": "aaaaaaaaaaaaaa"
},
"resources": [
{
"properties": {
"forceUpdateTag": "aaaaaaaaaaaaaaa",
"publisher": "aaaaaaaaaaaaaaaa",
"type": "aaaaaaaa",
"typeHandlerVersion": "aaaaaaaaaaaa",
"autoUpgradeMinorVersion": true,
"enableAutomaticUpgrade": true,
"settings": {},
"protectedSettings": {},
"provisioningState": "aaa",
"instanceView": {
"name": "aaaaaaaaaaaaaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaa",
"typeHandlerVersion": "aaaaaa",
"substatuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
],
"statuses": [
{
"code": "aaa",
"level": "Info",
"displayStatus": "aaaaaaaaaaaaaaaaaaaaaaaa",
"message": "aaaaaaaaaaaaaaaaaaa",
"time": "2022-01-14T16:43:41.657Z"
}
]
},
"suppressFailures": true,
"protectedSettingsFromKeyVault": {
"sourceVault": {
"id": "/subscriptions/a53f7094-a16c-47af-abe4-b05c05d0d79a/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/kvName"
},
"secretUrl": "https://kvName.vault.azure.net/secrets/secretName/79b88b3a6f5440ffb2e73e44a0db712e"
}
},
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"name": "aaaaaaaaaaaaa",
"type": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
"location": "aaaaaaaaaaaaaaaa",
"tags": {
"key9428": "aaaaaaa"
}
}
],
"identity": {
"principalId": "aaaaaaaaaaaaaaaa",
"tenantId": "aaaaa",
"type": "SystemAssigned",
"userAssignedIdentities": {
"key5688": {
"principalId": "aaaaaaaaaaaaaaa",
"clientId": "aaaaaaaaaaa"
}
}
},
"zones": [
"aaaaaa"
],
"extendedLocation": {
"name": "aaaa",
"type": "EdgeZone"
}
}
],
"nextLink": "a"
}VirtualMachine_List_MinimumSet_Gen
Sample request
Sample response
{
"value": [
{
"location": "eastus",
"id": "/subscriptions/{subscriptionId}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}"
},
{
"location": "eastus",
"id": "/subscriptions/{subscriptionId}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}"
}
]
}Definitions
| Name | Description |
|---|---|
|
Additional |
Specifies additional capabilities enabled or disabled on the virtual machine. |
|
Additional |
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. |
|
Api |
The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. |
|
Api |
Api error. |
|
Api |
Api error base. |
|
Application |
Specifies the gallery applications that should be made available to the VM/VMSS. |
|
Available |
The available patch summary of the latest assessment operation for the virtual machine. |
|
Billing |
Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. |
|
Boot |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. |
|
Boot |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. |
|
Caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. |
|
Capacity |
Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. |
|
Cloud |
An error response from the Compute service. |
|
Component |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
Data |
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. |
|
Delete |
Specify what happens to the network interface when the VM is deleted |
|
Diagnostics |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
|
Diff |
Specifies the ephemeral disk settings for operating system disk. |
|
Diff |
Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. |
|
Diff |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
|
Disk |
Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. |
|
Disk |
Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. |
|
Disk |
Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. |
|
Disk |
Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. |
|
Disk |
Specifies the customer managed disk encryption set resource id for the managed disk. |
|
Disk |
Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. |
|
Disk |
The virtual machine disk information. |
|
Domain |
The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. |
|
Encryption |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
|
Event |
The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. |
|
Expand |
The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified |
|
Extended |
The extended location of the Virtual Machine. |
|
Extended |
The type of the extended location. |
|
Hardware |
Specifies the hardware settings for the virtual machine. |
|
Hyper |
Specifies the HyperVGeneration Type associated with a resource |
|
Image |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. |
|
Inner |
Inner error details. |
|
Instance |
Instance view status. |
| IPVersions |
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
Key |
Specifies the location of the key encryption key in Key Vault. |
|
Key |
The extensions protected settings that are passed by reference, and consumed from key vault |
|
Last |
The installation summary of the latest installation operation for the virtual machine. |
|
Linux |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
|
Linux |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
|
Linux |
[Preview Feature] Specifies settings related to VM Guest Patching on Linux. |
|
Linux |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
|
Linux |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. |
|
Linux |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
|
Maintenance |
The Last Maintenance Operation Result Code. |
|
Maintenance |
The Maintenance Operation status on the virtual machine. |
|
Managed |
The managed disk parameters. |
| Mode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. |
|
Network |
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations |
|
Network |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
|
Network |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
|
Network |
Specifies the list of resource Ids for the network interfaces associated with the virtual machine. |
|
Network |
Specifies the network interfaces of the virtual machine. |
|
Operating |
The Operating System type. |
| OSDisk |
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. |
|
OSImage |
Specifies OS Image Scheduled Event related configurations. |
| OSProfile |
Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. |
|
Pass |
The pass name. Currently, the only allowable value is OobeSystem. |
|
Patch |
The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." |
|
Patch |
[Preview Feature] Specifies settings related to VM Guest Patching on Windows. |
| Plan |
Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save. |
|
Protocol |
Specifies the protocol of WinRM listener. Possible values are: http, https. |
|
Proxy |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
|
Public |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
|
Public |
Specify public IP sku name |
|
Public |
Specify public IP sku tier |
|
Public |
Specify the public IP allocation type |
|
Resource |
The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. |
|
Scheduled |
The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. |
|
Scheduled |
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. |
|
Scheduled |
Specifies Scheduled Event related configurations. |
|
security |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. |
|
Security |
Specifies the Security related profile settings for the virtual machine. |
|
Security |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. |
|
Setting |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
|
Ssh |
Specifies the ssh key configuration for a Linux OS. |
|
Ssh |
The list of SSH public keys used to authenticate with linux based VMs. |
|
Status |
The level code. |
|
Storage |
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. |
|
Storage |
Specifies the storage settings for the virtual machine disks. |
|
Sub |
The relative URL of the Key Vault containing the secret. |
|
Terminate |
Specifies Terminate Scheduled Event related configurations. |
|
Uefi |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
|
User |
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
|
User |
The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. |
|
User |
The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. |
|
Vault |
The list of key vault references in SourceVault which contain certificates. |
|
Vault |
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
|
Virtual |
The virtual hard disk. |
|
Virtual |
The list of virtual machines. |
|
Virtual |
The VM Agent running on the virtual machine. |
|
Virtual |
Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. |
|
Virtual |
The virtual machine child extension resources. |
|
Virtual |
The virtual machine extension handler instance view. |
|
Virtual |
The virtual machine extension instance view. |
|
Virtual |
The health status for the VM. |
|
Virtual |
The identity of the virtual machine, if configured. |
|
Virtual |
The virtual machine instance view. |
|
Virtual |
The list of IP tags associated with the public IP address. |
|
Virtual |
The List Virtual Machine operation response. |
|
Virtual |
Specifies the networking configurations that will be used to create the virtual machine networking resources. |
|
Virtual |
The dns settings to be applied on the network interfaces. |
|
Virtual |
Specifies the IP configurations of the network interface. |
|
Virtual |
[Preview Feature] The status of virtual machine patch operations. |
|
Virtual |
Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 |
|
Virtual |
The publicIPAddressConfiguration. |
|
Virtual |
The dns settings to be applied on the publicIP addresses . |
|
Virtual |
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. |
|
VMDisk |
Specifies the security profile for the managed disk. |
|
VMGallery |
Specifies the gallery applications that should be made available to the VM/VMSS |
|
VMSize |
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details. |
|
Windows |
Specifies Windows operating system settings on the virtual machine. |
|
Windows |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
|
Windows |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
|
Windows |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. |
|
Windows |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
|
Win |
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. |
|
Win |
The list of Windows Remote Management listeners |
AdditionalCapabilities
Specifies additional capabilities enabled or disabled on the virtual machine.
| Name | Type | Description |
|---|---|---|
| hibernationEnabled |
boolean |
The flag that enables or disables hibernation capability on the VM. |
| ultraSSDEnabled |
boolean |
The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. |
AdditionalUnattendContent
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
| Name | Type | Description |
|---|---|---|
| componentName |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
| content |
string |
Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. |
| passName |
The pass name. Currently, the only allowable value is OobeSystem. |
|
| settingName |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. |
ApiEntityReference
The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk.
| Name | Type | Description |
|---|---|---|
| id |
string |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
ApiError
Api error.
| Name | Type | Description |
|---|---|---|
| code |
string |
The error code. |
| details |
The Api error details |
|
| innererror |
The Api inner error |
|
| message |
string |
The error message. |
| target |
string |
The target of the particular error. |
ApiErrorBase
Api error base.
| Name | Type | Description |
|---|---|---|
| code |
string |
The error code. |
| message |
string |
The error message. |
| target |
string |
The target of the particular error. |
ApplicationProfile
Specifies the gallery applications that should be made available to the VM/VMSS.
| Name | Type | Description |
|---|---|---|
| galleryApplications |
Specifies the gallery applications that should be made available to the VM/VMSS |
AvailablePatchSummary
The available patch summary of the latest assessment operation for the virtual machine.
| Name | Type | Description |
|---|---|---|
| assessmentActivityId |
string |
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
| criticalAndSecurityPatchCount |
integer |
The number of critical or security patches that have been detected as available and not yet installed. |
| error |
The errors that were encountered during execution of the operation. The details array contains the list of them. |
|
| lastModifiedTime |
string |
The UTC timestamp when the operation began. |
| otherPatchCount |
integer |
The number of all available patches excluding critical and security. |
| rebootPending |
boolean |
The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. |
| startTime |
string |
The UTC timestamp when the operation began. |
| status |
The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." |
BillingProfile
Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01.
| Name | Type | Description |
|---|---|---|
| maxPrice |
number |
Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars. |
BootDiagnostics
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Whether boot diagnostics should be enabled on the Virtual Machine. |
| storageUri |
string |
Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. |
BootDiagnosticsInstanceView
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor.
| Name | Type | Description |
|---|---|---|
| consoleScreenshotBlobUri |
string |
The console screenshot blob URI. Note: This will not be set if boot diagnostics is currently enabled with managed storage. |
| serialConsoleLogBlobUri |
string |
The serial console log blob Uri. Note: This will not be set if boot diagnostics is currently enabled with managed storage. |
| status |
The boot diagnostics status information for the VM. Note: It will be set only if there are errors encountered in enabling boot diagnostics. |
CachingTypes
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage.
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| ReadOnly |
string |
|
| ReadWrite |
string |
CapacityReservationProfile
Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01.
| Name | Type | Description |
|---|---|---|
| capacityReservationGroup |
Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. |
CloudError
An error response from the Compute service.
| Name | Type | Description |
|---|---|---|
| error |
Api error. |
ComponentNames
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
| Name | Type | Description |
|---|---|---|
| Microsoft-Windows-Shell-Setup |
string |
DataDisk
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. |
|
| createOption |
Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. Empty: This value is used when creating an empty data disk. Copy: This value is used to create a data disk from a snapshot or another disk. Restore: This value is used to create a data disk from a disk restore point. |
|
| deleteOption |
Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the data disk is deleted when VM is deleted. Detach. If this value is used, the data disk is retained after VM is deleted. The default value is set to Detach. |
|
| detachOption |
Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. |
|
| diskIOPSReadWrite |
integer |
Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. |
| diskMBpsReadWrite |
integer |
Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. |
| diskSizeGB |
integer |
Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. |
| image |
The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. |
|
| lun |
integer |
Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. |
| managedDisk |
The managed disk parameters. |
|
| name |
string |
The disk name. |
| sourceResource |
The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. |
|
| toBeDetached |
boolean |
Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset |
| vhd |
The virtual hard disk. |
|
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
DeleteOptions
Specify what happens to the network interface when the VM is deleted
| Name | Type | Description |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiagnosticsProfile
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
| Name | Type | Description |
|---|---|---|
| bootDiagnostics |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. NOTE: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. |
DiffDiskOptions
Specifies the ephemeral disk settings for operating system disk.
| Name | Type | Description |
|---|---|---|
| Local |
string |
DiffDiskPlacement
Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01.
| Name | Type | Description |
|---|---|---|
| CacheDisk |
string |
|
| NvmeDisk |
string |
|
| ResourceDisk |
string |
DiffDiskSettings
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
| Name | Type | Description |
|---|---|---|
| option |
Specifies the ephemeral disk settings for operating system disk. |
|
| placement |
Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. |
DiskControllerTypes
Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01.
| Name | Type | Description |
|---|---|---|
| NVMe |
string |
|
| SCSI |
string |
DiskCreateOptionTypes
Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described.
| Name | Type | Description |
|---|---|---|
| Attach |
string |
|
| Copy |
string |
|
| Empty |
string |
|
| FromImage |
string |
|
| Restore |
string |
DiskDeleteOptionTypes
Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk.
| Name | Type | Description |
|---|---|---|
| Delete |
string |
|
| Detach |
string |
DiskDetachOptionTypes
Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. detachOption: ForceDetach is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'.
| Name | Type | Description |
|---|---|---|
| ForceDetach |
string |
DiskEncryptionSetParameters
Specifies the customer managed disk encryption set resource id for the managed disk.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
DiskEncryptionSettings
Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15.
| Name | Type | Description |
|---|---|---|
| diskEncryptionKey |
Specifies the location of the disk encryption key, which is a Key Vault Secret. |
|
| enabled |
boolean |
Specifies whether disk encryption should be enabled on the virtual machine. |
| keyEncryptionKey |
Specifies the location of the key encryption key in Key Vault. |
DiskInstanceView
The virtual machine disk information.
| Name | Type | Description |
|---|---|---|
| encryptionSettings |
Specifies the encryption settings for the OS Disk. |
|
| name |
string |
The disk name. |
| statuses |
The resource status information. |
DomainNameLabelScopeTypes
The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID.
| Name | Type | Description |
|---|---|---|
| NoReuse |
string |
|
| ResourceGroupReuse |
string |
|
| SubscriptionReuse |
string |
|
| TenantReuse |
string |
EncryptionIdentity
Specifies the Managed Identity used by ADE to get access token for keyvault operations.
| Name | Type | Description |
|---|---|---|
| userAssignedIdentityResourceId |
string |
Specifies ARM Resource ID of one of the user identities associated with the VM. |
EventGridAndResourceGraph
The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting.
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies if event grid and resource graph is enabled for Scheduled event related configurations. |
ExpandTypeForListVMs
The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified
| Name | Type | Description |
|---|---|---|
| instanceView |
string |
ExtendedLocation
The extended location of the Virtual Machine.
| Name | Type | Description |
|---|---|---|
| name |
string |
The name of the extended location. |
| type |
The type of the extended location. |
ExtendedLocationTypes
The type of the extended location.
| Name | Type | Description |
|---|---|---|
| EdgeZone |
string |
HardwareProfile
Specifies the hardware settings for the virtual machine.
| Name | Type | Description |
|---|---|---|
| vmSize |
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. |
|
| vmSizeProperties |
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details. |
HyperVGenerationType
Specifies the HyperVGeneration Type associated with a resource
| Name | Type | Description |
|---|---|---|
| V1 |
string |
|
| V2 |
string |
ImageReference
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.
| Name | Type | Description |
|---|---|---|
| communityGalleryImageId |
string |
Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. |
| exactVersion |
string |
Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. |
| id |
string |
Resource Id |
| offer |
string |
Specifies the offer of the platform image or marketplace image used to create the virtual machine. |
| publisher |
string |
The image publisher. |
| sharedGalleryImageId |
string |
Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. |
| sku |
string |
The image SKU. |
| version |
string |
Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. |
InnerError
Inner error details.
| Name | Type | Description |
|---|---|---|
| errordetail |
string |
The internal error message or exception dump. |
| exceptiontype |
string |
The exception type. |
InstanceViewStatus
Instance view status.
| Name | Type | Description |
|---|---|---|
| code |
string |
The status code. |
| displayStatus |
string |
The short localizable label for the status. |
| level |
The level code. |
|
| message |
string |
The detailed status message, including for alerts and error messages. |
| time |
string |
The time of the status. |
IPVersions
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.
| Name | Type | Description |
|---|---|---|
| IPv4 |
string |
|
| IPv6 |
string |
KeyVaultKeyReference
Specifies the location of the key encryption key in Key Vault.
| Name | Type | Description |
|---|---|---|
| keyUrl |
string |
The URL referencing a key encryption key in Key Vault. |
| sourceVault |
The relative URL of the Key Vault containing the key. |
KeyVaultSecretReference
The extensions protected settings that are passed by reference, and consumed from key vault
| Name | Type | Description |
|---|---|---|
| secretUrl |
string |
The URL referencing a secret in a Key Vault. |
| sourceVault |
The relative URL of the Key Vault containing the secret. |
LastPatchInstallationSummary
The installation summary of the latest installation operation for the virtual machine.
| Name | Type | Description |
|---|---|---|
| error |
The errors that were encountered during execution of the operation. The details array contains the list of them. |
|
| excludedPatchCount |
integer |
The number of all available patches but excluded explicitly by a customer-specified exclusion list match. |
| failedPatchCount |
integer |
The count of patches that failed installation. |
| installationActivityId |
string |
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
| installedPatchCount |
integer |
The count of patches that successfully installed. |
| lastModifiedTime |
string |
The UTC timestamp when the operation began. |
| maintenanceWindowExceeded |
boolean |
Describes whether the operation ran out of time before it completed all its intended actions |
| notSelectedPatchCount |
integer |
The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. |
| pendingPatchCount |
integer |
The number of all available patches expected to be installed over the course of the patch installation operation. |
| startTime |
string |
The UTC timestamp when the operation began. |
| status |
The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." |
LinuxConfiguration
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions.
| Name | Type | Description |
|---|---|---|
| disablePasswordAuthentication |
boolean |
Specifies whether password authentication should be disabled. |
| enableVMAgentPlatformUpdates |
boolean |
Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. |
| patchSettings |
[Preview Feature] Specifies settings related to VM Guest Patching on Linux. |
|
| provisionVMAgent |
boolean |
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
| ssh |
Specifies the ssh key configuration for a Linux OS. |
LinuxPatchAssessmentMode
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.
Possible values are:
ImageDefault - You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
LinuxPatchSettings
[Preview Feature] Specifies settings related to VM Guest Patching on Linux.
| Name | Type | Description |
|---|---|---|
| assessmentMode |
Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine. |
|
| automaticByPlatformSettings |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. |
|
| patchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
LinuxVMGuestPatchAutomaticByPlatformRebootSetting
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
| Name | Type | Description |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
LinuxVMGuestPatchAutomaticByPlatformSettings
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux.
| Name | Type | Description |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Enables customer to schedule patching without accidental upgrades |
| rebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
LinuxVMGuestPatchMode
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
ImageDefault - The virtual machine's default patching configuration is used.
AutomaticByPlatform - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
MaintenanceOperationResultCodeTypes
The Last Maintenance Operation Result Code.
| Name | Type | Description |
|---|---|---|
| MaintenanceAborted |
string |
|
| MaintenanceCompleted |
string |
|
| None |
string |
|
| RetryLater |
string |
MaintenanceRedeployStatus
The Maintenance Operation status on the virtual machine.
| Name | Type | Description |
|---|---|---|
| isCustomerInitiatedMaintenanceAllowed |
boolean |
True, if customer is allowed to perform Maintenance. |
| lastOperationMessage |
string |
Message returned for the last Maintenance Operation. |
| lastOperationResultCode |
The Last Maintenance Operation Result Code. |
|
| maintenanceWindowEndTime |
string |
End Time for the Maintenance Window. |
| maintenanceWindowStartTime |
string |
Start Time for the Maintenance Window. |
| preMaintenanceWindowEndTime |
string |
End Time for the Pre Maintenance Window. |
| preMaintenanceWindowStartTime |
string |
Start Time for the Pre Maintenance Window. |
ManagedDiskParameters
The managed disk parameters.
| Name | Type | Description |
|---|---|---|
| diskEncryptionSet |
Specifies the customer managed disk encryption set resource id for the managed disk. |
|
| id |
string |
Resource Id |
| securityProfile |
Specifies the security profile for the managed disk. |
|
| storageAccountType |
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. |
Mode
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode.
| Name | Type | Description |
|---|---|---|
| Audit |
string |
|
| Enforce |
string |
NetworkApiVersion
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations
| Name | Type | Description |
|---|---|---|
| 2020-11-01 |
string |
NetworkInterfaceAuxiliaryMode
Specifies whether the Auxiliary mode is enabled for the Network Interface resource.
| Name | Type | Description |
|---|---|---|
| AcceleratedConnections |
string |
|
| Floating |
string |
|
| None |
string |
NetworkInterfaceAuxiliarySku
Specifies whether the Auxiliary sku is enabled for the Network Interface resource.
| Name | Type | Description |
|---|---|---|
| A1 |
string |
|
| A2 |
string |
|
| A4 |
string |
|
| A8 |
string |
|
| None |
string |
NetworkInterfaceReference
Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| properties.deleteOption |
Specify what happens to the network interface when the VM is deleted |
|
| properties.primary |
boolean |
Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
NetworkProfile
Specifies the network interfaces of the virtual machine.
| Name | Type | Description |
|---|---|---|
| networkApiVersion |
specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations |
|
| networkInterfaceConfigurations |
Specifies the networking configurations that will be used to create the virtual machine networking resources. |
|
| networkInterfaces |
Specifies the list of resource Ids for the network interfaces associated with the virtual machine. |
OperatingSystemTypes
The Operating System type.
| Name | Type | Description |
|---|---|---|
| Linux |
string |
|
| Windows |
string |
OSDisk
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. |
|
| createOption |
Specifies how the virtual machine disk should be created. Possible values are Attach: This value is used when you are using a specialized disk to create the virtual machine. FromImage: This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. |
|
| deleteOption |
Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete. If this value is used, the OS disk is deleted when VM is deleted. Detach. If this value is used, the os disk is retained after VM is deleted. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. |
|
| diffDiskSettings |
Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. |
|
| diskSizeGB |
integer |
Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. |
| encryptionSettings |
Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. |
|
| image |
The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. |
|
| managedDisk |
The managed disk parameters. |
|
| name |
string |
The disk name. |
| osType |
This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. |
|
| vhd |
The virtual hard disk. |
|
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
OSImageNotificationProfile
Specifies OS Image Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies whether the OS Image Scheduled event is enabled or disabled. |
| notBeforeTimeout |
string |
Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) |
OSProfile
Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned.
| Name | Type | Description |
|---|---|---|
| adminPassword |
string |
Specifies the password of the administrator account. |
| adminUsername |
string |
Specifies the name of the administrator account. |
| allowExtensionOperations |
boolean |
Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. |
| computerName |
string |
Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. Max-length (Windows): 15 characters. Max-length (Linux): 64 characters. For naming conventions and restrictions see Azure infrastructure services implementation guidelines. |
| customData |
string |
Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. Note: Do not pass any secrets or passwords in customData property. This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs. For using cloud-init for your Linux VM, see Using cloud-init to customize a Linux VM during creation. |
| linuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions. |
|
| requireGuestProvisionSignal |
boolean |
Optional property which must either be set to True or omitted. |
| secrets |
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows. |
|
| windowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
PassNames
The pass name. Currently, the only allowable value is OobeSystem.
| Name | Type | Description |
|---|---|---|
| OobeSystem |
string |
PatchOperationStatus
The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings."
| Name | Type | Description |
|---|---|---|
| CompletedWithWarnings |
string |
|
| Failed |
string |
|
| InProgress |
string |
|
| Succeeded |
string |
|
| Unknown |
string |
PatchSettings
[Preview Feature] Specifies settings related to VM Guest Patching on Windows.
| Name | Type | Description |
|---|---|---|
| assessmentMode |
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine. |
|
| automaticByPlatformSettings |
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. |
|
| enableHotpatching |
boolean |
Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. |
| patchMode |
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible. |
Plan
Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
| Name | Type | Description |
|---|---|---|
| name |
string |
The plan ID. |
| product |
string |
Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. |
| promotionCode |
string |
The promotion code. |
| publisher |
string |
The publisher ID. |
ProtocolTypes
Specifies the protocol of WinRM listener. Possible values are: http, https.
| Name | Type | Description |
|---|---|---|
| Http |
string |
|
| Https |
string |
ProxyAgentSettings
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.
| Name | Type | Description |
|---|---|---|
| enabled |
boolean |
Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. |
| keyIncarnationId |
integer |
Increase the value of this property allows user to reset the key used for securing communication channel between guest and host. |
| mode |
Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode. |
PublicIPAddressSku
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
| Name | Type | Description |
|---|---|---|
| name |
Specify public IP sku name |
|
| tier |
Specify public IP sku tier |
PublicIPAddressSkuName
Specify public IP sku name
| Name | Type | Description |
|---|---|---|
| Basic |
string |
|
| Standard |
string |
PublicIPAddressSkuTier
Specify public IP sku tier
| Name | Type | Description |
|---|---|---|
| Global |
string |
|
| Regional |
string |
PublicIPAllocationMethod
Specify the public IP allocation type
| Name | Type | Description |
|---|---|---|
| Dynamic |
string |
|
| Static |
string |
ResourceIdentityType
The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.
| Name | Type | Description |
|---|---|---|
| None |
string |
|
| SystemAssigned |
string |
|
| SystemAssigned, UserAssigned |
string |
|
| UserAssigned |
string |
ScheduledEventsAdditionalPublishingTargets
The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets.
| Name | Type | Description |
|---|---|---|
| eventGridAndResourceGraph |
The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. |
ScheduledEventsPolicy
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine.
| Name | Type | Description |
|---|---|---|
| scheduledEventsAdditionalPublishingTargets |
The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. |
|
| userInitiatedReboot |
The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. |
|
| userInitiatedRedeploy |
The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. |
ScheduledEventsProfile
Specifies Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| osImageNotificationProfile |
Specifies OS Image Scheduled Event related configurations. |
|
| terminateNotificationProfile |
Specifies Terminate Scheduled Event related configurations. |
securityEncryptionTypes
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs.
| Name | Type | Description |
|---|---|---|
| DiskWithVMGuestState |
string |
|
| NonPersistedTPM |
string |
|
| VMGuestStateOnly |
string |
SecurityProfile
Specifies the Security related profile settings for the virtual machine.
| Name | Type | Description |
|---|---|---|
| encryptionAtHost |
boolean |
This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. |
| encryptionIdentity |
Specifies the Managed Identity used by ADE to get access token for keyvault operations. |
|
| proxyAgentSettings |
Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. |
|
| securityType |
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. |
|
| uefiSettings |
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. |
SecurityTypes
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.
| Name | Type | Description |
|---|---|---|
| ConfidentialVM |
string |
|
| TrustedLaunch |
string |
SettingNames
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
| Name | Type | Description |
|---|---|---|
| AutoLogon |
string |
|
| FirstLogonCommands |
string |
SshConfiguration
Specifies the ssh key configuration for a Linux OS.
| Name | Type | Description |
|---|---|---|
| publicKeys |
The list of SSH public keys used to authenticate with linux based VMs. |
SshPublicKey
The list of SSH public keys used to authenticate with linux based VMs.
| Name | Type | Description |
|---|---|---|
| keyData |
string |
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
| path |
string |
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys |
StatusLevelTypes
The level code.
| Name | Type | Description |
|---|---|---|
| Error |
string |
|
| Info |
string |
|
| Warning |
string |
StorageAccountTypes
Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.
| Name | Type | Description |
|---|---|---|
| PremiumV2_LRS |
string |
|
| Premium_LRS |
string |
|
| Premium_ZRS |
string |
|
| StandardSSD_LRS |
string |
|
| StandardSSD_ZRS |
string |
|
| Standard_LRS |
string |
|
| UltraSSD_LRS |
string |
StorageProfile
Specifies the storage settings for the virtual machine disks.
| Name | Type | Description |
|---|---|---|
| dataDisks |
Data |
Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. |
| diskControllerType |
Specifies the disk controller type configured for the VM. Note: This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. |
|
| imageReference |
Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. |
|
| osDisk |
Specifies information about the operating system disk used by the virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines. |
SubResource
The relative URL of the Key Vault containing the secret.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
TerminateNotificationProfile
Specifies Terminate Scheduled Event related configurations.
| Name | Type | Description |
|---|---|---|
| enable |
boolean |
Specifies whether the Terminate Scheduled event is enabled or disabled. |
| notBeforeTimeout |
string |
Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) |
UefiSettings
Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.
| Name | Type | Description |
|---|---|---|
| secureBootEnabled |
boolean |
Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. |
| vTpmEnabled |
boolean |
Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. |
UserAssignedIdentities
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
| Name | Type | Description |
|---|---|---|
|
|
UserInitiatedReboot
The configuration parameters used while creating userInitiatedReboot scheduled event setting creation.
| Name | Type | Description |
|---|---|---|
| automaticallyApprove |
boolean |
Specifies Reboot Scheduled Event related configurations. |
UserInitiatedRedeploy
The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation.
| Name | Type | Description |
|---|---|---|
| automaticallyApprove |
boolean |
Specifies Redeploy Scheduled Event related configurations. |
VaultCertificate
The list of key vault references in SourceVault which contain certificates.
| Name | Type | Description |
|---|---|---|
| certificateStore |
string |
For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. |
| certificateUrl |
string |
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
VaultSecretGroup
Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the Azure Key Vault virtual machine extension for Linux or the Azure Key Vault virtual machine extension for Windows.
| Name | Type | Description |
|---|---|---|
| sourceVault |
The relative URL of the Key Vault containing all of the certificates in VaultCertificates. |
|
| vaultCertificates |
The list of key vault references in SourceVault which contain certificates. |
VirtualHardDisk
The virtual hard disk.
| Name | Type | Description |
|---|---|---|
| uri |
string |
Specifies the virtual hard disk's uri. |
VirtualMachine
The list of virtual machines.
| Name | Type | Description |
|---|---|---|
| etag |
string |
Etag is property returned in Create/Update/Get response of the VM, so that customer can supply it in the header to ensure optimistic updates. |
| extendedLocation |
The extended location of the Virtual Machine. |
|
| id |
string |
Resource Id |
| identity |
The identity of the virtual machine, if configured. |
|
| location |
string |
Resource location |
| managedBy |
string |
ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization. |
| name |
string |
Resource name |
| plan |
Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save. |
|
| properties.additionalCapabilities |
Specifies additional capabilities enabled or disabled on the virtual machine. |
|
| properties.applicationProfile |
Specifies the gallery applications that should be made available to the VM/VMSS. |
|
| properties.availabilitySet |
Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Availability sets overview. For more information on Azure planned maintenance, see Maintenance and updates for Virtual Machines in Azure. Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set. This property cannot exist along with a non-null properties.virtualMachineScaleSet reference. |
|
| properties.billingProfile |
Specifies the billing related details of a Azure Spot virtual machine. Minimum api-version: 2019-03-01. |
|
| properties.capacityReservation |
Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum api-version: 2021-04-01. |
|
| properties.diagnosticsProfile |
Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. |
|
| properties.evictionPolicy |
Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. |
|
| properties.extensionsTimeBudget |
string |
Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. |
| properties.hardwareProfile |
Specifies the hardware settings for the virtual machine. |
|
| properties.host |
Specifies information about the dedicated host that the virtual machine resides in. Minimum api-version: 2018-10-01. |
|
| properties.hostGroup |
Specifies information about the dedicated host group that the virtual machine resides in. Note: User cannot specify both host and hostGroup properties. Minimum api-version: 2020-06-01. |
|
| properties.instanceView |
The virtual machine instance view. |
|
| properties.licenseType |
string |
Specifies that the image or disk that is being used was licensed on-premises. |
| properties.networkProfile |
Specifies the network interfaces of the virtual machine. |
|
| properties.osProfile |
Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. |
|
| properties.platformFaultDomain |
integer |
Specifies the scale set logical fault domain into which the Virtual Machine will be created. By default, the Virtual Machine will by automatically assigned to a fault domain that best maintains balance across available fault domains. This is applicable only if the 'virtualMachineScaleSet' property of this Virtual Machine is set. The Virtual Machine Scale Set that is referenced, must have 'platformFaultDomainCount' greater than 1. This property cannot be updated once the Virtual Machine is created. Fault domain assignment can be viewed in the Virtual Machine Instance View. Minimum api‐version: 2020‐12‐01. |
| properties.priority |
Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01 |
|
| properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
| properties.proximityPlacementGroup |
Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01. |
|
| properties.scheduledEventsPolicy |
Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. |
|
| properties.scheduledEventsProfile |
Specifies Scheduled Event related configurations. |
|
| properties.securityProfile |
Specifies the Security related profile settings for the virtual machine. |
|
| properties.storageProfile |
Specifies the storage settings for the virtual machine disks. |
|
| properties.timeCreated |
string |
Specifies the time at which the Virtual Machine resource was created. Minimum api-version: 2021-11-01. |
| properties.userData |
string |
UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. |
| properties.virtualMachineScaleSet |
Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set. This property cannot exist along with a non-null properties.availabilitySet reference. Minimum api‐version: 2019‐03‐01. |
|
| properties.vmId |
string |
Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands. |
| resources |
The virtual machine child extension resources. |
|
| tags |
object |
Resource tags |
| type |
string |
Resource type |
| zones |
string[] |
The virtual machine zones. |
VirtualMachineAgentInstanceView
The VM Agent running on the virtual machine.
| Name | Type | Description |
|---|---|---|
| extensionHandlers |
The virtual machine extension handler instance view. |
|
| statuses |
The resource status information. |
|
| vmAgentVersion |
string |
The VM Agent full version. |
VirtualMachineEvictionPolicyTypes
Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview.
| Name | Type | Description |
|---|---|---|
| Deallocate |
string |
|
| Delete |
string |
VirtualMachineExtension
The virtual machine child extension resources.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| location |
string |
Resource location |
| name |
string |
Resource name |
| properties.autoUpgradeMinorVersion |
boolean |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
| properties.enableAutomaticUpgrade |
boolean |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
| properties.forceUpdateTag |
string |
How the extension handler should be forced to update even if the extension configuration has not changed. |
| properties.instanceView |
The virtual machine extension instance view. |
|
| properties.protectedSettings |
object |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
| properties.protectedSettingsFromKeyVault |
The extensions protected settings that are passed by reference, and consumed from key vault |
|
| properties.provisionAfterExtensions |
string[] |
Collection of extension names after which this extension needs to be provisioned. |
| properties.provisioningState |
string |
The provisioning state, which only appears in the response. |
| properties.publisher |
string |
The name of the extension handler publisher. |
| properties.settings |
object |
Json formatted public settings for the extension. |
| properties.suppressFailures |
boolean |
Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. |
| properties.type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
| properties.typeHandlerVersion |
string |
Specifies the version of the script handler. |
| tags |
object |
Resource tags |
| type |
string |
Resource type |
VirtualMachineExtensionHandlerInstanceView
The virtual machine extension handler instance view.
| Name | Type | Description |
|---|---|---|
| status |
The extension handler status. |
|
| type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
| typeHandlerVersion |
string |
Specifies the version of the script handler. |
VirtualMachineExtensionInstanceView
The virtual machine extension instance view.
| Name | Type | Description |
|---|---|---|
| name |
string |
The virtual machine extension name. |
| statuses |
The resource status information. |
|
| substatuses |
The resource status information. |
|
| type |
string |
Specifies the type of the extension; an example is "CustomScriptExtension". |
| typeHandlerVersion |
string |
Specifies the version of the script handler. |
VirtualMachineHealthStatus
The health status for the VM.
| Name | Type | Description |
|---|---|---|
| status |
The health status information for the VM. |
VirtualMachineIdentity
The identity of the virtual machine, if configured.
| Name | Type | Description |
|---|---|---|
| principalId |
string |
The principal id of virtual machine identity. This property will only be provided for a system assigned identity. |
| tenantId |
string |
The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. |
| type |
The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. |
|
| userAssignedIdentities |
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
VirtualMachineInstanceView
The virtual machine instance view.
| Name | Type | Description |
|---|---|---|
| assignedHost |
string |
Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. |
| bootDiagnostics |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. |
|
| computerName |
string |
The computer name assigned to the virtual machine. |
| disks |
The virtual machine disk information. |
|
| extensions |
The extensions information. |
|
| hyperVGeneration |
Specifies the HyperVGeneration Type associated with a resource |
|
| isVMInStandbyPool |
boolean |
[Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. |
| maintenanceRedeployStatus |
The Maintenance Operation status on the virtual machine. |
|
| osName |
string |
The Operating System running on the virtual machine. |
| osVersion |
string |
The version of Operating System running on the virtual machine. |
| patchStatus |
[Preview Feature] The status of virtual machine patch operations. |
|
| platformFaultDomain |
integer |
Specifies the fault domain of the virtual machine. |
| platformUpdateDomain |
integer |
Specifies the update domain of the virtual machine. |
| rdpThumbPrint |
string |
The Remote desktop certificate thumbprint. |
| statuses |
The resource status information. |
|
| vmAgent |
The VM Agent running on the virtual machine. |
|
| vmHealth |
The health status for the VM. |
VirtualMachineIpTag
The list of IP tags associated with the public IP address.
| Name | Type | Description |
|---|---|---|
| ipTagType |
string |
IP tag type. Example: FirstPartyUsage. |
| tag |
string |
IP tag associated with the public IP. Example: SQL, Storage etc. |
VirtualMachineListResult
The List Virtual Machine operation response.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines. |
| value |
The list of virtual machines. |
VirtualMachineNetworkInterfaceConfiguration
Specifies the networking configurations that will be used to create the virtual machine networking resources.
| Name | Type | Description |
|---|---|---|
| name |
string |
The network interface configuration name. |
| properties.auxiliaryMode |
Specifies whether the Auxiliary mode is enabled for the Network Interface resource. |
|
| properties.auxiliarySku |
Specifies whether the Auxiliary sku is enabled for the Network Interface resource. |
|
| properties.deleteOption |
Specify what happens to the network interface when the VM is deleted |
|
| properties.disableTcpStateTracking |
boolean |
Specifies whether the network interface is disabled for tcp state tracking. |
| properties.dnsSettings |
The dns settings to be applied on the network interfaces. |
|
| properties.dscpConfiguration | ||
| properties.enableAcceleratedNetworking |
boolean |
Specifies whether the network interface is accelerated networking-enabled. |
| properties.enableFpga |
boolean |
Specifies whether the network interface is FPGA networking-enabled. |
| properties.enableIPForwarding |
boolean |
Whether IP forwarding enabled on this NIC. |
| properties.ipConfigurations |
Specifies the IP configurations of the network interface. |
|
| properties.networkSecurityGroup |
The network security group. |
|
| properties.primary |
boolean |
Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
VirtualMachineNetworkInterfaceDnsSettingsConfiguration
The dns settings to be applied on the network interfaces.
| Name | Type | Description |
|---|---|---|
| dnsServers |
string[] |
List of DNS servers IP addresses |
VirtualMachineNetworkInterfaceIPConfiguration
Specifies the IP configurations of the network interface.
| Name | Type | Description |
|---|---|---|
| name |
string |
The IP configuration name. |
| properties.applicationGatewayBackendAddressPools |
Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. |
|
| properties.applicationSecurityGroups |
Specifies an array of references to application security group. |
|
| properties.loadBalancerBackendAddressPools |
Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. |
|
| properties.primary |
boolean |
Specifies the primary network interface in case the virtual machine has more than 1 network interface. |
| properties.privateIPAddressVersion |
Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
| properties.publicIPAddressConfiguration |
The publicIPAddressConfiguration. |
|
| properties.subnet |
Specifies the identifier of the subnet. |
VirtualMachinePatchStatus
[Preview Feature] The status of virtual machine patch operations.
| Name | Type | Description |
|---|---|---|
| availablePatchSummary |
The available patch summary of the latest assessment operation for the virtual machine. |
|
| configurationStatuses |
The enablement status of the specified patchMode |
|
| lastPatchInstallationSummary |
The installation summary of the latest installation operation for the virtual machine. |
VirtualMachinePriorityTypes
Specifies the priority for the virtual machine. Minimum api-version: 2019-03-01
| Name | Type | Description |
|---|---|---|
| Low |
string |
|
| Regular |
string |
|
| Spot |
string |
VirtualMachinePublicIPAddressConfiguration
The publicIPAddressConfiguration.
| Name | Type | Description |
|---|---|---|
| name |
string |
The publicIP address configuration name. |
| properties.deleteOption |
Specify what happens to the public IP address when the VM is deleted |
|
| properties.dnsSettings |
The dns settings to be applied on the publicIP addresses . |
|
| properties.idleTimeoutInMinutes |
integer |
The idle timeout of the public IP address. |
| properties.ipTags |
The list of IP tags associated with the public IP address. |
|
| properties.publicIPAddressVersion |
Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
|
| properties.publicIPAllocationMethod |
Specify the public IP allocation type |
|
| properties.publicIPPrefix |
The PublicIPPrefix from which to allocate publicIP addresses. |
|
| sku |
Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. |
VirtualMachinePublicIPAddressDnsSettingsConfiguration
The dns settings to be applied on the publicIP addresses .
| Name | Type | Description |
|---|---|---|
| domainNameLabel |
string |
The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. |
| domainNameLabelScope |
The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. |
VirtualMachineSizeTypes
Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: List all available virtual machine sizes in an availability set, List all available virtual machine sizes in a region, List all available virtual machine sizes for resizing. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set.
| Name | Type | Description |
|---|---|---|
| Basic_A0 |
string |
|
| Basic_A1 |
string |
|
| Basic_A2 |
string |
|
| Basic_A3 |
string |
|
| Basic_A4 |
string |
|
| Standard_A0 |
string |
|
| Standard_A1 |
string |
|
| Standard_A10 |
string |
|
| Standard_A11 |
string |
|
| Standard_A1_v2 |
string |
|
| Standard_A2 |
string |
|
| Standard_A2_v2 |
string |
|
| Standard_A2m_v2 |
string |
|
| Standard_A3 |
string |
|
| Standard_A4 |
string |
|
| Standard_A4_v2 |
string |
|
| Standard_A4m_v2 |
string |
|
| Standard_A5 |
string |
|
| Standard_A6 |
string |
|
| Standard_A7 |
string |
|
| Standard_A8 |
string |
|
| Standard_A8_v2 |
string |
|
| Standard_A8m_v2 |
string |
|
| Standard_A9 |
string |
|
| Standard_B1ms |
string |
|
| Standard_B1s |
string |
|
| Standard_B2ms |
string |
|
| Standard_B2s |
string |
|
| Standard_B4ms |
string |
|
| Standard_B8ms |
string |
|
| Standard_D1 |
string |
|
| Standard_D11 |
string |
|
| Standard_D11_v2 |
string |
|
| Standard_D12 |
string |
|
| Standard_D12_v2 |
string |
|
| Standard_D13 |
string |
|
| Standard_D13_v2 |
string |
|
| Standard_D14 |
string |
|
| Standard_D14_v2 |
string |
|
| Standard_D15_v2 |
string |
|
| Standard_D16_v3 |
string |
|
| Standard_D16s_v3 |
string |
|
| Standard_D1_v2 |
string |
|
| Standard_D2 |
string |
|
| Standard_D2_v2 |
string |
|
| Standard_D2_v3 |
string |
|
| Standard_D2s_v3 |
string |
|
| Standard_D3 |
string |
|
| Standard_D32_v3 |
string |
|
| Standard_D32s_v3 |
string |
|
| Standard_D3_v2 |
string |
|
| Standard_D4 |
string |
|
| Standard_D4_v2 |
string |
|
| Standard_D4_v3 |
string |
|
| Standard_D4s_v3 |
string |
|
| Standard_D5_v2 |
string |
|
| Standard_D64_v3 |
string |
|
| Standard_D64s_v3 |
string |
|
| Standard_D8_v3 |
string |
|
| Standard_D8s_v3 |
string |
|
| Standard_DS1 |
string |
|
| Standard_DS11 |
string |
|
| Standard_DS11_v2 |
string |
|
| Standard_DS12 |
string |
|
| Standard_DS12_v2 |
string |
|
| Standard_DS13 |
string |
|
| Standard_DS13-2_v2 |
string |
|
| Standard_DS13-4_v2 |
string |
|
| Standard_DS13_v2 |
string |
|
| Standard_DS14 |
string |
|
| Standard_DS14-4_v2 |
string |
|
| Standard_DS14-8_v2 |
string |
|
| Standard_DS14_v2 |
string |
|
| Standard_DS15_v2 |
string |
|
| Standard_DS1_v2 |
string |
|
| Standard_DS2 |
string |
|
| Standard_DS2_v2 |
string |
|
| Standard_DS3 |
string |
|
| Standard_DS3_v2 |
string |
|
| Standard_DS4 |
string |
|
| Standard_DS4_v2 |
string |
|
| Standard_DS5_v2 |
string |
|
| Standard_E16_v3 |
string |
|
| Standard_E16s_v3 |
string |
|
| Standard_E2_v3 |
string |
|
| Standard_E2s_v3 |
string |
|
| Standard_E32-16_v3 |
string |
|
| Standard_E32-8s_v3 |
string |
|
| Standard_E32_v3 |
string |
|
| Standard_E32s_v3 |
string |
|
| Standard_E4_v3 |
string |
|
| Standard_E4s_v3 |
string |
|
| Standard_E64-16s_v3 |
string |
|
| Standard_E64-32s_v3 |
string |
|
| Standard_E64_v3 |
string |
|
| Standard_E64s_v3 |
string |
|
| Standard_E8_v3 |
string |
|
| Standard_E8s_v3 |
string |
|
| Standard_F1 |
string |
|
| Standard_F16 |
string |
|
| Standard_F16s |
string |
|
| Standard_F16s_v2 |
string |
|
| Standard_F1s |
string |
|
| Standard_F2 |
string |
|
| Standard_F2s |
string |
|
| Standard_F2s_v2 |
string |
|
| Standard_F32s_v2 |
string |
|
| Standard_F4 |
string |
|
| Standard_F4s |
string |
|
| Standard_F4s_v2 |
string |
|
| Standard_F64s_v2 |
string |
|
| Standard_F72s_v2 |
string |
|
| Standard_F8 |
string |
|
| Standard_F8s |
string |
|
| Standard_F8s_v2 |
string |
|
| Standard_G1 |
string |
|
| Standard_G2 |
string |
|
| Standard_G3 |
string |
|
| Standard_G4 |
string |
|
| Standard_G5 |
string |
|
| Standard_GS1 |
string |
|
| Standard_GS2 |
string |
|
| Standard_GS3 |
string |
|
| Standard_GS4 |
string |
|
| Standard_GS4-4 |
string |
|
| Standard_GS4-8 |
string |
|
| Standard_GS5 |
string |
|
| Standard_GS5-16 |
string |
|
| Standard_GS5-8 |
string |
|
| Standard_H16 |
string |
|
| Standard_H16m |
string |
|
| Standard_H16mr |
string |
|
| Standard_H16r |
string |
|
| Standard_H8 |
string |
|
| Standard_H8m |
string |
|
| Standard_L16s |
string |
|
| Standard_L32s |
string |
|
| Standard_L4s |
string |
|
| Standard_L8s |
string |
|
| Standard_M128-32ms |
string |
|
| Standard_M128-64ms |
string |
|
| Standard_M128ms |
string |
|
| Standard_M128s |
string |
|
| Standard_M64-16ms |
string |
|
| Standard_M64-32ms |
string |
|
| Standard_M64ms |
string |
|
| Standard_M64s |
string |
|
| Standard_NC12 |
string |
|
| Standard_NC12s_v2 |
string |
|
| Standard_NC12s_v3 |
string |
|
| Standard_NC24 |
string |
|
| Standard_NC24r |
string |
|
| Standard_NC24rs_v2 |
string |
|
| Standard_NC24rs_v3 |
string |
|
| Standard_NC24s_v2 |
string |
|
| Standard_NC24s_v3 |
string |
|
| Standard_NC6 |
string |
|
| Standard_NC6s_v2 |
string |
|
| Standard_NC6s_v3 |
string |
|
| Standard_ND12s |
string |
|
| Standard_ND24rs |
string |
|
| Standard_ND24s |
string |
|
| Standard_ND6s |
string |
|
| Standard_NV12 |
string |
|
| Standard_NV24 |
string |
|
| Standard_NV6 |
string |
VMDiskSecurityProfile
Specifies the security profile for the managed disk.
| Name | Type | Description |
|---|---|---|
| diskEncryptionSet |
Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. |
|
| securityEncryptionType |
Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. Note: It can be set for only Confidential VMs. |
VMGalleryApplication
Specifies the gallery applications that should be made available to the VM/VMSS
| Name | Type | Description |
|---|---|---|
| configurationReference |
string |
Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided |
| enableAutomaticUpgrade |
boolean |
If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS |
| order |
integer |
Optional, Specifies the order in which the packages have to be installed |
| packageReferenceId |
string |
Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} |
| tags |
string |
Optional, Specifies a passthrough value for more generic context. |
| treatFailureAsDeploymentFailure |
boolean |
Optional, If true, any failure for any operation in the VmApplication will fail the deployment |
VMSizeProperties
Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in VM Customization for more details.
| Name | Type | Description |
|---|---|---|
| vCPUsAvailable |
integer |
Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of List all available virtual machine sizes in a region. |
| vCPUsPerCore |
integer |
Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of List all available virtual machine sizes in a region. Setting this property to 1 also means that hyper-threading is disabled. |
WindowsConfiguration
Specifies Windows operating system settings on the virtual machine.
| Name | Type | Description |
|---|---|---|
| additionalUnattendContent |
Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. |
|
| enableAutomaticUpdates |
boolean |
Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. |
| enableVMAgentPlatformUpdates |
boolean |
Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. |
| patchSettings |
[Preview Feature] Specifies settings related to VM Guest Patching on Windows. |
|
| provisionVMAgent |
boolean |
Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. |
| timeZone |
string |
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones. |
| winRM |
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. |
WindowsPatchAssessmentMode
Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.
Possible values are:
ImageDefault - You control the timing of patch assessments on a virtual machine.
AutomaticByPlatform - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true.
| Name | Type | Description |
|---|---|---|
| AutomaticByPlatform |
string |
|
| ImageDefault |
string |
WindowsVMGuestPatchAutomaticByPlatformRebootSetting
Specifies the reboot setting for all AutomaticByPlatform patch installation operations.
| Name | Type | Description |
|---|---|---|
| Always |
string |
|
| IfRequired |
string |
|
| Never |
string |
|
| Unknown |
string |
WindowsVMGuestPatchAutomaticByPlatformSettings
Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows.
| Name | Type | Description |
|---|---|---|
| bypassPlatformSafetyChecksOnUserSchedule |
boolean |
Enables customer to schedule patching without accidental upgrades |
| rebootSetting |
Specifies the reboot setting for all AutomaticByPlatform patch installation operations. |
WindowsVMGuestPatchMode
Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.
Possible values are:
Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false
AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.
AutomaticByPlatform - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true
| Name | Type | Description |
|---|---|---|
| AutomaticByOS |
string |
|
| AutomaticByPlatform |
string |
|
| Manual |
string |
WinRMConfiguration
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
| Name | Type | Description |
|---|---|---|
| listeners |
The list of Windows Remote Management listeners |
WinRMListener
The list of Windows Remote Management listeners
| Name | Type | Description |
|---|---|---|
| certificateUrl |
string |
This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8: |
| protocol |
Specifies the protocol of WinRM listener. Possible values are: http, https. |