VirtualMachineScaleSets class

Class representing a VirtualMachineScaleSets.

Constructors

VirtualMachineScaleSets(client)

Create a VirtualMachineScaleSets.

new VirtualMachineScaleSets(client)
Parameters
client
undefinedComputeManagementClient

Reference to the service client.

Methods

beginCreateOrUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)

Create or update a VM scale set.

function beginCreateOrUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)
Parameters
resourceGroupName
string

The name of the resource group.

vmScaleSetName
string

The name of the VM scale set to create or update.

parameters
object

The scale set object.

NameRequiredTypeDescription
sku object

The virtual machine scale set sku.

plan object

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.

upgradePolicy object

The upgrade policy.

virtualMachineProfile object

The virtual machine profile.

overprovision boolean

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

singlePlacementGroup boolean

When true this limits the scale set to a single placement group, of max size 100 virtual machines.

zoneBalance boolean

Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage.

platformFaultDomainCount number

Fault Domain count for each placement group.

identity object

The identity of the virtual machine scale set, if configured.

zones array

The virtual machine scale set zones.

location true string

Resource location

tags object

Resource tags

sku
object

The virtual machine scale set sku.

NameRequiredTypeDescription
name string

The sku name.

tier string

Specifies the tier of virtual machines in a scale set.

Possible Values:

Standard

Basic

capacity number

Specifies the number of virtual machines in the scale set.

plan
object

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.

NameRequiredTypeDescription
name string

The plan ID.

publisher string

The publisher 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.

upgradePolicy
object

The upgrade policy.

NameRequiredTypeDescription
mode string

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. Possible values include: 'Automatic', 'Manual', 'Rolling'

rollingUpgradePolicy object

The configuration parameters used while performing a rolling 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.

rollingUpgradePolicy
object

The configuration parameters used while performing a rolling upgrade.

NameRequiredTypeDescription
maxBatchInstancePercent number

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 number

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 number

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

virtualMachineProfile
object

The virtual machine profile.

NameRequiredTypeDescription
osProfile object

Specifies the operating system settings for the virtual machines in the scale set.

storageProfile object

Specifies the storage settings for the virtual machine disks.

networkProfile object

Specifies properties of the network interfaces of the virtual machines in the scale set.

diagnosticsProfile object

Specifies the boot diagnostic settings state.

Minimum api-version: 2015-06-15.

extensionProfile object

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.

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 string

Specifies the priority for the virtual machines in the scale set.

Minimum api-version: 2017-10-30-preview. Possible values include: 'Regular', 'Low'

osProfile
object

Specifies the operating system settings for the virtual machines in the scale set.

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

adminUsername string

Specifies the name of the administrator account.

Windows-only restriction: Cannot end in "."

Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Minimum-length (Linux): 1 character

