Virtual Machine Scale Sets - Get

Display information about a virtual machine scale set.

HTTP
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2015-06-15

URI Parameters

Name In Required Type Description
resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

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

vmScaleSetName
path True

string

The name of the VM scale set.

api-version
query True

string

Client Api Version.

Responses

Name Type Description
200 OK

VirtualMachineScaleSet

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

Definitions

Name Description
AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

ApiEntityReference

The API entity reference.

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.

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.

ImageReference

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

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.

OperatingSystemTypes

The operating system of the osDiskImage.

PassNames

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

ProtocolTypes

Specifies the protocol of listener.

Possible values are:
http

https

SettingNames

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

Sku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

SshConfiguration

SSH configuration for Linux based VMs running on Azure

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

SubResource
UpgradeMode

Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

Automatic - All virtual machines in the scale set are automatically updated at the same time.

UpgradePolicy

Describes an upgrade policy - automatic or manual.

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

VaultSecretGroup

Describes a set of certificates which are all in the same Key Vault.

VirtualHardDisk

Describes the uri of a disk.

VirtualMachineScaleSet

Describes a Virtual Machine Scale Set.

VirtualMachineScaleSetExtension

Describes a Virtual Machine Scale Set Extension.

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

VirtualMachineScaleSetStorageProfile

Describes a virtual machine scale set storage profile.

VirtualMachineScaleSetVMProfile

Describes a virtual machine scale set virtual machine profile.

WindowsConfiguration

Specifies Windows operating system settings on the virtual machine.

WinRMConfiguration

Describes Windows Remote Management configuration of the VM

WinRMListener

Describes Protocol and thumbprint of Windows Remote Management listener

AdditionalUnattendContent

Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied.

Name Type Description
componentName

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.

ApiEntityReference

The API entity reference.

Name Type Description
id

string

The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

CachingTypes

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

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

Value Description
Microsoft-Windows-Shell-Setup

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.

Value Description
Attach
Empty
FromImage

ImageReference

Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set.

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

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.

Name Type Description
disablePasswordAuthentication

boolean

Specifies whether password authentication should be disabled.

ssh

SshConfiguration

Specifies the ssh key configuration for a Linux OS.

OperatingSystemTypes

The operating system of the osDiskImage.

Value Description
Linux
Windows

PassNames

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

Value Description
OobeSystem

ProtocolTypes

Specifies the protocol of listener.

Possible values are:
http

https

Value Description
Http
Https

SettingNames

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

Value Description
AutoLogon
FirstLogonCommands

Sku

Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name.

Name Type Description
capacity

integer

Specifies the number of virtual machines in the scale set.

name

string

The sku name.

tier

string

Specifies the tier of virtual machines in a scale set.

Possible Values:

Standard

Basic

SshConfiguration

SSH configuration for Linux based VMs running on Azure

Name Type Description
publicKeys

SshPublicKey[]

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

SshPublicKey

Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.

Name Type Description
keyData

string

SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see Create SSH keys on Linux and Mac for Linux VMs in Azure.

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

SubResource

Name Type Description
id

string

Resource Id

UpgradeMode

Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

Automatic - All virtual machines in the scale set are automatically updated at the same time.

Value Description
Automatic
Manual

UpgradePolicy

Describes an upgrade policy - automatic or manual.

Name Type Description
mode

UpgradeMode

Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

Manual - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

Automatic - All virtual machines in the scale set are automatically updated at the same time.

VaultCertificate

Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM.

Name Type Description
certificateStore

string

For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <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

Describes a set of certificates which are all in the same Key Vault.

Name Type Description
sourceVault

SubResource

The relative URL of the Key Vault containing all of the certificates in VaultCertificates.

vaultCertificates

VaultCertificate[]

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

VirtualHardDisk

Describes the uri of a disk.

Name Type Description
uri

string

Specifies the virtual hard disk's uri.

VirtualMachineScaleSet

Describes a Virtual Machine Scale Set.

Name Type Description
id

