Virtual Machines - List By Location

Service:

Compute

API Version:

2018-10-01

Gets all the virtual machines under the specified subscription for the specified location.

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines?api-version=2018-10-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	The location for which virtual machines under the subscription are queried. Regex pattern: ^[-\w\._]+$
subscriptionId	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.

Responses

Name	Type	Description
200 OK	VirtualMachineListResult	OK

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

Lists all the virtual machines under the specified subscription for the specified location.

Sample request

HTTP

HTTP

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/eastus/virtualMachines?api-version=2018-10-01

Sample response

Status code:

200

JSON

{
  "value": [
    {
      "properties": {
        "vmId": "{vmId}",
        "availabilitySet": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hardwareProfile": {
          "vmSize": "Standard_A0"
        },
        "storageProfile": {
          "imageReference": {
            "publisher": "MicrosoftWindowsServer",
            "offer": "WindowsServer",
            "sku": "2012-R2-Datacenter",
            "version": "4.127.20170406"
          },
          "osDisk": {
            "osType": "Windows",
            "name": "test",
            "createOption": "FromImage",
            "vhd": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "caching": "None",
            "diskSizeGB": 127
          },
          "dataDisks": []
        },
        "osProfile": {
          "computerName": "Test",
          "adminUsername": "Foo12",
          "windowsConfiguration": {
            "provisionVMAgent": true,
            "enableAutomaticUpdates": true
          },
          "secrets": [],
          "allowExtensionOperations": true
        },
        "networkProfile": {
          "networkInterfaces": [
            {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}"
            }
          ]
        },
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/virtualMachines",
      "location": "eastus",
      "tags": {
        "RG": "rg",
        "testTag": "1"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
      "name": "{virtualMachineName}"
    },
    {
      "properties": {
        "vmId": "{vmId}",
        "availabilitySet": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "hardwareProfile": {
          "vmSize": "Standard_A0"
        },
        "storageProfile": {
          "imageReference": {
            "publisher": "MicrosoftWindowsServer",
            "offer": "WindowsServer",
            "sku": "2012-R2-Datacenter",
            "version": "4.127.20170406"
          },
          "osDisk": {
            "osType": "Windows",
            "name": "test",
            "createOption": "FromImage",
            "vhd": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "caching": "None",
            "diskSizeGB": 127
          },
          "dataDisks": []
        },
        "osProfile": {
          "computerName": "Test",
          "adminUsername": "Foo12",
          "windowsConfiguration": {
            "provisionVMAgent": true,
            "enableAutomaticUpdates": true
          },
          "secrets": [],
          "allowExtensionOperations": true
        },
        "networkProfile": {
          "networkInterfaces": [
            {
              "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}"
            }
          ]
        },
        "provisioningState": "Succeeded"
      },
      "type": "Microsoft.Compute/virtualMachines",
      "location": "eastus",
      "tags": {
        "RG": "rg",
        "testTag": "1"
      },
      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}",
      "name": "{virtualMachineName}"
    }
  ]
}

Definitions

Name	Description
AdditionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.
AdditionalUnattendContent	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.
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.
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.
CachingTypes	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
ComponentNames	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
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.
DiagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
DiffDiskOptions	Specifies the ephemeral disk settings for operating system disk.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiskCreateOptionTypes	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
DiskEncryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
DiskInstanceView	The virtual machine disk information.
HardwareProfile	Specifies the hardware settings for the virtual machine.
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.
InstanceViewStatus	Instance view status.
KeyVaultKeyReference	Specifies the location of the key encryption key in Key Vault.
KeyVaultSecretReference	Specifies the location of the disk encryption key, which is a Key Vault Secret.
LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.
MaintenanceOperationResultCodeTypes	The Last Maintenance Operation Result Code.
MaintenanceRedeployStatus	The Maintenance Operation status on the virtual machine.
ManagedDiskParameters	The managed disk parameters.
NetworkInterfaceReference	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.
NetworkProfile	Specifies the network interfaces of the virtual machine.
OperatingSystemTypes	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.
OSProfile	Specifies the operating system settings for the virtual machine.
PassNames	The pass name. Currently, the only allowable value is OobeSystem.
Plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
ProtocolTypes	Specifies the protocol of listener. Possible values are: http https
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.
SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
SshConfiguration	Specifies the ssh key configuration for a Linux OS.
SshPublicKey	The list of SSH public keys used to authenticate with linux based VMs.
StatusLevelTypes	The level code.
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.
StorageProfile	Specifies the storage settings for the virtual machine disks.
SubResource
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}'.
VaultCertificate	The list of key vault references in SourceVault which contain certificates.
VaultSecretGroup	Specifies set of certificates that should be installed onto the virtual machine.
VirtualHardDisk	The virtual hard disk.
VirtualMachine	The list of virtual machines.
VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.
VirtualMachineExtension	The virtual machine child extension resources.
VirtualMachineExtensionHandlerInstanceView	The virtual machine extension handler instance view.
VirtualMachineExtensionInstanceView	The virtual machine extension instance view.
VirtualMachineIdentity	The identity of the virtual machine, if configured.
VirtualMachineInstanceView	The virtual machine instance view.
VirtualMachineListResult	The List Virtual Machine operation response.
VirtualMachineSizeTypes	Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. For a list of available sizes use 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
WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.
WinRMConfiguration	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.
WinRMListener	The list of Windows Remote Management listeners

