Virtual Machine Scale Sets - Get
Display information about a virtual machine scale set.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}?api-version=2015-06-15
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. |
vm
|
path | True |
string |
The name of the VM scale set. |
api-version
|
query | True |
string |
Client Api Version. |
Name | Type | Description |
---|---|---|
200 OK |
OK |
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Name | Description |
---|---|
Additional |
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. |
Api |
The API entity reference. |
Caching |
Specifies the caching requirements. |
Component |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
Disk |
Specifies how the virtual machine should be created. |
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. NOTE: Image reference publisher and offer can only be set when you create the scale set. |
Linux |
Specifies the Linux operating system settings on the virtual machine. |
Operating |
The operating system of the osDiskImage. |
Pass |
The pass name. Currently, the only allowable value is OobeSystem. |
Protocol |
Specifies the protocol of listener. |
Setting |
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. |
Ssh |
SSH configuration for Linux based VMs running on Azure |
Ssh |
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. |
Sub |
|
Upgrade |
Specifies the mode of an upgrade to virtual machines in the scale set. |
Upgrade |
Describes an upgrade policy - automatic or manual. |
Vault |
Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. |
Vault |
Describes a set of certificates which are all in the same Key Vault. |
Virtual |
Describes the uri of a disk. |
Virtual |
Describes a Virtual Machine Scale Set. |
Virtual |
Describes a Virtual Machine Scale Set Extension. |
Virtual |
Describes a virtual machine scale set extension profile. |
Virtual |
Describes a virtual machine scale set network profile's IP configuration. |
Virtual |
Describes a virtual machine scale set network profile's network configurations. |
Virtual |
Describes a virtual machine scale set network profile. |
Virtual |
Describes a virtual machine scale set operating system disk. |
Virtual |
Describes a virtual machine scale set OS profile. |
Virtual |
Describes a virtual machine scale set storage profile. |
Virtual |
Describes a virtual machine scale set virtual machine profile. |
Windows |
Specifies Windows operating system settings on the virtual machine. |
Win |
Describes Windows Remote Management configuration of the VM |
Win |
Describes Protocol and thumbprint of Windows Remote Management listener |
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 |
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. |
The API entity reference.
Name | Type | Description |
---|---|---|
id |
string |
The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... |
Specifies the caching requirements.
Possible values are:
None
ReadOnly
ReadWrite
Default: None for Standard storage. ReadOnly for Premium storage
Value | Description |
---|---|
None | |
ReadOnly | |
ReadWrite |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.
Value | Description |
---|---|
Microsoft-Windows-Shell-Setup |
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 |
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. |
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 |
Specifies the ssh key configuration for a Linux OS. |
The operating system of the osDiskImage.
Value | Description |
---|---|
Linux | |
Windows |
The pass name. Currently, the only allowable value is OobeSystem.
Value | Description |
---|---|
OobeSystem |
Specifies the protocol of listener.
Possible values are:
http
https
Value | Description |
---|---|
Http | |
Https |
Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.
Value | Description |
---|---|
AutoLogon | |
FirstLogonCommands |
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. |
SSH configuration for Linux based VMs running on Azure
Name | Type | Description |
---|---|---|
publicKeys |
The list of SSH public keys used to authenticate with linux based VMs. |
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. |
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 |
Name | Type | Description |
---|---|---|
id |
string |
Resource Id |
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 |
Describes an upgrade policy - automatic or manual.
Name | Type | Description |
---|---|---|
mode |
Specifies the mode of an upgrade to virtual machines in the scale set. |
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. |
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: |
Describes a set of certificates which are all in the same Key Vault.
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. |
Describes the uri of a disk.
Name | Type | Description |
---|---|---|
uri |
string |
Specifies the virtual hard disk's uri. |
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 |
The upgrade policy. |
|
properties.virtualMachineProfile |
The virtual machine profile. |
|
sku |
The virtual machine scale set sku. |
|
tags |
object |
Resource tags |
type |
string |
Resource type |
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. |
Describes a virtual machine scale set extension profile.
Name | Type | Description |
---|---|---|
extensions |
The virtual machine scale set child extension resources. |
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 |
The load balancer backend address pools. |
|
properties.loadBalancerInboundNatPools |
The load balancer inbound nat pools. |
|
properties.subnet |
The subnet. |
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 |
The virtual machine scale set IP Configuration. |
|
properties.primary |
boolean |
Whether this is a primary NIC on a virtual machine. |
Describes a virtual machine scale set network profile.
Name | Type | Description |
---|---|---|
networkInterfaceConfigurations |
The list of network configurations. |
Describes a virtual machine scale set operating system disk.
Name | Type | Description |
---|---|---|
caching |
Specifies the caching requirements. |
|
createOption |
Specifies how the virtual machines in the scale set should be created. |
|
image |
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 |
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. |
|
vhdContainers |
string[] |
The list of virtual hard disk container uris. |
Describes a virtual machine scale set OS profile.
Name | Type | Description |
---|---|---|
adminPassword |
string |
Specifies the password of the administrator account. |
adminUsername |
string |
Specifies the name of the administrator account. |
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 |
The Linux Configuration of the OS profile. |
|
secrets |
The List of certificates for addition to the VM. |
|
windowsConfiguration |
The Windows Configuration of the OS profile. |
Describes a virtual machine scale set storage profile.
Name | Type | Description |
---|---|---|
imageReference |
The image reference. |
|
osDisk |
The OS disk. |
Describes a virtual machine scale set virtual machine profile.
Name | Type | Description |
---|---|---|
extensionProfile |
The virtual machine scale set extension profile. |
|
networkProfile |
The virtual machine scale set network profile. |
|
osProfile |
The virtual machine scale set OS profile. |
|
storageProfile |
The virtual machine scale set storage profile. |
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 virtual machine is enabled for automatic updates. |
provisionVMAgent |
boolean |
Indicates whether virtual machine agent should be provisioned on the virtual machine. |
timeZone |
string |
Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time" |
winRM |
Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. |
Describes Windows Remote Management configuration of the VM
Name | Type | Description |
---|---|---|
listeners |
The list of Windows Remote Management listeners |
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: |
protocol |
Specifies the protocol of listener. |