string

Resource Id

location

string

Resource location

name

string

Resource name

properties.overProvision

boolean

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

properties.provisioningState

string

The provisioning state, which only appears in the response.

properties.upgradePolicy

UpgradePolicy

The upgrade policy.

properties.virtualMachineProfile

VirtualMachineScaleSetVMProfile

The virtual machine profile.

sku

Sku

The virtual machine scale set sku.

tags

object

Resource tags

type

string

Resource type

VirtualMachineScaleSetExtension

Describes a Virtual Machine Scale Set Extension.

Name Type Description
id

string

Resource Id

name

string

The name of the extension.

properties.autoUpgradeMinorVersion

boolean

Whether the extension handler should be automatically upgraded across minor versions.

properties.protectedSettings

object

Json formatted protected settings for the extension.

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

The type of the extension handler.

properties.typeHandlerVersion

string

The type version of the extension handler.

VirtualMachineScaleSetExtensionProfile

Describes a virtual machine scale set extension profile.

Name Type Description
extensions

VirtualMachineScaleSetExtension[]

The virtual machine scale set child extension resources.

VirtualMachineScaleSetIPConfiguration

Describes a virtual machine scale set network profile's IP configuration.

Name Type Description
id

string

Resource Id

name

string

The IP configuration name.

properties.loadBalancerBackendAddressPools

SubResource[]

The load balancer backend address pools.

properties.loadBalancerInboundNatPools

SubResource[]

The load balancer inbound nat pools.

properties.subnet

ApiEntityReference

The subnet.

VirtualMachineScaleSetNetworkConfiguration

Describes a virtual machine scale set network profile's network configurations.

Name Type Description
id

string

Resource Id

name

string

The network configuration name.

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

The virtual machine scale set IP Configuration.

properties.primary

boolean

Whether this is a primary NIC on a virtual machine.

VirtualMachineScaleSetNetworkProfile

Describes a virtual machine scale set network profile.

Name Type Description
networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

The list of network configurations.

VirtualMachineScaleSetOSDisk

Describes a virtual machine scale set operating system disk.

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 machines in the scale set should be created.

The only allowed value is: 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.

image

VirtualHardDisk

The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist.

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

vhdContainers

string[]

The list of virtual hard disk container uris.

VirtualMachineScaleSetOSProfile

Describes a virtual machine scale set OS profile.

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

  • computerNamePrefix

    string

    Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long.

    customData

    string

    A base-64 encoded string of custom data.

    linuxConfiguration

    LinuxConfiguration

    The Linux Configuration of the OS profile.

    secrets

    VaultSecretGroup[]

    The List of certificates for addition to the VM.

    windowsConfiguration

    WindowsConfiguration

    The Windows Configuration of the OS profile.

    VirtualMachineScaleSetStorageProfile

    Describes a virtual machine scale set storage profile.

    Name Type Description
    imageReference

    ImageReference

    The image reference.

    osDisk

    VirtualMachineScaleSetOSDisk

    The OS disk.

    VirtualMachineScaleSetVMProfile

    Describes a virtual machine scale set virtual machine profile.

    Name Type Description
    extensionProfile

    VirtualMachineScaleSetExtensionProfile

    The virtual machine scale set extension profile.

    networkProfile

    VirtualMachineScaleSetNetworkProfile

    The virtual machine scale set network profile.

    osProfile

    VirtualMachineScaleSetOSProfile

    The virtual machine scale set OS profile.

    storageProfile

    VirtualMachineScaleSetStorageProfile

    The virtual machine scale set storage profile.

    WindowsConfiguration

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

    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

    Describes Windows Remote Management configuration of the VM

    Name Type Description
    listeners

    WinRMListener[]

    The list of Windows Remote Management listeners

    WinRMListener

    Describes Protocol and thumbprint of Windows Remote Management listener

    Name Type Description
    certificateUrl

    string

    This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see Add a key or secret to the key vault. In this case, your certificate needs to be 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