DisksOperations Class

DisksOperations 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.object
DisksOperations

Constructor

DisksOperations(client, config, serializer, deserializer)

Parameters

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

models

Alias to model classes used in this operation group.

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.

begin_attach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: Optional[str] = None, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

leased_by_lab_vm_id
str
default value: None

The resource ID of the Lab virtual machine to which the disk is attached.

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 PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_create_or_update

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

begin_create_or_update(resource_group_name: str, lab_name: str, user_name: str, name: str, disk: _models.Disk, **kwargs: Any) -> LROPoller[_models.Disk]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

disk
Disk
Required

A Disk.

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 PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Disk or the result of cls(response)

Return type

Exceptions

begin_delete

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

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

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

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 PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_detach

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

begin_detach(resource_group_name: str, lab_name: str, user_name: str, name: str, leased_by_lab_vm_id: Optional[str] = None, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

leased_by_lab_vm_id
str
default value: None

The resource ID of the Lab VM to which the disk is attached.

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 PollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

Exceptions

get

Get disk.

get(resource_group_name: str, lab_name: str, user_name: str, name: str, expand: Optional[str] = None, **kwargs: Any) -> _models.Disk

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

expand
str
default value: None

Specify the $expand query. Example: 'properties($select=diskType)'.

cls
callable

A custom type or function that will be passed the direct response

Returns

Disk, or the result of cls(response)

Return type

Exceptions

list

List disks in a given user profile.

list(resource_group_name: str, lab_name: str, user_name: str, expand: Optional[str] = None, filter: Optional[str] = None, top: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) -> Iterable[_models.DiskList]

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

expand
str
default value: None

Specify the $expand query. Example: 'properties($select=diskType)'.

filter
str
default value: None

The filter to apply to the operation. Example: '$filter=contains(name,'myName').

top
int
default value: None

The maximum number of resources to return from the operation. Example: '$top=10'.

orderby
str
default value: None

The ordering expression for the results, using OData notation. Example: '$orderby=name desc'.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DiskList or the result of cls(response)

Return type

Exceptions

update

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

update(resource_group_name: str, lab_name: str, user_name: str, name: str, disk: _models.DiskFragment, **kwargs: Any) -> _models.Disk

Parameters

resource_group_name
str
Required

The name of the resource group.

lab_name
str
Required

The name of the lab.

user_name
str
Required

The name of the user profile.

name
str
Required

The name of the disk.

disk
DiskFragment
Required

A Disk.

cls
callable

A custom type or function that will be passed the direct response

Returns

Disk, or the result of cls(response)

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>