Microsoft.Compute virtualMachineScaleSets 2018-04-01

10/05/2020
27 minutes to read

Template format

To create a Microsoft.Compute/virtualMachineScaleSets resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Compute/virtualMachineScaleSets",
  "apiVersion": "2018-04-01",
  "location": "string",
  "tags": {},
  "sku": {
    "name": "string",
    "tier": "string",
    "capacity": "integer"
  },
  "plan": {
    "name": "string",
    "publisher": "string",
    "product": "string",
    "promotionCode": "string"
  },
  "properties": {
    "upgradePolicy": {
      "mode": "string",
      "rollingUpgradePolicy": {
        "maxBatchInstancePercent": "integer",
        "maxUnhealthyInstancePercent": "integer",
        "maxUnhealthyUpgradedInstancePercent": "integer",
        "pauseTimeBetweenBatches": "string"
      },
      "automaticOSUpgrade": "boolean",
      "autoOSUpgradePolicy": {
        "disableAutoRollback": "boolean"
      }
    },
    "virtualMachineProfile": {
      "osProfile": {
        "computerNamePrefix": "string",
        "adminUsername": "string",
        "adminPassword": "string",
        "customData": "string",
        "windowsConfiguration": {
          "provisionVMAgent": "boolean",
          "enableAutomaticUpdates": "boolean",
          "timeZone": "string",
          "additionalUnattendContent": [
            {
              "passName": "OobeSystem",
              "componentName": "Microsoft-Windows-Shell-Setup",
              "settingName": "string",
              "content": "string"
            }
          ],
          "winRM": {
            "listeners": [
              {
                "protocol": "string",
                "certificateUrl": "string"
              }
            ]
          }
        },
        "linuxConfiguration": {
          "disablePasswordAuthentication": "boolean",
          "ssh": {
            "publicKeys": [
              {
                "path": "string",
                "keyData": "string"
              }
            ]
          }
        },
        "secrets": [
          {
            "sourceVault": {
              "id": "string"
            },
            "vaultCertificates": [
              {
                "certificateUrl": "string",
                "certificateStore": "string"
              }
            ]
          }
        ]
      },
      "storageProfile": {
        "imageReference": {
          "id": "string",
          "publisher": "string",
          "offer": "string",
          "sku": "string",
          "version": "string"
        },
        "osDisk": {
          "name": "string",
          "caching": "string",
          "writeAcceleratorEnabled": "boolean",
          "createOption": "string",
          "diskSizeGB": "integer",
          "osType": "string",
          "image": {
            "uri": "string"
          },
          "vhdContainers": [
            "string"
          ],
          "managedDisk": {
            "storageAccountType": "string"
          }
        },
        "dataDisks": [
          {
            "name": "string",
            "lun": "integer",
            "caching": "string",
            "writeAcceleratorEnabled": "boolean",
            "createOption": "string",
            "diskSizeGB": "integer",
            "managedDisk": {
              "storageAccountType": "string"
            }
          }
        ]
      },
      "networkProfile": {
        "healthProbe": {
          "id": "string"
        },
        "networkInterfaceConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "primary": "boolean",
              "enableAcceleratedNetworking": "boolean",
              "networkSecurityGroup": {
                "id": "string"
              },
              "dnsSettings": {
                "dnsServers": [
                  "string"
                ]
              },
              "ipConfigurations": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "subnet": {
                      "id": "string"
                    },
                    "primary": "boolean",
                    "publicIPAddressConfiguration": {
                      "name": "string",
                      "properties": {
                        "idleTimeoutInMinutes": "integer",
                        "dnsSettings": {
                          "domainNameLabel": "string"
                        },
                        "ipTags": [
                          {
                            "ipTagType": "string",
                            "tag": "string"
                          }
                        ]
                      }
                    },
                    "privateIPAddressVersion": "string",
                    "applicationGatewayBackendAddressPools": [
                      {
                        "id": "string"
                      }
                    ],
                    "loadBalancerBackendAddressPools": [
                      {
                        "id": "string"
                      }
                    ],
                    "loadBalancerInboundNatPools": [
                      {
                        "id": "string"
                      }
                    ]
                  }
                }
              ],
              "enableIPForwarding": "boolean"
            }
          }
        ]
      },
      "diagnosticsProfile": {
        "bootDiagnostics": {
          "enabled": "boolean",
          "storageUri": "string"
        }
      },
      "extensionProfile": {
        "extensions": [
          {
            "name": "string",
            "properties": {
              "publisher": "string",
              "type": "string",
              "typeHandlerVersion": "string",
              "autoUpgradeMinorVersion": "boolean",
              "settings": {},
              "protectedSettings": {}
            }
          }
        ]
      },
      "licenseType": "string",
      "priority": "string",
      "evictionPolicy": "string"
    },
    "overprovision": "boolean",
    "singlePlacementGroup": "boolean",
    "zoneBalance": "boolean",
    "platformFaultDomainCount": "integer",
    "proximityPlacementGroup": {
      "id": "string"
    }
  },
  "identity": {
    "type": "string",
    "identityIds": [
      "string"
    ]
  },
  "zones": [
    "string"
  ],
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Compute/virtualMachineScaleSets object

