LabsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:labs> attribute.

Constructor

LabsOperations(*args, **kwargs)

Methods

begin_claim_any_vm	Claim a random claimable virtual machine in the lab. This operation can take a while to complete.
begin_create_environment	Create virtual machines in a lab. This operation can take a while to complete.
begin_create_or_update	Create or replace an existing lab. This operation can take a while to complete.
begin_delete	Delete lab. This operation can take a while to complete.
begin_export_resource_usage	Exports the lab resource usage into a storage account This operation can take a while to complete.
begin_import_virtual_machine	Import a virtual machine into a different lab. This operation can take a while to complete.
generate_upload_uri	Generate a URI for uploading custom disk images to a Lab.
get	Get lab.
list_by_resource_group	List labs in a resource group.
list_by_subscription	List labs in a subscription.
list_vhds	List disk images available for custom image creation.
update	Allows modifying tags of labs. All other properties will be ignored.

begin_claim_any_vm

Claim a random claimable virtual machine in the lab. This operation can take a while to complete.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. 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_environment

Create virtual machines in a lab. This operation can take a while to complete.

begin_create_environment(resource_group_name: str, name: str, lab_virtual_machine_creation_parameter: _models.LabVirtualMachineCreationParameter, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
lab_virtual_machine_creation_parameter Required	LabVirtualMachineCreationParameter or IO[bytes] Properties for creating a virtual machine. Is either a LabVirtualMachineCreationParameter 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_create_or_update

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
lab Required	Lab or IO[bytes] A lab. Is either a Lab type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete lab. This operation can take a while to complete.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. 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_export_resource_usage

Exports the lab resource usage into a storage account This operation can take a while to complete.

begin_export_resource_usage(resource_group_name: str, name: str, blob_storage_absolute_sas_uri: str | None = None, usage_start_date: datetime | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
blob_storage_absolute_sas_uri	str The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to. Default value is None. Default value: None
usage_start_date	datetime The start time of the usage. If not provided, usage will be reported since the beginning of data collection. 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_import_virtual_machine

Import a virtual machine into a different lab. This operation can take a while to complete.

begin_import_virtual_machine(resource_group_name: str, name: str, source_virtual_machine_resource_id: str | None = None, destination_virtual_machine_name: str | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
source_virtual_machine_resource_id	str The full resource ID of the virtual machine to be imported. Default value is None. Default value: None
destination_virtual_machine_name	str The name of the virtual machine in the destination lab. 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

generate_upload_uri

Generate a URI for uploading custom disk images to a Lab.

generate_upload_uri(resource_group_name: str, name: str, blob_name: str | None = None, **kwargs: Any) -> GenerateUploadUriResponse

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
blob_name	str The blob name of the upload URI. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get lab.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
name Required	str The name of the lab. Required.
expand	str Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

List labs in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
expand	str Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'. 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[Lab]	An iterator like instance of either Lab or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List labs in a subscription.

list_by_subscription(expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[Lab]

Parameters

Name	Description
expand	str Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'. 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[Lab]	An iterator like instance of either Lab or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_vhds

List disk images available for custom image creation.

list_vhds(resource_group_name: str, name: str, **kwargs: Any) -> ItemPaged[LabVhd]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Allows modifying tags of labs. All other properties will be ignored.

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

Parameters

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

Returns

Type	Description
Lab	Lab 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?