VirtualMachineScaleSetUpdateProperties Class

Describes the properties of a Virtual Machine Scale Set.

Constructor

VirtualMachineScaleSetUpdateProperties(*args: Any, **kwargs: Any)

Variables

Name Description
upgrade_policy

The upgrade policy.

automatic_repairs_policy

Policy for automatic repairs.

virtual_machine_profile

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

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

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

proximity_placement_group

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

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

spot_restore_policy

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

resiliency_policy

Policy for Resiliency.

zonal_platform_fault_domain_align_mode

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

sku_profile

Specifies the sku profile for the virtual machine scale set.

lifecycle_hooks_profile

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

Attributes

additional_capabilities

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.

additional_capabilities: _models.AdditionalCapabilities | None

automatic_repairs_policy

Policy for automatic repairs.

automatic_repairs_policy: _models.AutomaticRepairsPolicy | None

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.

do_not_run_extensions_on_overprovisioned_v_ms: bool | None

lifecycle_hooks_profile

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

lifecycle_hooks_profile: _models.LifecycleHooksProfile | None

overprovision

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

overprovision: bool | None

priority_mix_policy

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

priority_mix_policy: _models.PriorityMixPolicy | None

proximity_placement_group

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

Minimum api-version: 2018-04-01.

proximity_placement_group: _models.SubResource | None

resiliency_policy

Policy for Resiliency.

resiliency_policy: _models.ResiliencyPolicy | None

scale_in_policy

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

scale_in_policy: _models.ScaleInPolicy | None

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.

single_placement_group: bool | None

sku_profile

Specifies the sku profile for the virtual machine scale set.

sku_profile: _models.SkuProfile | None

spot_restore_policy

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

spot_restore_policy: _models.SpotRestorePolicy | None

upgrade_policy

The upgrade policy.

upgrade_policy: _models.UpgradePolicy | None

virtual_machine_profile

The virtual machine profile.

virtual_machine_profile: _models.VirtualMachineScaleSetUpdateVMProfile | None

zonal_platform_fault_domain_align_mode

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

zonal_platform_fault_domain_align_mode: str | _models.ZonalPlatformFaultDomainAlignMode | None