AdditionalCapabilities

Object

Specifies additional capabilities enabled or disabled on the virtual machine.

Name	Type	Description
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

Object

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	ComponentNames	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
content	string	Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted.
passName	PassNames	The pass name. Currently, the only allowable value is OobeSystem.
settingName	SettingNames	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

BootDiagnostics

Object

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

Name	Type	Description
enabled	boolean	Whether boot diagnostics should be enabled on the Virtual Machine.
storageUri	string	Uri of the storage account to use for placing the console output and screenshot.

BootDiagnosticsInstanceView

Object

Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

You can easily view the output of your console log.

Azure also enables you to see a screenshot of the VM from the hypervisor.

Name	Type	Description
consoleScreenshotBlobUri	string	The console screenshot blob URI.
serialConsoleLogBlobUri	string	The Linux serial console log blob Uri.
status	InstanceViewStatus	The boot diagnostics status information for the VM. NOTE: It will be set only if there are errors encountered in enabling boot diagnostics.

CachingTypes

Enumeration

Specifies the caching requirements.

Possible values are:

None

ReadOnly

ReadWrite

Default: None for Standard storage. ReadOnly for Premium storage

Value	Description
None
ReadOnly
ReadWrite

ComponentNames

Enumeration

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

Value	Description
Microsoft-Windows-Shell-Setup

DataDisk

Object

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	CachingTypes	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
createOption	DiskCreateOptionTypes	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
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. This value cannot be larger than 1023 GB
image	VirtualHardDisk	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	ManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
vhd	VirtualHardDisk	The virtual hard disk.
writeAcceleratorEnabled	boolean	Specifies whether writeAccelerator should be enabled or disabled on the disk.

DiagnosticsProfile

Object

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

Name	Type	Description
bootDiagnostics	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.

DiffDiskOptions

Enumeration

Specifies the ephemeral disk settings for operating system disk.

Value	Description
Local

DiffDiskSettings

Object

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

Name	Type	Description
option	DiffDiskOptions	Specifies the ephemeral disk settings for operating system disk.

DiskCreateOptionTypes

Enumeration

Specifies how the virtual machine should be created.

Possible values are:

Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine.

FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.

Value	Description
Attach
Empty
FromImage

DiskEncryptionSettings

Object

Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15

Name	Type	Description
diskEncryptionKey	KeyVaultSecretReference	Specifies the location of the disk encryption key, which is a Key Vault Secret.
enabled	boolean	Specifies whether disk encryption should be enabled on the virtual machine.
keyEncryptionKey	KeyVaultKeyReference	Specifies the location of the key encryption key in Key Vault.

DiskInstanceView

Object

The virtual machine disk information.

Name	Type	Description
encryptionSettings	DiskEncryptionSettings[]	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
name	string	The disk name.
statuses	InstanceViewStatus[]	The resource status information.

HardwareProfile

Object

Specifies the hardware settings for the virtual machine.

Name	Type	Description
vmSize	VirtualMachineSizeTypes	Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines. The available VM sizes depend on region and availability set. For a list of available sizes use 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

ImageReference

Object

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations.

Name	Type	Description
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.
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.

InstanceViewStatus

Object

Instance view status.

Name	Type	Description
code	string	The status code.
displayStatus	string	The short localizable label for the status.
level	StatusLevelTypes	The level code.
message	string	The detailed status message, including for alerts and error messages.
time	string	The time of the status.

KeyVaultKeyReference

Object

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	SubResource	The relative URL of the Key Vault containing the key.

