VirtualMachineScaleSetUpdate Class

Describes a Virtual Machine Scale Set.

Inheritance
azure.mgmt.compute.v2023_09_01.models._models_py3.UpdateResource
VirtualMachineScaleSetUpdate

Constructor

VirtualMachineScaleSetUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineScaleSetIdentity | None = None, upgrade_policy: _models.UpgradePolicy | None = None, automatic_repairs_policy: _models.AutomaticRepairsPolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetUpdateVMProfile | None = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms: bool | None = None, single_placement_group: bool | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, scale_in_policy: _models.ScaleInPolicy | None = None, proximity_placement_group: _models.SubResource | None = None, priority_mix_policy: _models.PriorityMixPolicy | None = None, spot_restore_policy: _models.SpotRestorePolicy | None = None, resiliency_policy: _models.ResiliencyPolicy | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

sku
Sku

The virtual machine scale set sku.

plan

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

identity

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

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. <br>:code:>><<<br>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.

Variables

Name Description
tags

Resource tags.

sku
Sku

The virtual machine scale set sku.

plan

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

identity

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

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. <br>:code:>><<<br>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.