Package version:

Interface VirtualMachineScaleSet

Describes a Virtual Machine Scale Set.

interface VirtualMachineScaleSet {
    additionalCapabilities?: AdditionalCapabilities;
    automaticRepairsPolicy?: AutomaticRepairsPolicy;
    constrainedMaximumCapacity?: boolean;
    doNotRunExtensionsOnOverprovisionedVMs?: boolean;
    etag?: string;
    extendedLocation?: ExtendedLocation;
    hostGroup?: SubResource;
    id?: string;
    identity?: VirtualMachineScaleSetIdentity;
    location: string;
    name?: string;
    orchestrationMode?: string;
    overprovision?: boolean;
    plan?: Plan;
    platformFaultDomainCount?: number;
    priorityMixPolicy?: PriorityMixPolicy;
    provisioningState?: string;
    proximityPlacementGroup?: SubResource;
    resiliencyPolicy?: ResiliencyPolicy;
    scaleInPolicy?: ScaleInPolicy;
    scheduledEventsPolicy?: ScheduledEventsPolicy;
    singlePlacementGroup?: boolean;
    sku?: Sku;
    skuProfile?: SkuProfile;
    spotRestorePolicy?: SpotRestorePolicy;
    tags?: {
        [propertyName: string]: string;
    };
    timeCreated?: any;
    type?: string;
    uniqueId?: string;
    upgradePolicy?: UpgradePolicy;
    virtualMachineProfile?: VirtualMachineScaleSetVMProfile;
    zonalPlatformFaultDomainAlignMode?: string;
    zoneBalance?: boolean;
    zones?: string[];
}

Hierarchy (view full)

Properties

additionalCapabilities? automaticRepairsPolicy? constrainedMaximumCapacity? doNotRunExtensionsOnOverprovisionedVMs? etag? extendedLocation? hostGroup? id? identity? location name? orchestrationMode? overprovision? plan? platformFaultDomainCount? priorityMixPolicy? provisioningState? proximityPlacementGroup? resiliencyPolicy? scaleInPolicy? scheduledEventsPolicy? singlePlacementGroup? sku? skuProfile? spotRestorePolicy? tags? timeCreated? type? uniqueId? upgradePolicy? virtualMachineProfile? zonalPlatformFaultDomainAlignMode? zoneBalance? zones?

Properties

OptionaladditionalCapabilities

additionalCapabilities?: 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.

OptionalautomaticRepairsPolicy

automaticRepairsPolicy?: AutomaticRepairsPolicy

Policy for automatic repairs.

OptionalconstrainedMaximumCapacity

constrainedMaximumCapacity?: boolean

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

OptionaldoNotRunExtensionsOnOverprovisionedVMs

doNotRunExtensionsOnOverprovisionedVMs?: boolean

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.

Optional Readonlyetag

etag?: string

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.

OptionalextendedLocation

extendedLocation?: ExtendedLocation

The extended location of the Virtual Machine Scale Set.

OptionalhostGroup

hostGroup?: SubResource

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

Optional Readonlyid

id?: string

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

Optionalidentity

identity?: VirtualMachineScaleSetIdentity

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

location

location: string

Resource location

Optional Readonlyname

name?: string

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

OptionalorchestrationMode

orchestrationMode?: string

Specifies the orchestration mode for the virtual machine scale set.

Optionaloverprovision

overprovision?: boolean

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

Optionalplan

plan?: 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.

OptionalplatformFaultDomainCount

platformFaultDomainCount?: number

Fault Domain count for each placement group.

OptionalpriorityMixPolicy

priorityMixPolicy?: PriorityMixPolicy

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

Optional ReadonlyprovisioningState

provisioningState?: string

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

OptionalproximityPlacementGroup

proximityPlacementGroup?: SubResource

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

OptionalresiliencyPolicy

resiliencyPolicy?: ResiliencyPolicy

Policy for Resiliency

OptionalscaleInPolicy

scaleInPolicy?: ScaleInPolicy

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

OptionalscheduledEventsPolicy

scheduledEventsPolicy?: ScheduledEventsPolicy

The ScheduledEventsPolicy.

OptionalsinglePlacementGroup

singlePlacementGroup?: boolean

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.

Optionalsku

sku?: Sku

The virtual machine scale set sku.

OptionalskuProfile

skuProfile?: SkuProfile

Specifies the sku profile for the virtual machine scale set.

OptionalspotRestorePolicy

spotRestorePolicy?: SpotRestorePolicy

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

Optionaltags

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

Resource tags

Optional ReadonlytimeCreated

timeCreated?: any

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.

Optional Readonlytype

type?: string

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

Optional ReadonlyuniqueId

uniqueId?: string

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.

OptionalupgradePolicy

upgradePolicy?: UpgradePolicy

The upgrade policy.

OptionalvirtualMachineProfile

virtualMachineProfile?: VirtualMachineScaleSetVMProfile

The virtual machine profile.

OptionalzonalPlatformFaultDomainAlignMode

zonalPlatformFaultDomainAlignMode?: string

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

OptionalzoneBalance

zoneBalance?: boolean

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.

Optionalzones

zones?: string[]

The virtual machine scale set zones.

Settings

Member Visibility