Microsoft.Compute virtualMachineScaleSets/virtualmachines 2020-06-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.Compute/virtualMachineScaleSets/virtualmachines",
  "apiVersion": "2020-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "hardwareProfile": {
      "vmSize": "string"
    },
    "storageProfile": {
      "imageReference": {
        "id": "string",
        "publisher": "string",
        "offer": "string",
        "sku": "string",
        "version": "string"
      },
      "osDisk": {
        "osType": "string",
        "encryptionSettings": {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "enabled": "boolean"
        },
        "name": "string",
        "vhd": {
          "uri": "string"
        },
        "image": {
          "uri": "string"
        },
        "caching": "string",
        "writeAcceleratorEnabled": "boolean",
        "diffDiskSettings": {
          "option": "Local",
          "placement": "string"
        },
        "createOption": "string",
        "diskSizeGB": "integer",
        "managedDisk": {
          "id": "string",
          "storageAccountType": "string",
          "diskEncryptionSet": {
            "id": "string"
          }
        }
      },
      "dataDisks": [
        {
          "lun": "integer",
          "name": "string",
          "vhd": {
            "uri": "string"
          },
          "image": {
            "uri": "string"
          },
          "caching": "string",
          "writeAcceleratorEnabled": "boolean",
          "createOption": "string",
          "diskSizeGB": "integer",
          "managedDisk": {
            "id": "string",
            "storageAccountType": "string",
            "diskEncryptionSet": {
              "id": "string"
            }
          },
          "toBeDetached": "boolean"
        }
      ]
    },
    "additionalCapabilities": {
      "ultraSSDEnabled": "boolean"
    },
    "osProfile": {
      "computerName": "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"
          }
        ],
        "patchSettings": {
          "patchMode": "string"
        },
        "winRM": {
          "listeners": [
            {
              "protocol": "string",
              "certificateUrl": "string"
            }
          ]
        }
      },
      "linuxConfiguration": {
        "disablePasswordAuthentication": "boolean",
        "ssh": {
          "publicKeys": [
            {
              "path": "string",
              "keyData": "string"
            }
          ]
        },
        "provisionVMAgent": "boolean"
      },
      "secrets": [
        {
          "sourceVault": {
            "id": "string"
          },
          "vaultCertificates": [
            {
              "certificateUrl": "string",
              "certificateStore": "string"
            }
          ]
        }
      ],
      "allowExtensionOperations": "boolean",
      "requireGuestProvisionSignal": "boolean"
    },
    "securityProfile": {
      "encryptionAtHost": "boolean"
    },
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "string",
          "properties": {
            "primary": "boolean"
          }
        }
      ]
    },
    "networkProfileConfiguration": {
      "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"
                        }
                      ],
                      "publicIPPrefix": {
                        "id": "string"
                      },
                      "publicIPAddressVersion": "string"
                    }
                  },
                  "privateIPAddressVersion": "string",
                  "applicationGatewayBackendAddressPools": [
                    {
                      "id": "string"
                    }
                  ],
                  "applicationSecurityGroups": [
                    {
                      "id": "string"
                    }
                  ],
                  "loadBalancerBackendAddressPools": [
                    {
                      "id": "string"
                    }
                  ],
                  "loadBalancerInboundNatPools": [
                    {
                      "id": "string"
                    }
                  ]
                }
              }
            ],
            "enableIPForwarding": "boolean"
          }
        }
      ]
    },
    "diagnosticsProfile": {
      "bootDiagnostics": {
        "enabled": "boolean",
        "storageUri": "string"
      }
    },
    "availabilitySet": {
      "id": "string"
    },
    "licenseType": "string",
    "protectionPolicy": {
      "protectFromScaleIn": "boolean",
      "protectFromScaleSetActions": "boolean"
    }
  },
  "plan": {
    "name": "string",
    "publisher": "string",
    "product": "string",
    "promotionCode": "string"
  }
}

Property values

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

Microsoft.Compute/virtualMachineScaleSets/virtualmachines object

Name Type Required Value
name string Yes The name of the virtual machine.
type enum Yes virtualmachines
-or-
Microsoft.Compute/virtualMachineScaleSets/virtualmachines

See Set name and type for child resources.
apiVersion enum Yes 2020-06-01
location string Yes Resource location
tags object No Resource tags
properties object Yes VirtualMachineScaleSetVMProperties 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

VirtualMachineScaleSetVMProperties object

Name Type Required Value
hardwareProfile object No Specifies the hardware settings for the virtual machine. - HardwareProfile object
storageProfile object No Specifies the storage settings for the virtual machine disks. - StorageProfile object
additionalCapabilities object No Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type. - AdditionalCapabilities object
osProfile object No Specifies the operating system settings for the virtual machine. - OSProfile object
securityProfile object No Specifies the Security related profile settings for the virtual machine. - SecurityProfile object
networkProfile object No Specifies the network interfaces of the virtual machine. - NetworkProfile object
networkProfileConfiguration object No Specifies the network profile configuration of the virtual machine. - VirtualMachineScaleSetVMNetworkProfileConfiguration object
diagnosticsProfile object No Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15. - DiagnosticsProfile object
availabilitySet object No Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see Manage the availability of virtual machines.

For more information on Azure planned maintenance, see Planned maintenance for virtual machines in Azure

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set. - SubResource 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
protectionPolicy object No Specifies the protection policy of the virtual machine. - VirtualMachineScaleSetVMProtectionPolicy object

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.