Name	Type	Required	Value
name	string	Yes	The name of the VM scale set to create or update.
type	enum	Yes	Microsoft.Compute/virtualMachineScaleSets
apiVersion	enum	Yes	2018-04-01
location	string	Yes	Resource location
tags	object	No	Resource tags
sku	object	No	The virtual machine scale set sku. - Sku object
plan	object	No	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. - Plan object
properties	object	Yes	VirtualMachineScaleSetProperties object
identity	object	No	The identity of the virtual machine scale set, if configured. - VirtualMachineScaleSetIdentity object
zones	array	No	The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set. - string
resources	array	No	virtualmachines extensions

Sku object

Name	Type	Required	Value
name	string	No	The sku name.
tier	string	No	Specifies the tier of virtual machines in a scale set. Possible Values: Standard Basic
capacity	integer	No	Specifies the number of virtual machines in the scale set.

Plan object

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

VirtualMachineScaleSetProperties object

Name	Type	Required	Value
upgradePolicy	object	No	The upgrade policy. - UpgradePolicy object
virtualMachineProfile	object	No	The virtual machine profile. - VirtualMachineScaleSetVMProfile object
overprovision	boolean	No	Specifies whether the Virtual Machine Scale Set should be overprovisioned.
singlePlacementGroup	boolean	No	When true this limits the scale set to a single placement group, of max size 100 virtual machines.
zoneBalance	boolean	No	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
platformFaultDomainCount	integer	No	Fault Domain count for each placement group.
proximityPlacementGroup	object	No	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01. - SubResource object

VirtualMachineScaleSetIdentity object

Name	Type	Required	Value
type	enum	No	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. - SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None
identityIds	array	No	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}'. - string

UpgradePolicy object

Name	Type	Required	Value
mode	enum	No	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. - Automatic, Manual, Rolling
rollingUpgradePolicy	object	No	The configuration parameters used while performing a rolling upgrade. - RollingUpgradePolicy object
automaticOSUpgrade	boolean	No	Whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the image becomes available.
autoOSUpgradePolicy	object	No	Configuration parameters used for performing automatic OS Upgrade. - AutoOSUpgradePolicy object

VirtualMachineScaleSetVMProfile object

Name	Type	Required	Value
osProfile	object	No	Specifies the operating system settings for the virtual machines in the scale set. - VirtualMachineScaleSetOSProfile object
storageProfile	object	No	Specifies the storage settings for the virtual machine disks. - VirtualMachineScaleSetStorageProfile object
networkProfile	object	No	Specifies properties of the network interfaces of the virtual machines in the scale set. - VirtualMachineScaleSetNetworkProfile object
diagnosticsProfile	object	No	Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. - DiagnosticsProfile object
extensionProfile	object	No	Specifies a collection of settings for extensions installed on virtual machines in the scale set. - VirtualMachineScaleSetExtensionProfile object
licenseType	string	No	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
priority	enum	No	Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. - Regular or Low
evictionPolicy	enum	No	Specifies the eviction policy for virtual machines in a low priority scale set. Minimum api-version: 2017-10-30-preview. - Deallocate or Delete

SubResource object

Name	Type	Required	Value
id	string	No	Resource Id

RollingUpgradePolicy object

Name	Type	Required	Value
maxBatchInstancePercent	integer	No	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	No	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	No	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	No	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).

AutoOSUpgradePolicy object

Name	Type	Required	Value
disableAutoRollback	boolean	No	Whether OS image rollback feature should be disabled. Default value is false.

