VirtualMachineScaleSet Class

Describes a Virtual Machine Scale Set.

Constructor

VirtualMachineScaleSet()

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
<xref:<xref:"SystemData">>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

location
str

The geo-location where the resource lives. Required.

sku
<xref:<xref:"Sku">>

The virtual machine scale set sku.

plan
<xref:<xref:"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
<xref:<xref:"VirtualMachineScaleSetProperties">>

Describes the properties of a Virtual Machine Scale Set.

identity
<xref:<xref:"VirtualMachineScaleSetIdentity">>

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

zones

The availability zones.

extended_location
<xref:<xref:"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
<xref:<xref:"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

extendedLocation

The extended location of the Virtual Machine Scale Set.

extendedLocation: ExtendedLocation

identity

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

identity: VirtualMachineScaleSetIdentity

placement

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

placement: Placement

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: Plan

properties

Describes the properties of a Virtual Machine Scale Set.

properties: VirtualMachineScaleSetProperties

sku

The virtual machine scale set sku.

sku: Sku

zones

The availability zones.

zones: list[str]

id

id: str

location

location: str

name

name: str

systemData

systemData: SystemData

tags

tags: dict[str, str]

type

type: str