VirtualMachinesOperations Class
VirtualMachinesOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectVirtualMachinesOperations
Constructor
VirtualMachinesOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
models
|
Alias to model classes used in this operation group. |
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.
async begin_add_data_disk(resource_group_name: str, lab_name: str, name: str, data_disk_properties: DataDiskProperties, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
data_disk_properties
Required
|
Request body for adding a new or existing data disk to a virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_apply_artifacts
Apply artifacts to virtual machine. This operation can take a while to complete.
async begin_apply_artifacts(resource_group_name: str, lab_name: str, name: str, artifacts: List[ArtifactInstallProperties] | None = None, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
artifacts
|
The list of artifacts to apply. default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_claim
Take ownership of an existing virtual machine This operation can take a while to complete.
async begin_claim(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_create_or_update
Create or replace an existing virtual machine. This operation can take a while to complete.
async begin_create_or_update(resource_group_name: str, lab_name: str, name: str, lab_virtual_machine: LabVirtualMachine, **kwargs) -> AsyncLROPoller[LabVirtualMachine]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
lab_virtual_machine
Required
|
A virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either LabVirtualMachine or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete virtual machine. This operation can take a while to complete.
async begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_detach_data_disk
Detach the specified disk from the virtual machine. This operation can take a while to complete.
async begin_detach_data_disk(resource_group_name: str, lab_name: str, name: str, existing_lab_disk_id: str | None = None, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
existing_lab_disk_id
|
Specifies the disk resource ID to detach from virtual machine. default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_redeploy
Redeploy a virtual machine This operation can take a while to complete.
async begin_redeploy(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_resize
Resize Virtual Machine. This operation can take a while to complete.
async begin_resize(resource_group_name: str, lab_name: str, name: str, size: str | None = None, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
size
|
Specifies the size of the virtual machine. default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_restart
Restart a virtual machine. This operation can take a while to complete.
async begin_restart(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_start
Start a virtual machine. This operation can take a while to complete.
async begin_start(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_stop
Stop a virtual machine This operation can take a while to complete.
async begin_stop(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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.
async begin_transfer_disks(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_un_claim
Release ownership of an existing virtual machine This operation can take a while to complete.
async begin_un_claim(resource_group_name: str, lab_name: str, name: str, **kwargs) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
True for ARMPolling, False for no polling, or a polling object for personal polling strategy |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get virtual machine.
async get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs) -> LabVirtualMachineParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
expand
|
Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'. default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
LabVirtualMachine, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_rdp_file_contents
Gets a string that represents the contents of the RDP file for the virtual machine.
async get_rdp_file_contents(resource_group_name: str, lab_name: str, name: str, **kwargs) -> RdpConnectionParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
RdpConnection, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> AsyncIterable[LabVirtualMachineList]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
expand
|
Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'. default value: None
|
|
filter
|
The filter to apply to the operation. Example: '$filter=contains(name,'myName'). default value: None
|
|
top
|
The maximum number of resources to return from the operation. Example: '$top=10'. default value: None
|
|
orderby
|
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. default value: None
|
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either LabVirtualMachineList or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_applicable_schedules
Lists the applicable start/stop schedules, if any.
async list_applicable_schedules(resource_group_name: str, lab_name: str, name: str, **kwargs) -> ApplicableScheduleParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
ApplicableSchedule, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Allows modifying tags of virtual machines. All other properties will be ignored.
async update(resource_group_name: str, lab_name: str, name: str, lab_virtual_machine: LabVirtualMachineFragment, **kwargs) -> LabVirtualMachineParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. |
|
lab_name
Required
|
The name of the lab. |
|
name
Required
|
The name of the virtual machine. |
|
lab_virtual_machine
Required
|
A virtual machine. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
LabVirtualMachine, or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for