KeyVaultSecretReference

Object

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

Name	Type	Description
secretUrl	string	The URL referencing a secret in a Key Vault.
sourceVault	SubResource	The relative URL of the Key Vault containing the secret.

LinuxConfiguration

Object

Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions

For running non-endorsed distributions, see Information for Non-Endorsed Distributions.

Name	Type	Description
disablePasswordAuthentication	boolean	Specifies whether password authentication should be disabled.
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	SshConfiguration	Specifies the ssh key configuration for a Linux OS.

MaintenanceOperationResultCodeTypes

Enumeration

The Last Maintenance Operation Result Code.

Value	Description
MaintenanceAborted
MaintenanceCompleted
None
RetryLater

MaintenanceRedeployStatus

Object

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

Object

The managed disk parameters.

Name	Type	Description
id	string	Resource Id
storageAccountType	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.

NetworkInterfaceReference

Object

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

Name	Type	Description
id	string	Resource Id
properties.primary	boolean	Specifies the primary network interface in case the virtual machine has more than 1 network interface.

NetworkProfile

Object

Specifies the network interfaces of the virtual machine.

Name	Type	Description
networkInterfaces	NetworkInterfaceReference[]	Specifies the list of resource Ids for the network interfaces associated with the virtual machine.

OperatingSystemTypes

Enumeration

The Operating System type.

Value	Description
Linux
Windows

OSDisk

Object

Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see About disks and VHDs for Azure virtual machines.

Name	Type	Description
caching	CachingTypes	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage
createOption	DiskCreateOptionTypes	Specifies how the virtual machine should be created. Possible values are: Attach \u2013 This value is used when you are using a specialized disk to create the virtual machine. FromImage \u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.
diffDiskSettings	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. This value cannot be larger than 1023 GB
encryptionSettings	DiskEncryptionSettings	Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15
image	VirtualHardDisk	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	ManagedDiskParameters	The managed disk parameters.
name	string	The disk name.
osType	OperatingSystemTypes	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	VirtualHardDisk	The virtual hard disk.
writeAcceleratorEnabled	boolean	Specifies whether writeAccelerator should be enabled or disabled on the disk.

OSProfile

Object

Specifies the operating system settings for the virtual machine.

Name	Type	Description
adminPassword	string	Specifies the password of the administrator account. Minimum-length (Windows): 8 characters Minimum-length (Linux): 6 characters Max-length (Windows): 123 characters Max-length (Linux): 72 characters Complexity requirements: 3 out of 4 conditions below need to be fulfilled Has lower characters Has upper characters Has a digit Has a special character (Regex match [\W_]) Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension
adminUsername	string	Specifies the name of the administrator account. Windows-only restriction: Cannot end in "." Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". Minimum-length (Linux): 1 character Max-length (Linux): 64 characters Max-length (Windows): 20 characters For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure
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. For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation
linuxConfiguration	LinuxConfiguration	Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see Linux on Azure-Endorsed Distributions For running non-endorsed distributions, see Information for Non-Endorsed Distributions.
secrets	VaultSecretGroup[]	Specifies set of certificates that should be installed onto the virtual machine.
windowsConfiguration	WindowsConfiguration	Specifies Windows operating system settings on the virtual machine.

PassNames

Enumeration

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

Value	Description
OobeSystem

Plan

Object

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

Name	Type	Description
name	string	The plan ID.
product	string	Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotionCode	string	The promotion code.
publisher	string	The publisher ID.

ProtocolTypes

Enumeration

Specifies the protocol of listener.

Possible values are:
http

https

Value	Description
Http
Https

ResourceIdentityType

Enumeration

The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.

Value	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SettingNames

Enumeration

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

Value	Description
AutoLogon
FirstLogonCommands

SshConfiguration

Object

Specifies the ssh key configuration for a Linux OS.

Name	Type	Description
publicKeys	SshPublicKey[]	The list of SSH public keys used to authenticate with linux based VMs.

SshPublicKey

Object

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

Enumeration

The level code.

Value	Description
Error
Info
Warning

StorageAccountTypes

Enumeration

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.

Value	Description
Premium_LRS
StandardSSD_LRS
Standard_LRS
UltraSSD_LRS

StorageProfile

Object

Specifies the storage settings for the virtual machine disks.

Name	Type	Description
dataDisks	DataDisk[]	Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see About disks and VHDs for Azure virtual machines.
imageReference	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	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

Object

Name	Type	Description
id	string	Resource Id

