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.v2017_12_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, upgrade_policy: _models.UpgradePolicy | None = None, virtual_machine_profile: _models.VirtualMachineScaleSetVMProfile | None = None, overprovision: bool | None = None, single_placement_group: bool | None = None, zone_balance: bool | None = None, platform_fault_domain_count: int | 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.
upgrade_policy	UpgradePolicy The upgrade policy.
virtual_machine_profile	VirtualMachineScaleSetVMProfile The virtual machine profile.
overprovision	bool Specifies whether the Virtual Machine Scale Set should be overprovisioned.
single_placement_group	bool When true this limits the scale set to a single placement group, of max size 100 virtual machines.
zone_balance	bool Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
platform_fault_domain_count	int Fault Domain count for each placement group.

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.
upgrade_policy	UpgradePolicy The upgrade policy.
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.
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.
zone_balance	bool Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.
platform_fault_domain_count	int Fault Domain count for each placement group.