DisksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:disks> attribute.

Constructor

DisksOperations(*args, **kwargs)

Methods

begin_attach	Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.
begin_create_or_update	Create or replace an existing disk. This operation can take a while to complete.
begin_delete	Delete disk. This operation can take a while to complete.
begin_detach	Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.
get	Get disk.
list	List disks in a given user profile.
update	Allows modifying tags of disks. All other properties will be ignored.

begin_attach

Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.

async begin_attach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: str | None = None, **kwargs: Any) -> AsyncLROPoller[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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.
leased_by_lab_vm_id	str The resource ID of the Lab virtual machine to which the disk is attached. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_create_or_update

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

async begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, disk: _models.Disk, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Disk]

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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.
disk Required	Disk or IO[bytes] A Disk. Is either a Disk type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

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

async begin_delete(resource_group_name: str, lab_name: str, user_name: str, name: str, **kwargs: Any) -> AsyncLROPoller[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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_detach

Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.

async begin_detach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: str | None = None, **kwargs: Any) -> AsyncLROPoller[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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.
leased_by_lab_vm_id	str The resource ID of the Lab VM to which the disk is attached. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

get

Get disk.

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

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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.
expand	str Specify the $expand query. Example: 'properties($select=diskType)'. Default value is None. Default value: None

Returns

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

Exceptions

Type	Description
HttpResponseError

list

List disks in a given user profile.

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

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.
user_name Required	str The name of the user profile. Required.
expand	str Specify the $expand query. Example: 'properties($select=diskType)'. 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
AsyncItemPaged[Disk]	An iterator like instance of either Disk or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

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

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

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.
user_name Required	str The name of the user profile. Required.
name Required	str The name of the disk. Required.
tags	dict[str, str] The tags of the resource. Default value is None. Default value: None

Returns

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