DisksOperations Class

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

Creates or updates a disk.

begin_delete

Deletes a disk.

begin_grant_access

Grants access to a disk.

begin_revoke_access

Revokes access to a disk.

begin_update

Updates (patches) a disk.

get

Gets information about a disk.

list

Lists all the disks under a subscription.

list_by_resource_group

Lists all the disks under a resource group.

begin_create_or_update

Creates or updates a disk.

async begin_create_or_update(resource_group_name: str, disk_name: str, disk: azure.mgmt.compute.v2020_09_30.models._models_py3.Disk, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.compute.v2020_09_30.models._models_py3.Disk]

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

disk
Disk
Required

Disk object supplied in the body of the Put disk operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AsyncLROPoller that returns either Disk or the result of cls(response)

Return type

Exceptions

begin_delete

Deletes a disk.

async begin_delete(resource_group_name: str, disk_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_grant_access

Grants access to a disk.

async begin_grant_access(resource_group_name: str, disk_name: str, grant_access_data: azure.mgmt.compute.v2020_09_30.models._models_py3.GrantAccessData, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.compute.v2020_09_30.models._models_py3.AccessUri]

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

grant_access_data
GrantAccessData
Required

Access data object supplied in the body of the get disk access operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AsyncLROPoller that returns either AccessUri or the result of cls(response)

Return type

Exceptions

begin_revoke_access

Revokes access to a disk.

async begin_revoke_access(resource_group_name: str, disk_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

begin_update

Updates (patches) a disk.

async begin_update(resource_group_name: str, disk_name: str, disk: azure.mgmt.compute.v2020_09_30.models._models_py3.DiskUpdate, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.compute.v2020_09_30.models._models_py3.Disk]

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

disk
DiskUpdate
Required

Disk object supplied in the body of the Patch disk operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a 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 AsyncLROPoller that returns either Disk or the result of cls(response)

Return type

Exceptions

get

Gets information about a disk.

async get(resource_group_name: str, disk_name: str, **kwargs: Any) -> azure.mgmt.compute.v2020_09_30.models._models_py3.Disk

Parameters

resource_group_name
str
Required

The name of the resource group.

disk_name
str
Required

The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.

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

Lists all the disks under a subscription.

list(**kwargs: Any) -> AsyncIterable[azure.mgmt.compute.v2020_09_30.models._models_py3.DiskList]

Parameters

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

list_by_resource_group

Lists all the disks under a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.compute.v2020_09_30.models._models_py3.DiskList]

Parameters

resource_group_name
str
Required

The name of the resource group.

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

Attributes

models

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