VirtualMachineScaleSetUpdateProperties Class

Describes the properties of a Virtual Machine Scale Set.

Constructor

VirtualMachineScaleSetUpdateProperties()

Variables

Name Description
upgrade_policy
<xref:<xref:"UpgradePolicy">>

The upgrade policy.

automatic_repairs_policy
<xref:<xref:"AutomaticRepairsPolicy">>

Policy for automatic repairs.

virtual_machine_profile
<xref:<xref:"VirtualMachineScaleSetUpdateVMProfile">>

The virtual machine profile.

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

do_not_run_extensions_on_overprovisioned_v_ms

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.

single_placement_group

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.

additional_capabilities
<xref:<xref:"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.

scale_in_policy
<xref:<xref:"ScaleInPolicy">>

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

proximity_placement_group
<xref:<xref:"SubResource">>

Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

Minimum api-version: 2018-04-01.

priority_mix_policy
<xref:<xref:"PriorityMixPolicy">>

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

spot_restore_policy
<xref:<xref:"SpotRestorePolicy">>

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

resiliency_policy
<xref:<xref:"ResiliencyPolicy">>

Policy for Resiliency.

zonal_platform_fault_domain_align_mode
Union[str, <xref:"ZonalPlatformFaultDomainAlignMode">]

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: "Aligned", "Unaligned", and "BestEffortAligned".

sku_profile
<xref:<xref:"SkuProfile">>

Specifies the sku profile for the virtual machine scale set.

lifecycle_hooks_profile
<xref:<xref:"LifecycleHooksProfile">>

Specifies the lifecycle hooks profile for the virtual machine scale set.

Attributes

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

automaticRepairsPolicy

Policy for automatic repairs.

automaticRepairsPolicy: AutomaticRepairsPolicy

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: bool

lifecycleHooksProfile

Specifies the lifecycle hooks profile for the virtual machine scale set.

lifecycleHooksProfile: LifecycleHooksProfile

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision: bool

priorityMixPolicy

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

priorityMixPolicy: PriorityMixPolicy

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

resiliencyPolicy

Policy for Resiliency.

resiliencyPolicy: ResiliencyPolicy

scaleInPolicy

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

scaleInPolicy: ScaleInPolicy

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: bool

skuProfile

Specifies the sku profile for the virtual machine scale set.

skuProfile: SkuProfile

spotRestorePolicy

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

spotRestorePolicy: SpotRestorePolicy

upgradePolicy

The upgrade policy.

upgradePolicy: UpgradePolicy

virtualMachineProfile

The virtual machine profile.

virtualMachineProfile: VirtualMachineScaleSetUpdateVMProfile

zonalPlatformFaultDomainAlignMode

Specifies the align mode between Virtual Machine Scale Set compute and storage Fault Domain count. Known values are: "Aligned", "Unaligned", and "BestEffortAligned".

zonalPlatformFaultDomainAlignMode: str | ZonalPlatformFaultDomainAlignMode