Virtual Machine Scale Sets - List All
Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets?api-version=2018-04-01| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
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. |
| 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. |
|
Auto |
The configuration parameters used for performing automatic OS upgrade. |
|
Boot |
Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. |
|
Caching |
Specifies the caching requirements. |
|
Component |
The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. |
|
Diagnostics |
Specifies the boot diagnostic settings state. |
|
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. |
| IPVersion |
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'. |
|
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. |
| 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 listener. |
|
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. |
|
Rolling |
The configuration parameters used while performing a rolling upgrade. |
|
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. |
|
Storage |
Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. |
|
Sub |
|
|
Upgrade |
Specifies the mode of an upgrade to virtual machines in the scale set. |
|
Upgrade |
Describes an upgrade policy - automatic, manual, or rolling. |
|
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 |
Specifies the eviction policy for virtual machines in a low priority scale set. |
|
Virtual |
Specifies the priority for the virtual machines in the scale set. |
|
Virtual |
Describes a Virtual Machine Scale Set. |
|
Virtual |
Describes a virtual machine scale set data disk. |
|
Virtual |
Describes a Virtual Machine Scale Set Extension. |
|
Virtual |
Describes a virtual machine scale set extension profile. |
|
Virtual |
Identity for the virtual machine scale set. |
|
Virtual |
Describes a virtual machine scale set network profile's IP configuration. |
|
Virtual |
Contains the IP tag associated with the public IP address. |
|
Virtual |
The List Virtual Machine operation response. |
|
Virtual |
Describes the parameters of a ScaleSet managed disk. |
|
Virtual |
Describes a virtual machine scale set network profile's network configurations. |
|
Virtual |
Describes a virtual machines scale sets network configuration's DNS settings. |
|
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 machines scale set IP Configuration's PublicIPAddress configuration |
|
Virtual |
Describes a virtual machines scale sets network configuration's DNS settings. |
|
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}/... |
The configuration parameters used for performing automatic OS upgrade.
| Name | Type | Description |
|---|---|---|
| disableAutoRollback |
boolean |
Whether OS image rollback feature should be disabled. Default value is false. |
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. |
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 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. |
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 |
|---|---|---|
| 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. |
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'.
| Value | Description |
|---|---|
| IPv4 | |
| IPv6 |
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 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. |
Specifies the protocol of listener.
Possible values are:
http
https
| Value | Description |
|---|---|
| Http | |
| Https |
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 |
The configuration parameters used while performing a rolling upgrade.
| Name | Type | Description |
|---|---|---|
| maxBatchInstancePercent |
integer |
The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. |
| maxUnhealthyInstancePercent |
integer |
The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. |
| maxUnhealthyUpgradedInstancePercent |
integer |
The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. |
| pauseTimeBetweenBatches |
string |
The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). |
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 |
Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS.
| Value | Description |
|---|---|
| Premium_LRS | |
| StandardSSD_LRS | |
| Standard_LRS |
| 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 | |
| Rolling |
Describes an upgrade policy - automatic, manual, or rolling.
| Name | Type | Description |
|---|---|---|
| autoOSUpgradePolicy |
Configuration parameters used for performing automatic OS Upgrade. |
|
| automaticOSUpgrade |
boolean |
Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available. |
| mode |
Specifies the mode of an upgrade to virtual machines in the scale set. |
|
| rollingUpgradePolicy |
The configuration parameters used while performing a rolling upgrade. |
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. |
Specifies the eviction policy for virtual machines in a low priority scale set.
Minimum api-version: 2017-10-30-preview
| Value | Description |
|---|---|
| Deallocate | |
| Delete |
Specifies the priority for the virtual machines in the scale set.
Minimum api-version: 2017-10-30-preview
| Value | Description |
|---|---|
| Low | |
| Regular |
Describes a Virtual Machine Scale Set.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| identity |
The identity of the virtual machine scale set, if configured. |
|
| location |
string |
Resource location |
| 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.overprovision |
boolean |
Specifies whether the Virtual Machine Scale Set should be overprovisioned. |
| properties.platformFaultDomainCount |
integer |
Fault Domain count for each placement group. |
| 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 scale set should be assigned to. |
|
| properties.singlePlacementGroup |
boolean |
When true this limits the scale set to a single placement group, of max size 100 virtual machines. |
| properties.uniqueId |
string |
Specifies the ID which uniquely identifies a Virtual Machine Scale Set. |
| properties.upgradePolicy |
The upgrade policy. |
|
| properties.virtualMachineProfile |
The virtual machine profile. |
|
| properties.zoneBalance |
boolean |
Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. |
| sku |
The virtual machine scale set sku. |
|
| tags |
object |
Resource tags |
| type |
string |
Resource type |
| zones |
string[] |
The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set. |
Describes a virtual machine scale set data disk.
| Name | Type | Description |
|---|---|---|
| caching |
Specifies the caching requirements. |
|
| createOption |
The create option. |
|
| 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. |
| 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. |
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
Describes a Virtual Machine Scale Set Extension.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| name |
string |
The name of the extension. |
| 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 |
If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. |
| 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. |
Describes a virtual machine scale set extension profile.
| Name | Type | Description |
|---|---|---|
| extensions |
The virtual machine scale set child extension resources. |
Identity for the virtual machine scale set.
| Name | Type | Description |
|---|---|---|
| identityIds |
string[] |
The list of user identities associated with the virtual machine scale set. The user identity references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/identities/{identityName}'. |
| principalId |
string |
The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. |
| tenantId |
string |
The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. |
| type |
The type of identity used for the virtual machine scale set. 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 scale set. |
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.applicationGatewayBackendAddressPools |
Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. |
|
| properties.loadBalancerBackendAddressPools |
Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer. |
|
| properties.loadBalancerInboundNatPools |
Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same 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. |
Contains the IP tag 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. |
The List Virtual Machine operation response.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets. |
| value |
The list of virtual machine scale sets. |
Describes the parameters of a ScaleSet managed disk.
| Name | Type | Description |
|---|---|---|
| storageAccountType |
Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. |
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.dnsSettings |
The dns settings to be applied on the network interfaces. |
|
| properties.enableAcceleratedNetworking |
boolean |
Specifies whether the network interface is accelerated 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. |
Describes a virtual machines scale sets network configuration's DNS settings.
| Name | Type | Description |
|---|---|---|
| dnsServers |
string[] |
List of DNS servers IP addresses |
Describes a virtual machine scale set network profile.
| Name | Type | Description |
|---|---|---|
| healthProbe |
A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. |
|
| 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. |
|
| diskSizeGB |
integer |
Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. |
| image |
Specifies information about the unmanaged user image to base the scale set on. |
|
| 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. |
|
| vhdContainers |
string[] |
Specifies the container urls that are used to store operating system disks for the scale set. |
| writeAcceleratorEnabled |
boolean |
Specifies whether writeAccelerator should be enabled or disabled on the disk. |
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 |
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. |
| linuxConfiguration |
Specifies the Linux operating system settings on the virtual machine. |
|
| secrets |
Specifies set of certificates that should be installed onto the virtual machines in the scale set. |
|
| windowsConfiguration |
Specifies Windows operating system settings on the virtual machine. |
Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration
| Name | Type | Description |
|---|---|---|
| name |
string |
The publicIP address configuration name. |
| properties.dnsSettings |
Virtual |
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. |
Describes a virtual machines scale sets network configuration's DNS settings.
| Name | Type | Description |
|---|---|---|
| domainNameLabel |
string |
The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created |
Describes a virtual machine scale set storage profile.
| Name | Type | Description |
|---|---|---|
| dataDisks |
Specifies the parameters that are used to add data disks to the virtual machines in the scale set. |
|
| 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 machines in the scale set. |
Describes a virtual machine scale set virtual machine profile.
| Name | Type | Description |
|---|---|---|
| diagnosticsProfile |
Specifies the boot diagnostic settings state. |
|
| evictionPolicy |
Specifies the eviction policy for virtual machines in a low priority scale set. |
|
| extensionProfile |
Specifies a collection of settings for extensions installed on virtual machines in the scale set. |
|
| 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. |
| networkProfile |
Specifies properties of the network interfaces of the virtual machines in the scale set. |
|
| osProfile |
Specifies the operating system settings for the virtual machines in the scale set. |
|
| priority |
Specifies the priority for the virtual machines in the scale set. |
|
| storageProfile |
Specifies the storage settings for the virtual machine disks. |
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. |