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 Azure.

Inheritance

azure.mgmt.compute.v2019_07_01.models._models_py3.Resource

VirtualMachineScaleSet

Constructor

VirtualMachineScaleSet(*, location: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.Sku] = None, plan: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.Plan] = None, identity: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.VirtualMachineScaleSetIdentity] = None, zones: Optional[List[str]] = None, upgrade_policy: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.UpgradePolicy] = None, automatic_repairs_policy: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.AutomaticRepairsPolicy] = None, virtual_machine_profile: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.VirtualMachineScaleSetVMProfile] = None, overprovision: Optional[bool] = None, do_not_run_extensions_on_overprovisioned_v_ms: Optional[bool] = None, single_placement_group: Optional[bool] = None, zone_balance: Optional[bool] = None, platform_fault_domain_count: Optional[int] = None, proximity_placement_group: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.SubResource] = None, additional_capabilities: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.AdditionalCapabilities] = None, scale_in_policy: Optional[azure.mgmt.compute.v2019_07_01.models._models_py3.ScaleInPolicy] = None, **kwargs)

Parameters

location

str

Required

Required. Resource location.

tags

dict[str, str]

Required

A set of tags. Resource tags.

sku

Sku

Required

The virtual machine scale set sku.

plan

Plan

Required

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

Required

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

zones

list[str]

Required

The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set.

upgrade_policy

UpgradePolicy

Required

The upgrade policy.

automatic_repairs_policy

AutomaticRepairsPolicy

Required

Policy for automatic repairs.

virtual_machine_profile

VirtualMachineScaleSetVMProfile

Required

The virtual machine profile.

overprovision

bool

Required

Specifies whether the Virtual Machine Scale Set should be overprovisioned.

do_not_run_extensions_on_overprovisioned_v_ms

bool

Required

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

Required

When true this limits the scale set to a single placement group, of max size 100 virtual machines.

zone_balance

bool

Required

Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage.

platform_fault_domain_count

int

Required

Fault Domain count for each placement group.

proximity_placement_group

SubResource

Required

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.

additional_capabilities

AdditionalCapabilities

Required

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

Required

Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

provisioning_state

str

The provisioning state, which only appears in the response.

unique_id

str

Specifies the ID which uniquely identifies a Virtual Machine Scale Set.