UserAssignedIdentities

Object

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

VaultCertificate

Object

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: { "data":"", "dataType":"pfx", "password":"" }

VaultSecretGroup

Object

Specifies set of certificates that should be installed onto the virtual machine.

Name	Type	Description
sourceVault	SubResource	The relative URL of the Key Vault containing all of the certificates in VaultCertificates.
vaultCertificates	VaultCertificate[]	The list of key vault references in SourceVault which contain certificates.

VirtualHardDisk

Object

The virtual hard disk.

Name	Type	Description
uri	string	Specifies the virtual hard disk's uri.

VirtualMachine

Object

The list of virtual machines.

Name	Type	Description
id	string	Resource Id
identity	VirtualMachineIdentity	The identity of the virtual machine, if configured.
location	string	Resource location
name	string	Resource name
plan	Plan	Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
properties.additionalCapabilities	AdditionalCapabilities	Specifies additional capabilities enabled or disabled on the virtual machine.
properties.availabilitySet	SubResource	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 Manage the availability of virtual machines. For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set.
properties.diagnosticsProfile	DiagnosticsProfile	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.
properties.hardwareProfile	HardwareProfile	Specifies the hardware settings for the virtual machine.
properties.instanceView	VirtualMachineInstanceView	The virtual machine instance view.
properties.licenseType	string	Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system. Possible values are: Windows_Client Windows_Server If this element is included in a request for an update, the value must match the initial value. This value cannot be updated. For more information, see Azure Hybrid Use Benefit for Windows Server Minimum api-version: 2015-06-15
properties.networkProfile	NetworkProfile	Specifies the network interfaces of the virtual machine.
properties.osProfile	OSProfile	Specifies the operating system settings for the virtual machine.
properties.provisioningState	string	The provisioning state, which only appears in the response.
properties.proximityPlacementGroup	SubResource	Specifies information about the proximity placement group that the virtual machine should be assigned to. Minimum api-version: 2018-04-01.
properties.storageProfile	StorageProfile	Specifies the storage settings for the virtual machine disks.
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	VirtualMachineExtension[]	The virtual machine child extension resources.
tags	object	Resource tags
type	string	Resource type
zones	string[]	The virtual machine zones.

VirtualMachineAgentInstanceView

Object

The VM Agent running on the virtual machine.

Name	Type	Description
extensionHandlers	VirtualMachineExtensionHandlerInstanceView[]	The virtual machine extension handler instance view.
statuses	InstanceViewStatus[]	The resource status information.
vmAgentVersion	string	The VM Agent full version.

VirtualMachineExtension

Object

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.forceUpdateTag	string	How the extension handler should be forced to update even if the extension configuration has not changed.
properties.instanceView	VirtualMachineExtensionInstanceView	The virtual machine extension instance view.
properties.protectedSettings	object	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
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.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

Object

The virtual machine extension handler instance view.

Name	Type	Description
status	InstanceViewStatus	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

Object

The virtual machine extension instance view.

Name	Type	Description
name	string	The virtual machine extension name.
statuses	InstanceViewStatus[]	The resource status information.
substatuses	InstanceViewStatus[]	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.

VirtualMachineIdentity

Object

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

Object

The virtual machine instance view.

Name	Type	Description
bootDiagnostics	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.
computerName	string	The computer name assigned to the virtual machine.
disks	DiskInstanceView[]	The virtual machine disk information.
extensions	VirtualMachineExtensionInstanceView[]	The extensions information.
maintenanceRedeployStatus	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.
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	InstanceViewStatus[]	The resource status information.
vmAgent	VirtualMachineAgentInstanceView	The VM Agent running on the virtual machine.

VirtualMachineListResult

Object

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	VirtualMachine[]	The list of virtual machines.

VirtualMachineSizeTypes

Enumeration

Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set. For a list of available sizes use 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

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

WindowsConfiguration

Object

Specifies Windows operating system settings on the virtual machine.

Name	Type	Description
additionalUnattendContent	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 virtual machine is enabled for automatic Windows updates. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
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.
timeZone	string	Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"
winRM	WinRMConfiguration	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

WinRMConfiguration

Object

Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

Name	Type	Description
listeners	WinRMListener[]	The list of Windows Remote Management listeners

WinRMListener

Object

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 It is the Base64 encoding of the following JSON Object which is encoded in UTF-8: { "data":"", "dataType":"pfx", "password":"" }
protocol	ProtocolTypes	Specifies the protocol of listener. Possible values are: http https