VirtualMachineScaleSet interface

Package:

@azure/arm-compute

Describes a Virtual Machine Scale Set.

Extends

Resource

Properties

additionalCapabilities	Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.
automaticRepairsPolicy	Policy for automatic repairs.
constrainedMaximumCapacity	Optional property which must either be set to True or omitted.
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.
etag	Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation	The extended location of the Virtual Machine Scale Set.
hostGroup	Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.
identity	The identity of the virtual machine scale set, if configured.
orchestrationMode	Specifies the orchestration mode for the virtual machine scale set.
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.
priorityMixPolicy	Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
provisioningState	The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
proximityPlacementGroup	Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.
resiliencyPolicy	Policy for Resiliency
scaleInPolicy	Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
scheduledEventsPolicy	The ScheduledEventsPolicy.
singlePlacementGroup	When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.
sku	The virtual machine scale set sku.
skuProfile	Specifies the sku profile for the virtual machine scale set.
spotRestorePolicy	Specifies the Spot Restore properties for the virtual machine scale set.
timeCreated	Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.
uniqueId	Specifies the ID which uniquely identifies a Virtual Machine Scale Set. NOTE: This property will not be serialized. It can only be populated by the server.
upgradePolicy	The upgrade policy.
virtualMachineProfile	The virtual machine profile.
zonalPlatformFaultDomainAlignMode	Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.
zoneBalance	Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
zones	The virtual machine scale set zones.

Inherited Properties

id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalCapabilities

Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type.

additionalCapabilities?: AdditionalCapabilities

Property Value

AdditionalCapabilities

automaticRepairsPolicy

Policy for automatic repairs.

automaticRepairsPolicy?: AutomaticRepairsPolicy

Property Value

AutomaticRepairsPolicy

constrainedMaximumCapacity

Optional property which must either be set to True or omitted.

constrainedMaximumCapacity?: boolean

Property Value

boolean

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

etag

Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

extendedLocation

The extended location of the Virtual Machine Scale Set.

extendedLocation?: ExtendedLocation

Property Value

ExtendedLocation

hostGroup

Specifies information about the dedicated host group that the virtual machine scale set resides in. Minimum api-version: 2020-06-01.

hostGroup?: SubResource

Property Value

SubResource

identity

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

identity?: VirtualMachineScaleSetIdentity

Property Value

VirtualMachineScaleSetIdentity

orchestrationMode

Specifies the orchestration mode for the virtual machine scale set.

orchestrationMode?: 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

Plan

platformFaultDomainCount

Fault Domain count for each placement group.

platformFaultDomainCount?: number

Property Value

number

priorityMixPolicy

Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.

priorityMixPolicy?: PriorityMixPolicy

Property Value

PriorityMixPolicy

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

proximityPlacementGroup

Specifies information about the proximity placement group that the virtual machine scale set should be assigned to. Minimum api-version: 2018-04-01.

proximityPlacementGroup?: SubResource

Property Value

SubResource

resiliencyPolicy

Policy for Resiliency

resiliencyPolicy?: ResiliencyPolicy

Property Value

ResiliencyPolicy

scaleInPolicy

Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.

scaleInPolicy?: ScaleInPolicy

Property Value

ScaleInPolicy

scheduledEventsPolicy

The ScheduledEventsPolicy.

scheduledEventsPolicy?: ScheduledEventsPolicy

Property Value

ScheduledEventsPolicy

singlePlacementGroup

When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true.

singlePlacementGroup?: boolean

Property Value

boolean

sku

The virtual machine scale set sku.

sku?: Sku

Property Value

Sku

skuProfile

Specifies the sku profile for the virtual machine scale set.

skuProfile?: SkuProfile

Property Value

SkuProfile

spotRestorePolicy

Specifies the Spot Restore properties for the virtual machine scale set.

spotRestorePolicy?: SpotRestorePolicy

Property Value

SpotRestorePolicy

timeCreated

Specifies the time at which the Virtual Machine Scale Set resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.

timeCreated?: Date

Property Value

Date

uniqueId

Specifies the ID which uniquely identifies a Virtual Machine Scale Set. NOTE: This property will not be serialized. It can only be populated by the server.

uniqueId?: string

Property Value

string

upgradePolicy

The upgrade policy.

upgradePolicy?: UpgradePolicy

Property Value

UpgradePolicy

virtualMachineProfile

The virtual machine profile.

virtualMachineProfile?: VirtualMachineScaleSetVMProfile

Property Value

VirtualMachineScaleSetVMProfile

zonalPlatformFaultDomainAlignMode

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count.

zonalPlatformFaultDomainAlignMode?: string

Property Value

string

zoneBalance

Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.

zoneBalance?: boolean

Property Value

boolean

zones

The virtual machine scale set zones.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type