Max-length (Linux): 64 characters

Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • adminPassword string

    Specifies the password of the administrator account.

    Minimum-length (Windows): 8 characters

    Minimum-length (Linux): 6 characters

    Max-length (Windows): 123 characters

    Max-length (Linux): 72 characters

    Complexity requirements: 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

    For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

    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.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    windowsConfiguration object

    Specifies Windows operating system settings on the virtual machine.

    linuxConfiguration object

    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.

    secrets array

    Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    object

    Specifies Windows operating system settings on the virtual machine.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    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.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    Specifies the storage settings for the virtual machine disks.

    NameRequiredTypeDescription
    imageReference object

    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 object

    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.

    dataDisks array

    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.

    imageReference
    object

    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.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    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.

    NameRequiredTypeDescription
    name string

    The disk name.

    caching string

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    createOption true string

    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. Possible values include: 'FromImage', 'Empty', 'Attach'

    osType string

    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. Possible values include: 'Windows', 'Linux'

    image object

    Specifies information about the unmanaged user image to base the scale set on.

    vhdContainers array

    Specifies the container urls that are used to store operating system disks for the scale set.

    managedDisk object

    The managed disk parameters.

    image
    object

    Specifies information about the unmanaged user image to base the scale set on.

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    NameRequiredTypeDescription
    healthProbe object

    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 array

    The list of network configurations.

    healthProbe
    object

    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}'.

    NameRequiredTypeDescription
    id string

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

    diagnosticsProfile
    object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSet for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSet>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)

    Create or update a VM scale set.

    function beginCreateOrUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    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.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    zoneBalance boolean

    Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    platformFaultDomainCount number

    Fault Domain count for each placement group.

    identity object

    The identity of the virtual machine scale set, if configured.

    zones array

    The virtual machine scale set zones.

    location true string

    Resource location

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    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.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    Specifies the operating system settings for the virtual machines in the scale set.

    storageProfile object

    Specifies the storage settings for the virtual machine disks.

    networkProfile object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    diagnosticsProfile object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    extensionProfile object

    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.

    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 string

    Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Regular', 'Low'

    osProfile
    object

    Specifies the operating system settings for the virtual machines in the scale set.

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

    adminUsername string

    Specifies the name of the administrator account.

    Windows-only restriction: Cannot end in "."

    Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    Minimum-length (Linux): 1 character

    Max-length (Linux): 64 characters

    Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • adminPassword string

    Specifies the password of the administrator account.

    Minimum-length (Windows): 8 characters

    Minimum-length (Linux): 6 characters

    Max-length (Windows): 123 characters

    Max-length (Linux): 72 characters

    Complexity requirements: 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

    For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

    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.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    windowsConfiguration object

    Specifies Windows operating system settings on the virtual machine.

    linuxConfiguration object

    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.

    secrets array

    Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    object

    Specifies Windows operating system settings on the virtual machine.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    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.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    Specifies the storage settings for the virtual machine disks.

    NameRequiredTypeDescription
    imageReference object

    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 object

    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.

    dataDisks array

    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.

    imageReference
    object

    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.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    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.

    NameRequiredTypeDescription
    name string

    The disk name.

    caching string

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    createOption true string

    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. Possible values include: 'FromImage', 'Empty', 'Attach'

    osType string

    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. Possible values include: 'Windows', 'Linux'

    image object

    Specifies information about the unmanaged user image to base the scale set on.

    vhdContainers array

    Specifies the container urls that are used to store operating system disks for the scale set.

    managedDisk object

    The managed disk parameters.

    image
    object

    Specifies information about the unmanaged user image to base the scale set on.

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    NameRequiredTypeDescription
    healthProbe object

    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 array

    The list of network configurations.

    healthProbe
    object

    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}'.

    NameRequiredTypeDescription
    id string

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

    diagnosticsProfile
    object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginDeallocate(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    function beginDeallocate(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginDeallocateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    function beginDeallocateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginDeleteInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)

    Deletes virtual machines in a VM scale set.

    function beginDeleteInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginDeleteInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)

    Deletes virtual machines in a VM scale set.

    function beginDeleteInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginDeleteMethod(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Deletes a VM scale set.

    function beginDeleteMethod(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginDeleteMethodWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Deletes a VM scale set.

    function beginDeleteMethodWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginPerformMaintenance(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Perform maintenance on one or more virtual machines in a VM scale set.

    function beginPerformMaintenance(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginPerformMaintenanceWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Perform maintenance on one or more virtual machines in a VM scale set.

    function beginPerformMaintenanceWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginPowerOff(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    function beginPowerOff(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginPowerOffWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    function beginPowerOffWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginRedeploy(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Redeploy one or more virtual machines in a VM scale set.

    function beginRedeploy(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginRedeployWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Redeploy one or more virtual machines in a VM scale set.

    function beginRedeployWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginReimage(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    function beginReimage(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginReimageAll(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    function beginReimageAll(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginReimageAllWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    function beginReimageAllWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginReimageWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    function beginReimageWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginRestart(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Restarts one or more virtual machines in a VM scale set.

    function beginRestart(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginRestartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Restarts one or more virtual machines in a VM scale set.

    function beginRestartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginStart(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Starts one or more virtual machines in a VM scale set.

    function beginStart(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginStartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Starts one or more virtual machines in a VM scale set.

    function beginStartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)

    Update a VM scale set.

    function beginUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    identity object

    The identity of the virtual machine scale set, if configured.

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    The virtual machine scale set OS profile.

    storageProfile object

    The virtual machine scale set storage profile.

    networkProfile object

    The virtual machine scale set network profile.

    diagnosticsProfile object

    The virtual machine scale set diagnostics profile.

    extensionProfile object

    The virtual machine scale set extension profile.

    licenseType string

    The license type, which is for bring your own license scenario.

    osProfile
    object

    The virtual machine scale set OS profile.

    NameRequiredTypeDescription
    customData string

    A base-64 encoded string of custom data.

    windowsConfiguration object

    The Windows Configuration of the OS profile.

    linuxConfiguration object

    The Linux Configuration of the OS profile.

    secrets array

    The List of certificates for addition to the VM.

    windowsConfiguration
    object

    The Windows Configuration of the OS profile.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    The Linux Configuration of the OS profile.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    The virtual machine scale set storage profile.

    NameRequiredTypeDescription
    imageReference object

    The image reference.

    osDisk object

    The OS disk.

    dataDisks array

    The data disks.

    imageReference
    object

    The image reference.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    The OS disk.

    NameRequiredTypeDescription
    caching string

    The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    image object

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

    vhdContainers array

    The list of virtual hard disk container uris.

    managedDisk object

    The managed disk parameters.

    image
    object

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

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    The virtual machine scale set network profile.

    NameRequiredTypeDescription
    networkInterfaceConfigurations array

    The list of network configurations.

    diagnosticsProfile
    object

    The virtual machine scale set diagnostics profile.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    The virtual machine scale set extension profile.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSet for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSet>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginUpdateInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)

    Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    function beginUpdateInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    beginUpdateInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)

    Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    function beginUpdateInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    beginUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)

    Update a VM scale set.

    function beginUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    identity object

    The identity of the virtual machine scale set, if configured.

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    The virtual machine scale set OS profile.

    storageProfile object

    The virtual machine scale set storage profile.

    networkProfile object

    The virtual machine scale set network profile.

    diagnosticsProfile object

    The virtual machine scale set diagnostics profile.

    extensionProfile object

    The virtual machine scale set extension profile.

    licenseType string

    The license type, which is for bring your own license scenario.

    osProfile
    object

    The virtual machine scale set OS profile.

    NameRequiredTypeDescription
    customData string

    A base-64 encoded string of custom data.

    windowsConfiguration object

    The Windows Configuration of the OS profile.

    linuxConfiguration object

    The Linux Configuration of the OS profile.

    secrets array

    The List of certificates for addition to the VM.

    windowsConfiguration
    object

    The Windows Configuration of the OS profile.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    The Linux Configuration of the OS profile.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    The virtual machine scale set storage profile.

    NameRequiredTypeDescription
    imageReference object

    The image reference.

    osDisk object

    The OS disk.

    dataDisks array

    The data disks.

    imageReference
    object

    The image reference.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    The OS disk.

    NameRequiredTypeDescription
    caching string

    The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    image object

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

    vhdContainers array

    The list of virtual hard disk container uris.

    managedDisk object

    The managed disk parameters.

    image
    object

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

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    The virtual machine scale set network profile.

    NameRequiredTypeDescription
    networkInterfaceConfigurations array

    The list of network configurations.

    diagnosticsProfile
    object

    The virtual machine scale set diagnostics profile.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    The virtual machine scale set extension profile.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    createOrUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)

    Create or update a VM scale set.

    function createOrUpdate(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    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.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    zoneBalance boolean

    Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    platformFaultDomainCount number

    Fault Domain count for each placement group.

    identity object

    The identity of the virtual machine scale set, if configured.

    zones array

    The virtual machine scale set zones.

    location true string

    Resource location

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    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.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    Specifies the operating system settings for the virtual machines in the scale set.

    storageProfile object

    Specifies the storage settings for the virtual machine disks.

    networkProfile object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    diagnosticsProfile object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    extensionProfile object

    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.

    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 string

    Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Regular', 'Low'

    osProfile
    object

    Specifies the operating system settings for the virtual machines in the scale set.

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

    adminUsername string

    Specifies the name of the administrator account.

    Windows-only restriction: Cannot end in "."

    Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    Minimum-length (Linux): 1 character

    Max-length (Linux): 64 characters

    Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • adminPassword string

    Specifies the password of the administrator account.

    Minimum-length (Windows): 8 characters

    Minimum-length (Linux): 6 characters

    Max-length (Windows): 123 characters

    Max-length (Linux): 72 characters

    Complexity requirements: 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

    For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

    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.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    windowsConfiguration object

    Specifies Windows operating system settings on the virtual machine.

    linuxConfiguration object

    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.

    secrets array

    Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    object

    Specifies Windows operating system settings on the virtual machine.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    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.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    Specifies the storage settings for the virtual machine disks.

    NameRequiredTypeDescription
    imageReference object

    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 object

    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.

    dataDisks array

    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.

    imageReference
    object

    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.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    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.

    NameRequiredTypeDescription
    name string

    The disk name.

    caching string

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    createOption true string

    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. Possible values include: 'FromImage', 'Empty', 'Attach'

    osType string

    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. Possible values include: 'Windows', 'Linux'

    image object

    Specifies information about the unmanaged user image to base the scale set on.

    vhdContainers array

    Specifies the container urls that are used to store operating system disks for the scale set.

    managedDisk object

    The managed disk parameters.

    image
    object

    Specifies information about the unmanaged user image to base the scale set on.

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    NameRequiredTypeDescription
    healthProbe object

    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 array

    The list of network configurations.

    healthProbe
    object

    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}'.

    NameRequiredTypeDescription
    id string

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

    diagnosticsProfile
    object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSet for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSet>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    createOrUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)

    Create or update a VM scale set.

    function createOrUpdateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    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.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    zoneBalance boolean

    Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage.

    platformFaultDomainCount number

    Fault Domain count for each placement group.

    identity object

    The identity of the virtual machine scale set, if configured.

    zones array

    The virtual machine scale set zones.

    location true string

    Resource location

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    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.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    Specifies the operating system settings for the virtual machines in the scale set.

    storageProfile object

    Specifies the storage settings for the virtual machine disks.

    networkProfile object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    diagnosticsProfile object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    extensionProfile object

    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.

    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 string

    Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview. Possible values include: 'Regular', 'Low'

    osProfile
    object

    Specifies the operating system settings for the virtual machines in the scale set.

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

    adminUsername string

    Specifies the name of the administrator account.

    Windows-only restriction: Cannot end in "."

    Disallowed values: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    Minimum-length (Linux): 1 character

    Max-length (Linux): 64 characters

    Max-length (Windows): 20 characters

  • For root access to the Linux VM, see Using root privileges on Linux virtual machines in Azure
  • For a list of built-in system users on Linux that should not be used in this field, see Selecting User Names for Linux on Azure

  • adminPassword string

    Specifies the password of the administrator account.

    Minimum-length (Windows): 8 characters

    Minimum-length (Linux): 6 characters

    Max-length (Windows): 123 characters

    Max-length (Linux): 72 characters

    Complexity requirements: 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    Disallowed values: "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see How to reset the Remote Desktop service or its login password in a Windows VM

    For resetting root password, see Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension

    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.

    For using cloud-init for your VM, see Using cloud-init to customize a Linux VM during creation

    windowsConfiguration object

    Specifies Windows operating system settings on the virtual machine.

    linuxConfiguration object

    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.

    secrets array

    Specifies set of certificates that should be installed onto the virtual machines in the scale set.

    windowsConfiguration
    object

    Specifies Windows operating system settings on the virtual machine.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    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.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    Specifies the storage settings for the virtual machine disks.

    NameRequiredTypeDescription
    imageReference object

    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 object

    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.

    dataDisks array

    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.

    imageReference
    object

    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.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    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.

    NameRequiredTypeDescription
    name string

    The disk name.

    caching string

    Specifies the caching requirements.

    Possible values are:

    None

    ReadOnly

    ReadWrite

    Default: None for Standard storage. ReadOnly for Premium storage. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    createOption true string

    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. Possible values include: 'FromImage', 'Empty', 'Attach'

    osType string

    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. Possible values include: 'Windows', 'Linux'

    image object

    Specifies information about the unmanaged user image to base the scale set on.

    vhdContainers array

    Specifies the container urls that are used to store operating system disks for the scale set.

    managedDisk object

    The managed disk parameters.

    image
    object

    Specifies information about the unmanaged user image to base the scale set on.

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    Specifies properties of the network interfaces of the virtual machines in the scale set.

    NameRequiredTypeDescription
    healthProbe object

    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 array

    The list of network configurations.

    healthProbe
    object

    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}'.

    NameRequiredTypeDescription
    id string

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

    diagnosticsProfile
    object

    Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    Specifies a collection of settings for extensions installed on virtual machines in the scale set.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    deallocate(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    function deallocate(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    deallocateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.

    function deallocateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    deleteInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)

    Deletes virtual machines in a VM scale set.

    function deleteInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    deleteInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)

    Deletes virtual machines in a VM scale set.

    function deleteInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    deleteMethod(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Deletes a VM scale set.

    function deleteMethod(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    deleteMethodWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Deletes a VM scale set.

    function deleteMethodWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, vmScaleSetName, platformUpdateDomain, options, optionalCallback)

    Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

    function forceRecoveryServiceFabricPlatformUpdateDomainWalk(resourceGroupName, vmScaleSetName, platformUpdateDomain, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    platformUpdateDomain
    number

    The platform update domain for which a manual recovery walk is requested

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See RecoveryWalkResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<RecoveryWalkResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    forceRecoveryServiceFabricPlatformUpdateDomainWalkWithHttpOperationResponse(resourceGroupName, vmScaleSetName, platformUpdateDomain, options)

    Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.

    function forceRecoveryServiceFabricPlatformUpdateDomainWalkWithHttpOperationResponse(resourceGroupName, vmScaleSetName, platformUpdateDomain, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    platformUpdateDomain
    number

    The platform update domain for which a manual recovery walk is requested

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    get(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Display information about a virtual machine scale set.

    function get(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSet for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSet>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    getInstanceView(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Gets the status of a VM scale set instance.

    function getInstanceView(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetInstanceView for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetInstanceView>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    getInstanceViewWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Gets the status of a VM scale set instance.

    function getInstanceViewWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    getWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Display information about a virtual machine scale set.

    function getWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    list(resourceGroupName, options, optionalCallback)

    Gets a list of all VM scale sets under a resource group.

    function list(resourceGroupName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    listAll(options, optionalCallback)

    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.

    function listAll(options, optionalCallback)
    Parameters
    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListWithLinkResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListWithLinkResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    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.

    function listAllNext(nextPageLink, options, optionalCallback)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListWithLinkResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListWithLinkResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    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.

    function listAllNextWithHttpOperationResponse(nextPageLink, options)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    listAllWithHttpOperationResponse(options)

    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.

    function listAllWithHttpOperationResponse(options)
    Parameters
    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    Gets a list of all VM scale sets under a resource group.

    function listNext(nextPageLink, options, optionalCallback)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    Gets a list of all VM scale sets under a resource group.

    function listNextWithHttpOperationResponse(nextPageLink, options)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    listSkus(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

    function listSkus(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListSkusResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListSkusResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

    function listSkusNext(nextPageLink, options, optionalCallback)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSetListSkusResult for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSetListSkusResult>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

    function listSkusNextWithHttpOperationResponse(nextPageLink, options)
    Parameters
    nextPageLink
    string

    The NextLink from the previous successful call to List operation.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    listSkusWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.

    function listSkusWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    listWithHttpOperationResponse(resourceGroupName, options)

    Gets a list of all VM scale sets under a resource group.

    function listWithHttpOperationResponse(resourceGroupName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    performMaintenance(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Perform maintenance on one or more virtual machines in a VM scale set.

    function performMaintenance(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    performMaintenanceWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Perform maintenance on one or more virtual machines in a VM scale set.

    function performMaintenanceWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    powerOff(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    function powerOff(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    powerOffWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

    function powerOffWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    redeploy(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Redeploy one or more virtual machines in a VM scale set.

    function redeploy(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    redeployWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Redeploy one or more virtual machines in a VM scale set.

    function redeployWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    reimage(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    function reimage(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    reimageAll(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    function reimageAll(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    reimageAllWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.

    function reimageAllWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    reimageWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.

    function reimageWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    restart(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Restarts one or more virtual machines in a VM scale set.

    function restart(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    restartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Restarts one or more virtual machines in a VM scale set.

    function restartWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    start(resourceGroupName, vmScaleSetName, options, optionalCallback)

    Starts one or more virtual machines in a VM scale set.

    function start(resourceGroupName, vmScaleSetName, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    startWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)

    Starts one or more virtual machines in a VM scale set.

    function startWithHttpOperationResponse(resourceGroupName, vmScaleSetName, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    instanceIds array

    The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    update(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)

    Update a VM scale set.

    function update(resourceGroupName, vmScaleSetName, parameters, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    identity object

    The identity of the virtual machine scale set, if configured.

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    The virtual machine scale set OS profile.

    storageProfile object

    The virtual machine scale set storage profile.

    networkProfile object

    The virtual machine scale set network profile.

    diagnosticsProfile object

    The virtual machine scale set diagnostics profile.

    extensionProfile object

    The virtual machine scale set extension profile.

    licenseType string

    The license type, which is for bring your own license scenario.

    osProfile
    object

    The virtual machine scale set OS profile.

    NameRequiredTypeDescription
    customData string

    A base-64 encoded string of custom data.

    windowsConfiguration object

    The Windows Configuration of the OS profile.

    linuxConfiguration object

    The Linux Configuration of the OS profile.

    secrets array

    The List of certificates for addition to the VM.

    windowsConfiguration
    object

    The Windows Configuration of the OS profile.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    The Linux Configuration of the OS profile.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    The virtual machine scale set storage profile.

    NameRequiredTypeDescription
    imageReference object

    The image reference.

    osDisk object

    The OS disk.

    dataDisks array

    The data disks.

    imageReference
    object

    The image reference.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    The OS disk.

    NameRequiredTypeDescription
    caching string

    The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    image object

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

    vhdContainers array

    The list of virtual hard disk container uris.

    managedDisk object

    The managed disk parameters.

    image
    object

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

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    The virtual machine scale set network profile.

    NameRequiredTypeDescription
    networkInterfaceConfigurations array

    The list of network configurations.

    diagnosticsProfile
    object

    The virtual machine scale set diagnostics profile.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    The virtual machine scale set extension profile.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See VirtualMachineScaleSet for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<VirtualMachineScaleSet>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    updateInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)

    Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    function updateInstances(resourceGroupName, vmScaleSetName, instanceIds, options, optionalCallback)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    optionalCallback
    function

    The optional callback.

    required: false
    NameRequiredTypeDescription
    err true ErrorThe Error object if an error occurred, null otherwise.
    result objectThe deserialized result object if an error did not occur. See OperationStatusResponse for more information.
    request objectThe HTTP Request object if an error did not occur.
    response streamThe HTTP Response stream if an error did not occur.
    Returns
    Promise<OperationStatusResponse>

    If a callback was passed as the last parameter then it returns the callback else returns a Promise.

    updateInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)

    Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.

    function updateInstancesWithHttpOperationResponse(resourceGroupName, vmScaleSetName, instanceIds, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set.

    instanceIds
    array

    The virtual machine scale set instance ids.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned

    updateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)

    Update a VM scale set.

    function updateWithHttpOperationResponse(resourceGroupName, vmScaleSetName, parameters, options)
    Parameters
    resourceGroupName
    string

    The name of the resource group.

    vmScaleSetName
    string

    The name of the VM scale set to create or update.

    parameters
    object

    The scale set object.

    NameRequiredTypeDescription
    sku object

    The virtual machine scale set sku.

    plan object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    upgradePolicy object

    The upgrade policy.

    virtualMachineProfile object

    The virtual machine profile.

    overprovision boolean

    Specifies whether the Virtual Machine Scale Set should be overprovisioned.

    singlePlacementGroup boolean

    When true this limits the scale set to a single placement group, of max size 100 virtual machines.

    identity object

    The identity of the virtual machine scale set, if configured.

    tags object

    Resource tags

    sku
    object

    The virtual machine scale set sku.

    NameRequiredTypeDescription
    name string

    The sku name.

    tier string

    Specifies the tier of virtual machines in a scale set.

    Possible Values:

    Standard

    Basic

    capacity number

    Specifies the number of virtual machines in the scale set.

    plan
    object

    The purchase plan when deploying a virtual machine scale set from VM Marketplace images.

    NameRequiredTypeDescription
    name string

    The plan ID.

    publisher string

    The publisher 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.

    upgradePolicy
    object

    The upgrade policy.

    NameRequiredTypeDescription
    mode string

    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. Possible values include: 'Automatic', 'Manual', 'Rolling'

    rollingUpgradePolicy object

    The configuration parameters used while performing a rolling 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.

    rollingUpgradePolicy
    object

    The configuration parameters used while performing a rolling upgrade.

    NameRequiredTypeDescription
    maxBatchInstancePercent number

    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 number

    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 number

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

    virtualMachineProfile
    object

    The virtual machine profile.

    NameRequiredTypeDescription
    osProfile object

    The virtual machine scale set OS profile.

    storageProfile object

    The virtual machine scale set storage profile.

    networkProfile object

    The virtual machine scale set network profile.

    diagnosticsProfile object

    The virtual machine scale set diagnostics profile.

    extensionProfile object

    The virtual machine scale set extension profile.

    licenseType string

    The license type, which is for bring your own license scenario.

    osProfile
    object

    The virtual machine scale set OS profile.

    NameRequiredTypeDescription
    customData string

    A base-64 encoded string of custom data.

    windowsConfiguration object

    The Windows Configuration of the OS profile.

    linuxConfiguration object

    The Linux Configuration of the OS profile.

    secrets array

    The List of certificates for addition to the VM.

    windowsConfiguration
    object

    The Windows Configuration of the OS profile.

    NameRequiredTypeDescription
    provisionVMAgent boolean

    Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later.

    enableAutomaticUpdates boolean

    Indicates whether virtual machine is enabled for automatic updates.

    timeZone string

    Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time"

    additionalUnattendContent array

    Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup.

    winRM object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    winRM
    object

    Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell.

    NameRequiredTypeDescription
    listeners array

    The list of Windows Remote Management listeners

    linuxConfiguration
    object

    The Linux Configuration of the OS profile.

    NameRequiredTypeDescription
    disablePasswordAuthentication boolean

    Specifies whether password authentication should be disabled.

    ssh object

    Specifies the ssh key configuration for a Linux OS.

    ssh
    object

    Specifies the ssh key configuration for a Linux OS.

    NameRequiredTypeDescription
    publicKeys array

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

    storageProfile
    object

    The virtual machine scale set storage profile.

    NameRequiredTypeDescription
    imageReference object

    The image reference.

    osDisk object

    The OS disk.

    dataDisks array

    The data disks.

    imageReference
    object

    The image reference.

    NameRequiredTypeDescription
    publisher string

    The image publisher.

    offer string

    Specifies the offer of the platform image or marketplace image used to create the virtual machine.

    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.

    id string

    Resource Id

    osDisk
    object

    The OS disk.

    NameRequiredTypeDescription
    caching string

    The caching type. Possible values include: 'None', 'ReadOnly', 'ReadWrite'

    writeAcceleratorEnabled boolean

    Specifies whether writeAccelerator should be enabled or disabled on the disk.

    image object

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

    vhdContainers array

    The list of virtual hard disk container uris.

    managedDisk object

    The managed disk parameters.

    image
    object

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

    NameRequiredTypeDescription
    uri string

    Specifies the virtual hard disk's uri.

    managedDisk
    object

    The managed disk parameters.

    NameRequiredTypeDescription
    storageAccountType string

    Specifies the storage account type for the managed disk. Possible values are: Standard_LRS or Premium_LRS. Possible values include: 'Standard_LRS', 'Premium_LRS'

    networkProfile
    object

    The virtual machine scale set network profile.

    NameRequiredTypeDescription
    networkInterfaceConfigurations array

    The list of network configurations.

    diagnosticsProfile
    object

    The virtual machine scale set diagnostics profile.

    NameRequiredTypeDescription
    bootDiagnostics object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

    bootDiagnostics
    object

    Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    For Linux Virtual Machines, you can easily view the output of your console log.

    For both Windows and Linux virtual machines, Azure also enables you to see a screenshot of the VM from the hypervisor.

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

    extensionProfile
    object

    The virtual machine scale set extension profile.

    NameRequiredTypeDescription
    extensions array

    The virtual machine scale set child extension resources.

    identity
    object

    The identity of the virtual machine scale set, if configured.

    NameRequiredTypeDescription
    type string

    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. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

    identityIds array

    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}'.

    options
    object

    Optional Parameters.

    required: false
    NameRequiredTypeDescription
    customHeaders object

    Headers that will be added to the request

    Returns
    Promise<HttpOperationResponse>

    A promise is returned