VirtualMachineScaleSet Class

Describes a Virtual Machine Scale Set.

Constructor

VirtualMachineScaleSet(*args: Any, **kwargs: Any)

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data
SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags
dict[str, str]

Resource tags.
location
str

The geo-location where the resource lives. Required.
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.
properties
VirtualMachineScaleSetProperties

Describes the properties of a Virtual Machine Scale Set.
identity
VirtualMachineScaleSetIdentity

The identity of the virtual machine scale set, if configured.
zones
list[str]

The availability zones.
extended_location
ExtendedLocation

The extended location of the Virtual Machine Scale Set.
etag
str

Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates.
placement
Placement

Placement section specifies the user-defined constraints for virtual machine scale set hardware placement. Minimum api-version: 2025-04-01.

Attributes

etag

Etag is property returned in Create/Update/Get response of the VMSS, so that customer can supply it in the header to ensure optimistic updates.

etag: str | None

extended_location

The extended location of the Virtual Machine Scale Set.

extended_location: _models.ExtendedLocation | None

identity

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

identity: _models.VirtualMachineScaleSetIdentity | None

placement

Placement section specifies the user-defined constraints for virtual machine scale set hardware placement. Minimum api-version: 2025-04-01.

placement: _models.Placement | None

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.

plan: _models.Plan | None

properties

Describes the properties of a Virtual Machine Scale Set.

properties: _models.VirtualMachineScaleSetProperties | None

sku

The virtual machine scale set sku.

sku: _models.Sku | None

zones

The availability zones.

zones: list[str] | None