Share via

VirtualMachinesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ComputeManagementClient's

<xref:virtual_machines> attribute.

Inheritance
builtins.object
VirtualMachinesOperations

Constructor

VirtualMachinesOperations(*args, **kwargs)

Methods

begin_capture

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.
begin_convert_to_managed_disks

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.
begin_create_or_update

The operation to create or update a virtual machine.
begin_deallocate

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.
begin_delete

The operation to delete a virtual machine.
begin_power_off

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.
begin_redeploy

Shuts down the virtual machine, moves it to a new node, and powers it back on.
begin_restart

The operation to restart a virtual machine.
begin_start

The operation to start a virtual machine.
generalize

Sets the state of the virtual machine to generalized.
get

Retrieves information about the model view or the instance view of a virtual machine.
get_extensions

The operation to get all extensions of a Virtual Machine.
list

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.
list_all

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
list_available_sizes

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

begin_capture

Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.

begin_capture(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachineCaptureParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachineCaptureResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.
parameters
Required
VirtualMachineCaptureParameters or IO[bytes]

Parameters supplied to the Capture Virtual Machine operation. Is either a VirtualMachineCaptureParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[VirtualMachineCaptureResult]

An instance of LROPoller that returns either VirtualMachineCaptureResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_convert_to_managed_disks

Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.

begin_convert_to_managed_disks(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create_or_update

The operation to create or update a virtual machine.

begin_create_or_update(resource_group_name: str, vm_name: str, parameters: _models.VirtualMachine, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualMachine]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.
parameters
Required
VirtualMachine or IO[bytes]

Parameters supplied to the Create Virtual Machine operation. Is either a VirtualMachine type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[VirtualMachine]

An instance of LROPoller that returns either VirtualMachine or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_deallocate

Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.

begin_deallocate(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

The operation to delete a virtual machine.

begin_delete(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_power_off

The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.

begin_power_off(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_redeploy

Shuts down the virtual machine, moves it to a new node, and powers it back on.

begin_redeploy(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_restart

The operation to restart a virtual machine.

begin_restart(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_start

The operation to start a virtual machine.

begin_start(resource_group_name: str, vm_name: str, **kwargs: Any) -> LROPoller[OperationStatusResponse]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
LROPoller[OperationStatusResponse]

An instance of LROPoller that returns either OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

generalize

Sets the state of the virtual machine to generalized.

generalize(resource_group_name: str, vm_name: str, **kwargs: Any) -> OperationStatusResponse

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
OperationStatusResponse

OperationStatusResponse or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Retrieves information about the model view or the instance view of a virtual machine.

get(resource_group_name: str, vm_name: str, *, expand: Literal['instanceView'] = 'instanceView', **kwargs: Any) -> VirtualMachine

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Keyword-Only Parameters

Name Description
expand
str

The expand expression to apply on the operation. Known values are "instanceView" and None. Default value is "instanceView".

Returns

Type Description
VirtualMachine

VirtualMachine or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_extensions

The operation to get all extensions of a Virtual Machine.

get_extensions(resource_group_name: str, vm_name: str, *, expand: str | None = None, **kwargs: Any) -> VirtualMachineExtensionsListResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine containing the extension. Required.

Keyword-Only Parameters

Name Description
expand
str

The expand expression to apply on the operation. Default value is None.

Returns

Type Description
VirtualMachineExtensionsListResult

VirtualMachineExtensionsListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.

list(resource_group_name: str, **kwargs: Any) -> Iterable[VirtualMachine]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[VirtualMachine]

An iterator like instance of either VirtualMachine or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_all

Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.

list_all(**kwargs: Any) -> Iterable[VirtualMachine]

Returns

Type Description
ItemPaged[VirtualMachine]

An iterator like instance of either VirtualMachine or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_available_sizes

Lists all available virtual machine sizes to which the specified virtual machine can be resized.

list_available_sizes(resource_group_name: str, vm_name: str, **kwargs: Any) -> Iterable[VirtualMachineSize]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
vm_name
Required
str

The name of the virtual machine. Required.

Returns

Type Description
ItemPaged[VirtualMachineSize]

An iterator like instance of either VirtualMachineSize or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.compute.v2016_04_30_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\compute\\v2016_04_30_preview\\models\\__init__.py'>