VirtualMachineScaleSet interface

Describes a Virtual Machine Scale Set.

Extends

Properties

doNotRunExtensionsOnOverprovisionedVMs

When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.

id

Resource Id

identity

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

location

Resource location

name

Resource name

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

platformFaultDomainCount

Fault Domain count for each placement group.

provisioningState

The provisioning state, which only appears in the response.

singlePlacementGroup

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

sku

The virtual machine scale set sku.

tags

Resource tags

type

Resource type

uniqueId

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

upgradePolicy

The upgrade policy.

virtualMachineProfile

The virtual machine profile.

zoneBalance

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

zones

The virtual machine scale set zones.

Property Details

doNotRunExtensionsOnOverprovisionedVMs

When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs.

doNotRunExtensionsOnOverprovisionedVMs?: boolean

Property Value

boolean

id

Resource Id

id?: string

Property Value

string

identity

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

identity?: VirtualMachineScaleSetIdentity

Property Value

location

Resource location

location: string

Property Value

string

name

Resource name

name?: string

Property Value

string

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision?: boolean

Property Value

boolean

plan

Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.

plan?: Plan

Property Value

platformFaultDomainCount

Fault Domain count for each placement group.

platformFaultDomainCount?: number

Property Value

number

provisioningState

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

string

singlePlacementGroup

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

singlePlacementGroup?: boolean

Property Value

boolean

sku

The virtual machine scale set sku.

sku?: Sku

Property Value

Sku

tags

Resource tags

tags?: [key: string]: string

Property Value

[key: string]: string

type

Resource type

type?: string

Property Value

string

uniqueId

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.

uniqueId?: string

Property Value

string

upgradePolicy

The upgrade policy.

upgradePolicy?: UpgradePolicy

Property Value

virtualMachineProfile

The virtual machine profile.

virtualMachineProfile?: VirtualMachineScaleSetVMProfile

Property Value

zoneBalance

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

zoneBalance?: boolean

Property Value

boolean

zones

The virtual machine scale set zones.

zones?: string[]

Property Value

string[]