VirtualMachineScaleSet Class

Describes a Virtual Machine Scale Set.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Inheritance

azure.mgmt.compute.v2022_11_01.models._models_py3.Resource

VirtualMachineScaleSet

Constructor

VirtualMachineScaleSet(*, location: str, 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, extended_location: _models.ExtendedLocation | None = None, upgrade_policy: _models.UpgradePolicy | None = None, automatic_repairs_policy: _models.AutomaticRepairsPolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetVMProfile | None = None, overprovision: bool | None = None, do_not_run_extensions_on_overprovisioned_v_ms: bool | None = None, single_placement_group: bool | None = None, zone_balance: bool | None = None, platform_fault_domain_count: int | None = None, proximity_placement_group: _models.SubResource | None = None, host_group: _models.SubResource | None = None, additional_capabilities: _models.AdditionalCapabilities | None = None, scale_in_policy: _models.ScaleInPolicy | None = None, orchestration_mode: str | _models.OrchestrationMode | None = None, spot_restore_policy: _models.SpotRestorePolicy | None = None, priority_mix_policy: _models.PriorityMixPolicy | None = None, constrained_maximum_capacity: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
sku	Sku The virtual machine scale set sku.
plan	Plan Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
identity	VirtualMachineScaleSetIdentity The identity of the virtual machine scale set, if configured.
zones	list[str] The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.
extended_location	ExtendedLocation The extended location of the Virtual Machine Scale Set.
upgrade_policy	UpgradePolicy The upgrade policy.
automatic_repairs_policy	AutomaticRepairsPolicy Policy for automatic repairs.
virtual_machine_profile	VirtualMachineScaleSetVMProfile The virtual machine profile.
overprovision	bool Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms	bool 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	bool 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.
zone_balance	bool Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
platform_fault_domain_count	int Fault Domain count for each placement group.
proximity_placement_group	SubResource 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.
host_group	SubResource Specifies information about the dedicated host group that the virtual machine scale set resides in. <br>:code:>><<<br>Minimum api-version: 2020-06-01.
additional_capabilities	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	ScaleInPolicy Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
orchestration_mode	str or OrchestrationMode Specifies the orchestration mode for the virtual machine scale set. Known values are: "Uniform" and "Flexible".
spot_restore_policy	SpotRestorePolicy Specifies the Spot Restore properties for the virtual machine scale set.
priority_mix_policy	PriorityMixPolicy Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
constrained_maximum_capacity	bool Optional property which must either be set to True or omitted.

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
type	str Resource type.
location	str Resource location. Required.
tags	dict[str, str] Resource tags.
sku	Sku The virtual machine scale set sku.
plan	Plan Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save.
identity	VirtualMachineScaleSetIdentity The identity of the virtual machine scale set, if configured.
zones	list[str] The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.
extended_location	ExtendedLocation The extended location of the Virtual Machine Scale Set.
upgrade_policy	UpgradePolicy The upgrade policy.
automatic_repairs_policy	AutomaticRepairsPolicy Policy for automatic repairs.
virtual_machine_profile	VirtualMachineScaleSetVMProfile The virtual machine profile.
provisioning_state	str The provisioning state, which only appears in the response.
overprovision	bool Specifies whether the Virtual Machine Scale Set should be overprovisioned.
do_not_run_extensions_on_overprovisioned_v_ms	bool 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.
unique_id	str Specifies the ID which uniquely identifies a Virtual Machine Scale Set.
single_placement_group	bool 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.
zone_balance	bool Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage. zoneBalance property can only be set if the zones property of the scale set contains more than one zone. If there are no zones or only one zone specified, then zoneBalance property should not be set.
platform_fault_domain_count	int Fault Domain count for each placement group.
proximity_placement_group	SubResource 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.
host_group	SubResource Specifies information about the dedicated host group that the virtual machine scale set resides in. <br>:code:>><<<br>Minimum api-version: 2020-06-01.
additional_capabilities	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	ScaleInPolicy Specifies the policies applied when scaling in Virtual Machines in the Virtual Machine Scale Set.
orchestration_mode	str or OrchestrationMode Specifies the orchestration mode for the virtual machine scale set. Known values are: "Uniform" and "Flexible".
spot_restore_policy	SpotRestorePolicy Specifies the Spot Restore properties for the virtual machine scale set.
priority_mix_policy	PriorityMixPolicy Specifies the desired targets for mixing Spot and Regular priority VMs within the same VMSS Flex instance.
time_created	datetime Specifies the time at which the Virtual Machine Scale Set resource was created.:code: :code:>><<<br>Minimum api-version: 2021-11-01.
constrained_maximum_capacity	bool Optional property which must either be set to True or omitted.