VirtualMachinesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:virtual_machines> attribute.

Constructor

VirtualMachinesOperations(*args, **kwargs)

Methods

begin_assess_patches	The operation to assess patches on a vSphere VMware machine identity in Azure.
begin_create_or_update	Implements virtual machine PUT method. Create Or Update virtual machine.
begin_delete	Deletes an virtual machine. Implements virtual machine DELETE method.
begin_install_patches	The operation to install patches on a vSphere VMware machine identity in Azure.
begin_restart	Implements the operation to restart a virtual machine. Restart virtual machine.
begin_start	Implements the operation to start a virtual machine. Start virtual machine.
begin_stop	Implements the operation to stop a virtual machine. Stop virtual machine.
begin_update	Updates a virtual machine. API to update certain properties of the virtual machine resource.
get	Gets a virtual machine. Implements virtual machine GET method.
list	Implements GET virtualMachines in a resource group. List of virtualMachines in a resource group.
list_all	Implements GET virtualMachines in a subscription. List of virtualMachines in a subscription.

begin_assess_patches

The operation to assess patches on a vSphere VMware machine identity in Azure.

async begin_assess_patches(resource_group_name: str, virtual_machine_name: str, **kwargs: Any) -> AsyncLROPoller[VirtualMachineAssessPatchesResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_name Required	str The name of the vSphere VMware machine. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[VirtualMachineAssessPatchesResult]	An instance of AsyncLROPoller that returns either VirtualMachineAssessPatchesResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Implements virtual machine PUT method.

Create Or Update virtual machine.

async begin_create_or_update(resource_group_name: str, virtual_machine_name: str, body: _models.VirtualMachine | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualMachine]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.
body	VirtualMachine or IO Request payload. Is either a model type or a IO type. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[VirtualMachine]	An instance of AsyncLROPoller that returns either VirtualMachine or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an virtual machine.

Implements virtual machine DELETE method.

async begin_delete(resource_group_name: str, virtual_machine_name: str, retain: bool | None = None, force: bool | None = None, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.
retain	bool Whether to just disable the VM from azure and retain the VM in the VMM. Default value is None. Default value: None
force	bool Whether force delete was specified. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_install_patches

The operation to install patches on a vSphere VMware machine identity in Azure.

async begin_install_patches(resource_group_name: str, virtual_machine_name: str, install_patches_input: _models.VirtualMachineInstallPatchesParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualMachineInstallPatchesResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_name Required	str The name of the vSphere VMware machine. Required.
install_patches_input Required	VirtualMachineInstallPatchesParameters or IO Input for InstallPatches as directly received by the API. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[VirtualMachineInstallPatchesResult]	An instance of AsyncLROPoller that returns either VirtualMachineInstallPatchesResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_restart

Implements the operation to restart a virtual machine.

Restart virtual machine.

async begin_restart(resource_group_name: str, virtual_machine_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Implements the operation to start a virtual machine.

Start virtual machine.

async begin_start(resource_group_name: str, virtual_machine_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_stop

Implements the operation to stop a virtual machine.

Stop virtual machine.

async begin_stop(resource_group_name: str, virtual_machine_name: str, body: _models.StopVirtualMachineOptions | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.
body	StopVirtualMachineOptions or IO Virtualmachine stop action payload. Is either a model type or a IO type. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a virtual machine.

API to update certain properties of the virtual machine resource.

async begin_update(resource_group_name: str, virtual_machine_name: str, body: _models.VirtualMachineUpdate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualMachine]

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.
body	VirtualMachineUpdate or IO Resource properties to update. Is either a model type or a IO type. Default value is None. Default value: None

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or AsyncPollingMethod By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
AsyncLROPoller[VirtualMachine]	An instance of AsyncLROPoller that returns either VirtualMachine or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a virtual machine.

Implements virtual machine GET method.

async get(resource_group_name: str, virtual_machine_name: str, **kwargs: Any) -> VirtualMachine

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.
virtual_machine_name Required	str Name of the virtual machine resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
VirtualMachine	VirtualMachine or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Implements GET virtualMachines in a resource group.

List of virtualMachines in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The Resource Group Name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[VirtualMachine]	An iterator like instance of either VirtualMachine or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_all

Implements GET virtualMachines in a subscription.

List of virtualMachines in a subscription.

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

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[VirtualMachine]	An iterator like instance of either VirtualMachine or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.connectedvmware.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv90\\Lib\\site-packages\\azure\\mgmt\\connectedvmware\\models\\__init__.py'>

Share via

VirtualMachinesOperations Class

Constructor

Methods

begin_assess_patches

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_create_or_update

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_delete

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_install_patches

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_restart

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_start

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_stop

Parameters

Keyword-Only Parameters

Returns

Exceptions

begin_update

Parameters

Keyword-Only Parameters

Returns

Exceptions

get

Parameters

Keyword-Only Parameters

Returns

Exceptions

list

Parameters

Keyword-Only Parameters

Returns

Exceptions

list_all

Keyword-Only Parameters

Returns

Exceptions

Attributes

models

Feedback