VirtualMachine Class

Describes a Virtual Machine.

Constructor

VirtualMachine(*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.
properties
VirtualMachineProperties

Describes the properties of a Virtual Machine.
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.
resources
list[VirtualMachineExtension]

The virtual machine child extension resources.
identity
VirtualMachineIdentity

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

The availability zones.
extended_location
ExtendedLocation

The extended location of the Virtual Machine.
managed_by
str

ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.
etag
str

Etag is property returned in Create/Update/Get response of the VM, 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 hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-01.

Attributes

etag

Etag is property returned in Create/Update/Get response of the VM, 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.

extended_location: _models.ExtendedLocation | None

identity

The identity of the virtual machine, if configured.

identity: _models.VirtualMachineIdentity | None

managed_by

ManagedBy is set to Virtual Machine Scale Set(VMSS) flex ARM resourceID, if the VM is part of the VMSS. This property is used by platform for internal resource group delete optimization.

managed_by: str | None

placement

Placement section specifies the user-defined constraints for virtual machine hardware placement. This property cannot be changed once VM is provisioned. Minimum api-version: 2024-11-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.

properties: _models.VirtualMachineProperties | None

resources

The virtual machine child extension resources.

resources: list['_models.VirtualMachineExtension'] | None

zones

The availability zones.

zones: list[str] | None