Package version:

Interface VirtualMachineScaleSetUpdate

Describes a Virtual Machine Scale Set.

interface VirtualMachineScaleSetUpdate {
    additionalCapabilities?: AdditionalCapabilities;
    automaticRepairsPolicy?: AutomaticRepairsPolicy;
    doNotRunExtensionsOnOverprovisionedVMs?: boolean;
    identity?: VirtualMachineScaleSetIdentity;
    overprovision?: boolean;
    plan?: Plan;
    priorityMixPolicy?: PriorityMixPolicy;
    proximityPlacementGroup?: SubResource;
    resiliencyPolicy?: ResiliencyPolicy;
    scaleInPolicy?: ScaleInPolicy;
    singlePlacementGroup?: boolean;
    sku?: Sku;
    skuProfile?: SkuProfile;
    spotRestorePolicy?: SpotRestorePolicy;
    tags?: {
        [propertyName: string]: string;
    };
    upgradePolicy?: UpgradePolicy;
    virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile;
    zonalPlatformFaultDomainAlignMode?: string;
    zones?: string[];
}

Hierarchy (view full)

Properties

additionalCapabilities? automaticRepairsPolicy? doNotRunExtensionsOnOverprovisionedVMs? identity? overprovision? plan? priorityMixPolicy? proximityPlacementGroup? resiliencyPolicy? scaleInPolicy? singlePlacementGroup? sku? skuProfile? spotRestorePolicy? tags? upgradePolicy? virtualMachineProfile? zonalPlatformFaultDomainAlignMode? 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.

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.

Optionalidentity

identity?: VirtualMachineScaleSetIdentity

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

Optionaloverprovision

overprovision?: boolean

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

Optionalplan

plan?: Plan

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

OptionalpriorityMixPolicy

priorityMixPolicy?: PriorityMixPolicy

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

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.

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

OptionalupgradePolicy

upgradePolicy?: UpgradePolicy

The upgrade policy.

OptionalvirtualMachineProfile

virtualMachineProfile?: VirtualMachineScaleSetUpdateVMProfile

The virtual machine profile.

OptionalzonalPlatformFaultDomainAlignMode

zonalPlatformFaultDomainAlignMode?: string

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

Optionalzones

zones?: string[]

The virtual machine scale set zones.

Settings

Member Visibility