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_add_data_disk	Attach a new or existing data disk to virtual machine. This operation can take a while to complete.
begin_apply_artifacts	Apply artifacts to virtual machine. This operation can take a while to complete.
begin_claim	Take ownership of an existing virtual machine This operation can take a while to complete.
begin_create_or_update	Create or replace an existing virtual machine. This operation can take a while to complete.
begin_delete	Delete virtual machine. This operation can take a while to complete.
begin_detach_data_disk	Detach the specified disk from the virtual machine. This operation can take a while to complete.
begin_redeploy	Redeploy a virtual machine This operation can take a while to complete.
begin_resize	Resize Virtual Machine. This operation can take a while to complete.
begin_restart	Restart a virtual machine. This operation can take a while to complete.
begin_start	Start a virtual machine. This operation can take a while to complete.
begin_stop	Stop a virtual machine This operation can take a while to complete.
begin_transfer_disks	Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.
begin_un_claim	Release ownership of an existing virtual machine This operation can take a while to complete.
get	Get virtual machine.
get_rdp_file_contents	Gets a string that represents the contents of the RDP file for the virtual machine.
list	List virtual machines in a given lab.
list_applicable_schedules	Lists the applicable start/stop schedules, if any.
update	Allows modifying tags of virtual machines. All other properties will be ignored.

begin_add_data_disk

Attach a new or existing data disk to virtual machine. This operation can take a while to complete.

begin_add_data_disk(resource_group_name: str, lab_name: str, name: str, data_disk_properties: _models.DataDiskProperties, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
data_disk_properties Required	DataDiskProperties or IO[bytes] Request body for adding a new or existing data disk to a virtual machine. Is either a DataDiskProperties type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_apply_artifacts

Apply artifacts to virtual machine. This operation can take a while to complete.

begin_apply_artifacts(resource_group_name: str, lab_name: str, name: str, artifacts: list[azure.mgmt.devtestlabs.models._models_py3.ArtifactInstallProperties] | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
artifacts	list[ArtifactInstallProperties] The list of artifacts to apply. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_claim

Take ownership of an existing virtual machine This operation can take a while to complete.

begin_claim(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

Create or replace an existing virtual machine. This operation can take a while to complete.

begin_create_or_update(resource_group_name: str, lab_name: str, name: str, lab_virtual_machine: _models.LabVirtualMachine, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.LabVirtualMachine]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
lab_virtual_machine Required	LabVirtualMachine or IO[bytes] A virtual machine. Is either a LabVirtualMachine type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete virtual machine. This operation can take a while to complete.

begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_detach_data_disk

Detach the specified disk from the virtual machine. This operation can take a while to complete.

begin_detach_data_disk(resource_group_name: str, lab_name: str, name: str, existing_lab_disk_id: str | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
existing_lab_disk_id	str Specifies the disk resource ID to detach from virtual machine. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_redeploy

Redeploy a virtual machine This operation can take a while to complete.

begin_redeploy(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_resize

Resize Virtual Machine. This operation can take a while to complete.

begin_resize(resource_group_name: str, lab_name: str, name: str, size: str | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
size	str Specifies the size of the virtual machine. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_restart

Restart a virtual machine. This operation can take a while to complete.

begin_restart(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_start

Start a virtual machine. This operation can take a while to complete.

begin_start(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_stop

Stop a virtual machine This operation can take a while to complete.

begin_stop(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_transfer_disks

Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.

begin_transfer_disks(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_un_claim

Release ownership of an existing virtual machine This operation can take a while to complete.

begin_un_claim(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get virtual machine.

get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs: Any) -> LabVirtualMachine

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
expand	str Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

get_rdp_file_contents

Gets a string that represents the contents of the RDP file for the virtual machine.

get_rdp_file_contents(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> RdpConnection

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

List virtual machines in a given lab.

list(resource_group_name: str, lab_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[LabVirtualMachine]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
expand	str Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'. Default value is None. Default value: None
filter	str The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None. Default value: None
top	int The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None. Default value: None
orderby	str The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

list_applicable_schedules

Lists the applicable start/stop schedules, if any.

list_applicable_schedules(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> ApplicableSchedule

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Allows modifying tags of virtual machines. All other properties will be ignored.

update(resource_group_name: str, lab_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> LabVirtualMachine

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
lab_name Required	str The name of the lab. Required.
name Required	str The name of the virtual machine. Required.
tags	dict[str, str] The tags of the resource. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

Attributes

models

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

Feedback

Was this page helpful?