HardwareProfile object

Name Type Required Value
vmSize enum No Specifies the size of the virtual machine. For more information about virtual machine sizes, see Sizes for virtual machines.

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

List all available virtual machine sizes in an availability set

List all available virtual machine sizes in a region

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

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

For more information about disks, see About disks and VHDs for Azure virtual machines. - OSDisk object
dataDisks array No Specifies the parameters that are used to add a data disk to a virtual machine.

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

AdditionalCapabilities object

Name Type Required Value
ultraSSDEnabled boolean No The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled.

OSProfile object

Name Type Required Value
computerName string No Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

Max-length (Windows): 15 characters

Max-length (Linux): 64 characters.

For naming conventions and restrictions see Azure infrastructure services implementation guidelines.
adminUsername string No Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

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.

    Note: Do not pass any secrets or passwords in customData property

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see Custom Data on Azure VMs

    For using cloud-init for your Linux 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 machine. - VaultSecretGroup object
    allowExtensionOperations boolean No Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine.
    requireGuestProvisionSignal boolean No Specifies whether the guest provision signal is required to infer provision success of the virtual machine. Note: This property is for private testing only, and all customers must not set the property to false.

    SecurityProfile object

    Name Type Required Value
    encryptionAtHost boolean No This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

    Default: The Encryption at host will be disabled unless this property is set to true for the resource.

    NetworkProfile object

    Name Type Required Value
    networkInterfaces array No Specifies the list of resource Ids for the network interfaces associated with the virtual machine. - NetworkInterfaceReference object

    VirtualMachineScaleSetVMNetworkProfileConfiguration object

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

    SubResource object

    Name Type Required Value
    id string No Resource Id

    VirtualMachineScaleSetVMProtectionPolicy object

    Name Type Required Value
    protectFromScaleIn boolean No Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation.
    protectFromScaleSetActions boolean No Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM.

    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.

    OSDisk object

    Name Type Required Value
    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
    encryptionSettings object No Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15 - DiskEncryptionSettings object
    name string No The disk name.
    vhd object No The virtual hard disk. - VirtualHardDisk object
    image object No The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - VirtualHardDisk object
    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.
    diffDiskSettings object No Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. - DiffDiskSettings object
    createOption enum Yes 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. - 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. - ManagedDiskParameters object

    DataDisk object

    Name Type Required Value
    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.
    name string No The disk name.
    vhd object No The virtual hard disk. - VirtualHardDisk object
    image object No The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. - VirtualHardDisk object
    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 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. - 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. - ManagedDiskParameters object
    toBeDetached boolean No Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset

    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 Automatic Updates is enabled for the Windows virtual machine. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning.
    timeZone string No Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time".

    Possible values can be TimeZoneInfo.Id value from time zones returned by TimeZoneInfo.GetSystemTimeZones.
    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
    patchSettings object No Specifies settings related to in-guest patching (KBs). - PatchSettings 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
    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.

    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

    NetworkInterfaceReference object

    Name Type Required Value
    id string No Resource Id
    properties object No NetworkInterfaceReferenceProperties object

    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.

    If storageUri is not specified while enabling boot diagnostics, managed storage will be used.

    DiskEncryptionSettings object

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

    VirtualHardDisk object

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

    DiffDiskSettings object

    Name Type Required Value
    option enum No Specifies the ephemeral disk settings for operating system disk. - Local
    placement enum No Specifies the ephemeral disk placement for operating system disk.

    Possible values are:

    CacheDisk

    ResourceDisk

    Default: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used.

    Refer to VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. - CacheDisk or ResourceDisk

    ManagedDiskParameters object

    Name Type Required Value
    id string No Resource Id
    storageAccountType enum No Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. - Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS
    diskEncryptionSet object No Specifies the customer managed disk encryption set resource id for the managed disk. - DiskEncryptionSetParameters 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.

    PatchSettings object

    Name Type Required Value
    patchMode enum No Specifies the mode of in-guest patching to IaaS virtual machine.

    Possible values are:

    Manual - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    AutomaticByOS - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    ** AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true. - Manual, AutomaticByOS, AutomaticByPlatform

    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.

    NetworkInterfaceReferenceProperties object

    Name Type Required Value
    primary boolean No Specifies the primary network interface in case the virtual machine has more than 1 network interface.

    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.

    KeyVaultSecretReference object

    Name Type Required Value
    secretUrl string Yes The URL referencing a secret in a Key Vault.
    sourceVault object Yes The relative URL of the Key Vault containing the secret. - SubResource object

    KeyVaultKeyReference object

    Name Type Required Value
    keyUrl string Yes The URL referencing a key encryption key in Key Vault.
    sourceVault object Yes The relative URL of the Key Vault containing the key. - SubResource object

    DiskEncryptionSetParameters object

    Name Type Required Value
    id string No Resource Id

    WinRMListener object

    Name Type Required Value
    protocol enum No Specifies the protocol of WinRM 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
    applicationSecurityGroups array No Specifies an array of references to application security group. - 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 basic sku 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 basic sku load balancer. - SubResource object

    ApiEntityReference object

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

    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
    publicIPPrefix object No The PublicIPPrefix from which to allocate publicIP addresses. - SubResource object
    publicIPAddressVersion enum No Available from Api-Version 2019-07-01 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

    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.