VirtualMachineScaleSetOSProfile object

Name	Type	Required	Value
computerNamePrefix	string	No	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.
adminUsername	string	No	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
adminPassword	string	No	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
customData	string	No	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
windowsConfiguration	object	No	Specifies Windows operating system settings on the virtual machine. - WindowsConfiguration object
linuxConfiguration	object	No	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. - LinuxConfiguration object
secrets	array	No	Specifies set of certificates that should be installed onto the virtual machines in the scale set. - VaultSecretGroup object

VirtualMachineScaleSetStorageProfile object

Name	Type	Required	Value
imageReference	object	No	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. - ImageReference object
osDisk	object	No	Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines. - VirtualMachineScaleSetOSDisk object
dataDisks	array	No	Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see About disks and VHDs for Azure virtual machines. - VirtualMachineScaleSetDataDisk object

VirtualMachineScaleSetNetworkProfile object

Name	Type	Required	Value
healthProbe	object	No	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}'. - ApiEntityReference object
networkInterfaceConfigurations	array	No	The list of network configurations. - VirtualMachineScaleSetNetworkConfiguration object

DiagnosticsProfile object

Name	Type	Required	Value
bootDiagnostics	object	No	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. - BootDiagnostics object

VirtualMachineScaleSetExtensionProfile object

Name	Type	Required	Value
extensions	array	No	The virtual machine scale set child extension resources. - VirtualMachineScaleSetExtension object

WindowsConfiguration object

Name	Type	Required	Value
provisionVMAgent	boolean	No	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.
enableAutomaticUpdates	boolean	No	Indicates whether virtual machine is enabled for automatic updates.
timeZone	string	No	Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"
additionalUnattendContent	array	No	Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. - AdditionalUnattendContent object
winRM	object	No	Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. - WinRMConfiguration object

LinuxConfiguration object

Name	Type	Required	Value
disablePasswordAuthentication	boolean	No	Specifies whether password authentication should be disabled.
ssh	object	No	Specifies the ssh key configuration for a Linux OS. - SshConfiguration object

VaultSecretGroup object

Name	Type	Required	Value
sourceVault	object	No	The relative URL of the Key Vault containing all of the certificates in VaultCertificates. - SubResource object
vaultCertificates	array	No	The list of key vault references in SourceVault which contain certificates. - VaultCertificate object

ImageReference object

Name	Type	Required	Value
id	string	No	Resource Id
publisher	string	No	The image publisher.
offer	string	No	Specifies the offer of the platform image or marketplace image used to create the virtual machine.
sku	string	No	The image SKU.
version	string	No	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.

VirtualMachineScaleSetOSDisk object

Name	Type	Required	Value
name	string	No	The disk name.
caching	enum	No	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. - None, ReadOnly, ReadWrite
writeAcceleratorEnabled	boolean	No	Specifies whether writeAccelerator should be enabled or disabled on the disk.
createOption	enum	Yes	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. - FromImage, Empty, Attach
diskSizeGB	integer	No	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. This value cannot be larger than 1023 GB
osType	enum	No	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. - Windows or Linux
image	object	No	Specifies information about the unmanaged user image to base the scale set on. - VirtualHardDisk object
vhdContainers	array	No	Specifies the container urls that are used to store operating system disks for the scale set. - string
managedDisk	object	No	The managed disk parameters. - VirtualMachineScaleSetManagedDiskParameters object

VirtualMachineScaleSetDataDisk object

Name	Type	Required	Value
name	string	No	The disk name.
lun	integer	Yes	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.
caching	enum	No	Specifies the caching requirements. Possible values are: None ReadOnly ReadWrite Default: None for Standard storage. ReadOnly for Premium storage. - None, ReadOnly, ReadWrite
writeAcceleratorEnabled	boolean	No	Specifies whether writeAccelerator should be enabled or disabled on the disk.
createOption	enum	Yes	The create option. - FromImage, Empty, Attach
diskSizeGB	integer	No	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
managedDisk	object	No	The managed disk parameters. - VirtualMachineScaleSetManagedDiskParameters object

ApiEntityReference object

Name	Type	Required	Value
id	string	No	The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

VirtualMachineScaleSetNetworkConfiguration object

Name	Type	Required	Value
id	string	No	Resource Id
name	string	Yes	The network configuration name.
properties	object	No	VirtualMachineScaleSetNetworkConfigurationProperties object

