VirtualMachineScaleSetUpdate Class
Describes a Virtual Machine Scale Set.
Constructor
VirtualMachineScaleSetUpdate(*, tags: Dict[str, str] | None = None, sku: _models.Sku | None = None, plan: _models.Plan | None = None, identity: _models.VirtualMachineScaleSetIdentity | None = None, zones: List[str] | 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, zonal_platform_fault_domain_align_mode: str | _models.ZonalPlatformFaultDomainAlignMode | None = None, sku_profile: _models.SkuProfile | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
tags
|
Resource tags. Default value: None
|
|
sku
|
The virtual machine scale set sku. Default value: None
|
|
plan
|
The purchase plan when deploying a virtual machine scale set from VM Marketplace images. Default value: None
|
|
identity
|
The identity of the virtual machine scale set, if configured. Default value: None
|
|
zones
|
The virtual machine scale set zones. Default value: None
|
|
upgrade_policy
|
The upgrade policy. Default value: None
|
|
automatic_repairs_policy
|
Policy for automatic repairs. Default value: None
|
|
virtual_machine_profile
|
The virtual machine profile. Default value: None
|
|
overprovision
|
Specifies whether the Virtual Machine Scale Set should be overprovisioned. Default value: 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. Default value: 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. Default value: None
|
|
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. Default value: None
|
|
scale_in_policy
|
Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set. Default value: None
|
|
proximity_placement_group
|
Specifies information about the proximity placement group
that the virtual machine scale set should be assigned to. Default value: None
|
|
priority_mix_policy
|
Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance. Default value: None
|
|
spot_restore_policy
|
Specifies the Spot Restore properties for the virtual machine scale set. Default value: None
|
|
resiliency_policy
|
Policy for Resiliency. Default value: 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" and "Unaligned". Default value: None
|
|
sku_profile
|
Specifies the sku profile for the virtual machine scale set. Default value: None
|
Variables
| Name | Description |
|---|---|
|
tags
|
Resource tags. |
|
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. |
|
zones
|
The virtual machine scale set zones. |
|
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. |
|
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" and "Unaligned". |
|
sku_profile
|
Specifies the sku profile for the virtual machine scale set. |