BootDiagnostics object

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

VirtualMachineScaleSetExtension object

Name	Type	Required	Value
name	string	No	The name of the extension.
properties	object	No	VirtualMachineScaleSetExtensionProperties object

AdditionalUnattendContent object

Name	Type	Required	Value
passName	enum	No	The pass name. Currently, the only allowable value is OobeSystem. - OobeSystem
componentName	enum	No	The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. - Microsoft-Windows-Shell-Setup
settingName	enum	No	Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. - AutoLogon or FirstLogonCommands
content	string	No	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.

WinRMConfiguration object

Name	Type	Required	Value
listeners	array	No	The list of Windows Remote Management listeners - WinRMListener object

SshConfiguration object

Name	Type	Required	Value
publicKeys	array	No	The list of SSH public keys used to authenticate with linux based VMs. - SshPublicKey object

VaultCertificate object

Name	Type	Required	Value
certificateUrl	string	No	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":"" }
certificateStore	string	No	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.

VirtualHardDisk object

Name	Type	Required	Value
uri	string	No	Specifies the virtual hard disk's uri.

VirtualMachineScaleSetManagedDiskParameters object

Name	Type	Required	Value
storageAccountType	enum	No	Specifies the storage account type for the managed disk. Possible values are: Standard_LRS, Premium_LRS, and StandardSSD_LRS. - Standard_LRS, Premium_LRS, StandardSSD_LRS

VirtualMachineScaleSetNetworkConfigurationProperties object

Name	Type	Required	Value
primary	boolean	No	Specifies the primary network interface in case the virtual machine has more than 1 network interface.
enableAcceleratedNetworking	boolean	No	Specifies whether the network interface is accelerated networking-enabled.
networkSecurityGroup	object	No	The network security group. - SubResource object
dnsSettings	object	No	The dns settings to be applied on the network interfaces. - VirtualMachineScaleSetNetworkConfigurationDnsSettings object
ipConfigurations	array	Yes	Specifies the IP configurations of the network interface. - VirtualMachineScaleSetIPConfiguration object
enableIPForwarding	boolean	No	Whether IP forwarding enabled on this NIC.

VirtualMachineScaleSetExtensionProperties object

Name	Type	Required	Value
publisher	string	No	The name of the extension handler publisher.
type	string	No	Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion	string	No	Specifies the version of the script handler.
autoUpgradeMinorVersion	boolean	No	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.
settings	object	No	Json formatted public settings for the extension.
protectedSettings	object	No	The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

WinRMListener object

Name	Type	Required	Value
protocol	enum	No	Specifies the protocol of listener. Possible values are: http https. - Http or Https
certificateUrl	string	No	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":"" }

SshPublicKey object

Name	Type	Required	Value
path	string	No	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
keyData	string	No	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.

VirtualMachineScaleSetNetworkConfigurationDnsSettings object

Name	Type	Required	Value
dnsServers	array	No	List of DNS servers IP addresses - string

VirtualMachineScaleSetIPConfiguration object

Name	Type	Required	Value
id	string	No	Resource Id
name	string	Yes	The IP configuration name.
properties	object	No	VirtualMachineScaleSetIPConfigurationProperties object

VirtualMachineScaleSetIPConfigurationProperties object

Name	Type	Required	Value
subnet	object	No	Specifies the identifier of the subnet. - ApiEntityReference object
primary	boolean	No	Specifies the primary network interface in case the virtual machine has more than 1 network interface.
publicIPAddressConfiguration	object	No	The publicIPAddressConfiguration. - VirtualMachineScaleSetPublicIPAddressConfiguration object
privateIPAddressVersion	enum	No	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'. - IPv4 or IPv6
applicationGatewayBackendAddressPools	array	No	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. - SubResource object
loadBalancerBackendAddressPools	array	No	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. - SubResource object
loadBalancerInboundNatPools	array	No	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 - SubResource object

VirtualMachineScaleSetPublicIPAddressConfiguration object

Name	Type	Required	Value
name	string	Yes	The publicIP address configuration name.
properties	object	No	VirtualMachineScaleSetPublicIPAddressConfigurationProperties object

VirtualMachineScaleSetPublicIPAddressConfigurationProperties object

Name	Type	Required	Value
idleTimeoutInMinutes	integer	No	The idle timeout of the public IP address.
dnsSettings	object	No	The dns settings to be applied on the publicIP addresses . - VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object
ipTags	array	No	The list of IP tags associated with the public IP address. - VirtualMachineScaleSetIpTag object

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings object

Name	Type	Required	Value
domainNameLabel	string	Yes	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

VirtualMachineScaleSetIpTag object

Name	Type	Required	Value
ipTagType	string	No	IP tag type. Example: FirstPartyUsage.
tag	string	No	IP tag associated with the public IP. Example: SQL, Storage etc.

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Azure Container Service Engine (acs-engine) - Swarm Mode	The Azure Container Service Engine (acs-engine) generates ARM (Azure Resource Manager) templates for Docker enabled clusters on Microsoft Azure with your choice of DC/OS, Kubernetes, Swarm Mode, or Swarm orchestrators. The input to the tool is a cluster definition. The cluster definition is very similar to (in many cases the same as) the ARM template syntax used to deploy a Microsoft Azure Container Service cluster.
VMSS with Public IP Prefix	Template for deploying VMSS with Public IP Prefix
Disable encryption on an existing Linux VMSS	Disables encryption on an existing Linux VMSS
Enable data volume encryption on a running Linux VMSS	Enables data volume encryption on a running Linux VMSS
Create and encrypt a new Linux VMSS with jumpbox	This template deploys a Linux VMSS using the latest Linux image, adds data volumes, and then encrypts the data volumes of each Linux VMSS instance. It also deploys a jumpbox with a public IP address in the same virtual network as the Linux VMSS instances with private IP addresses. This allows connecting to the jumpbox via its public IP address, and then connecting to the Linux VMSS instances via private IP addresses.
Create and encrypt a new Windows VMSS with jumpbox	This template allows you to deploy a simple VM Scale Set of Windows VMs using the lastest patched version of serveral Windows versions. This template also deploys a jumpbox with a public IP address in the same virtual network. You can connect to the jumpbox via this public IP address, then connect from there to VMs in the scale set via private IP addresses.This template enables encryption on the VM Scale Set of Windows VMs.
Deploy VM Scale Set with LB probe and automatic repairs	This template allows you to deploy a VM scale set of Linux VMs behind a load balancer with health probe configured. The scale set also has automatic instance repairs policy enabled with a grace period of 30 minutes.
Deploy a VMSS that connects each VM to an Azure Files share	This template deploys an Ubuntu Virtual Machine Scale Set and uses a custom script extension to connect each VM to an Azure Files share
Deploy VM Scale Set with Python Bottle server & AutoScale	Deploy a VM Scale Set behind a load balancer/NAT & each VM running a simple Python Bottle app that does work. With Autoscale configured Scale Set will scale out & in as needed
VM Scale Set from a Managed Image connected to an existing Virtual Network and Application Gateway	This template deploys a VM Scale Set based on an existing Managed Image, connected to an existing Virtual Network and existing Application Gateway Backend Pool.
Deploy a Windows VM Scale Set with a Custom Script Extension	This template allows you to deploy a VM Scale Set of Windows VMs using the lastest patched version of various Windows Versions. These VMs have a custom script extension for customization and are behind a load balancer with NAT rules for rdp connections.
Deploy a VM Scale Set from the Azure Data Science VM	These templates deploy VM scale sets, using the Azure Data Science VMs as a source image.
Deploy a Scale Set into an existing vnet	This template deploys a VM Scale Set into an exsisting vnet.
Deploy a VM Scale Set with Linux VMs behind ILB	This template allows you to deploy a VM Scale Set of Linux VMs using the latest patched version of Ubuntu Linux 15.10 or 14.04.4-LTS. These VMs are behind an internal load balancer with NAT rules for ssh connections.
Deploy a VM Scale Set with a Linux custom image	This template allows you to deploy a custom VM Linux image inside an Scale Set. These VMs are behind a load balancer with HTTP load balancing (by default on port 80). The example uses a custom script to do the application deployment and update, you may have to provide your custom script for your own update procedure. You will have to provide a generalized image of your VM in the same subscription and region where you create the VMSS.
Deploy a simple VM Scale Set with Linux VMs and a Jumpbox	This template allows you to deploy a simple VM Scale Set of Linux VMs using the latest patched version of Ubuntu Linux 15.10 or 14.04.4-LTS. There is also a jumpbox to enable connections from outside of the VNet the VMs are in.
Deploy a simple VM Scale Set with Linux VMs	This template allows you to deploy a simple VM Scale Set of Linux VMs using the latest patched version of Ubuntu Linux 14.04.4-LTS or 16.04-LTS. These VMs are behind a load balancer with NAT rules for ssh connections.
Deploy a VM Scale Set with Linux VMs in Availabilty Zones	This template allows you to deploy a simple VM Scale Set of Linux VMs using the latest patched version of Ubuntu Linux 14.04.4-LTS or 16.04-LTS. These VMs are behind a load balancer with NAT rules for ssh connections.
Deploy a Linux VMSS wth master/slave architecture	This template allows you to deploy a Linux VMSS with a Custom Script Extension in master slave architecture
Deploy a simple VM Scale Set with Linux VMs and public IPv4 per VM	This template demonstrates deploying a simple scale set with load balancer, inbound NAT rules, and public IP per VM.
Manually change the number of VMs in a Scale Set.	This template allows you to manually change the number of VMs in a Scale Set.
Deploy an Ubuntu VM scale set with Azure Application Gateway	This template allows you to deploy a simple Ubuntu VM Scale Set integrated with Azure Application Gateway, and supports up to 1000 VMs
Deploy a VM Scale Set with Linux VMs and Auto Scale	This template allows you to deploy a simple VM Scale Set of Linux VMs using the latest patched version of Ubuntu Linux 15.04 or 14.04.4-LTS. These VMs are behind a load balancer with NAT rules for ssh connections.They also have Auto Scale integrated
VM Scale Set web serverswith git pull deployment	VM Scale Set web servers pulling content securely from git using ssh deployment keys
SSL enabled VM Scale Set	Deploys web servers configures with SSL certificates deployed securely form Azure Key Vault
Deploy a Windows VM scale set with Azure Application Gateway	This template allows you to deploy a simple Windows VM Scale Set integrated with Azure Application Gateway, and supports up to 1000 VMs
Deploy a VM Scale Set with Windows VMs and Auto Scale	This template allows you to deploy a simple VM Scale Set of Windows VMs using the latest patched version of Windows 2008-R2-SP1, 2012-Datacenter, or 2012-R2-Datacenter. These VMs are behind a load balancer with NAT rules for RDP connections. They also have Auto Scale integrated
Deploy a VM Scale Set with a Windows custom image	This template allows you to deploy a simple VM Scale Set usng a custom Windows image. These VMs are behind a load balancer with HTTP load balancing (by default on port 80)
Deploy a simple VM Scale Set with Windows VMs and a Jumpbox	This template allows you to deploy a simple VM Scale Set of Windows VMs using the lastest patched version of serveral Windows versions. This template also deploys a jumpbox with a public IP address in the same virtual network. You can connect to the jumpbox via this public IP address, then connect from there to VMs in the scale set via private IP addresses.
Deploy a simple VM Scale Set with Windows VMs	This template allows you to deploy a simple VM Scale Set of Windows VMs using the lastest patched version of various Windows Versions. These VMs are behind a load balancer with NAT rules for rdp connections.
Deploy a VM Scale Set with Windows VMs in Availability Zones	This template allows you to deploy a VM Scale Set of Windows VMs using the lastest patched version of various Windows Versions. These VMs are behind a load balancer with NAT rules for rdp connections.
VM Scale Set with autoscale running an IIS WebApp	Deploys a Windows VM Scale Set running IIS and a very basic .NET MVC web app. The VMSS PowerShell DSC Extension is leveraged to do the IIS install and WebDeploy package deployment.
Deploy a Scale Set into an existing vnet	This template deploys a Windows 2016 Datacenter VM Scale Set into an exsisting resource group, vnet and subnet.
Deploy Windows VMSS configure windows featurtes SSL DSC	This template allows you to deploy two Windows VMSS, configure windows features like IIS/Web Role, .Net Framework 4.5, windows auth, application initialization, download application deployment packages, URL Rewrite & SSL configuration using DSC and Azure Key Vault
Add multiple VMs into a Virtual Machine Scale Set	This template will create N number of VM's with managed disks, public IPs and network interfaces. It will create the VMs in a Virtula Machine Scale Set. They will be provisioned in a Virtual Network which will also be created as part of the deployment