VolumesOperations Class

VolumesOperations 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
VolumesOperations

Constructor

VolumesOperations(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_authorize_replication

Authorize source volume replication.

Authorize the replication connection on the source volume.

begin_break_replication

Break volume replication.

Break the replication connection on the destination volume.

begin_create_or_update

Create or Update a volume.

Create or update the specified volume within the capacity pool.

begin_delete

Delete a volume.

Delete the specified volume.

begin_delete_replication

Delete volume replication.

Delete the replication connection on the destination volume, and send release to the source replication.

begin_pool_change

Change pool for volume.

Moves volume to another pool.

begin_re_initialize_replication

ReInitialize volume replication.

Re-Initializes the replication connection on the destination volume.

begin_resync_replication

Resync volume replication.

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

begin_revert

Revert a volume to one of its snapshots.

Revert a volume to the snapshot specified in the body.

begin_update

Update a volume.

Patch the specified volume.

get

Describe a volume.

Get the details of the specified volume.

list

Describe all volumes.

List all volumes within the capacity pool.

replication_status

Get volume replication status.

Get the status of the replication.

begin_authorize_replication

Authorize source volume replication.

Authorize the replication connection on the source volume.

async begin_authorize_replication(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: azure.mgmt.netapp.models._models_py3.AuthorizeRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
AuthorizeRequest
Required

Authorize request object supplied in the body of the 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 None or the result of cls(response)

Return type

Exceptions

begin_break_replication

Break volume replication.

Break the replication connection on the destination volume.

async begin_break_replication(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: Optional[azure.mgmt.netapp.models._models_py3.BreakReplicationRequest] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
BreakReplicationRequest
default value: None

Optional body to force break the replication.

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_create_or_update

Create or Update a volume.

Create or update the specified volume within the capacity pool.

async begin_create_or_update(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: azure.mgmt.netapp.models._models_py3.Volume, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.netapp.models._models_py3.Volume]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
Volume
Required

Volume object supplied in the body of the 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 Volume or the result of cls(response)

Return type

Exceptions

begin_delete

Delete a volume.

Delete the specified volume.

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

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

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_delete_replication

Delete volume replication.

Delete the replication connection on the destination volume, and send release to the source replication.

async begin_delete_replication(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

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_pool_change

Change pool for volume.

Moves volume to another pool.

async begin_pool_change(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: azure.mgmt.netapp.models._models_py3.PoolChangeRequest, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
PoolChangeRequest
Required

Move volume to the pool supplied in the body of the 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 None or the result of cls(response)

Return type

Exceptions

begin_re_initialize_replication

ReInitialize volume replication.

Re-Initializes the replication connection on the destination volume.

async begin_re_initialize_replication(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

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_resync_replication

Resync volume replication.

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

async begin_resync_replication(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

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_revert

Revert a volume to one of its snapshots.

Revert a volume to the snapshot specified in the body.

async begin_revert(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: azure.mgmt.netapp.models._models_py3.VolumeRevert, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
VolumeRevert
Required

Object for snapshot to revert supplied in the body of the 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 None or the result of cls(response)

Return type

Exceptions

begin_update

Update a volume.

Patch the specified volume.

async begin_update(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, body: azure.mgmt.netapp.models._models_py3.VolumePatch, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.netapp.models._models_py3.Volume]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

body
VolumePatch
Required

Volume object supplied in the body of the 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 Volume or the result of cls(response)

Return type

Exceptions

get

Describe a volume.

Get the details of the specified volume.

async get(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, **kwargs: Any) -> azure.mgmt.netapp.models._models_py3.Volume

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

cls
callable

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

Returns

Volume, or the result of cls(response)

Return type

Exceptions

list

Describe all volumes.

List all volumes within the capacity pool.

list(resource_group_name: str, account_name: str, pool_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.netapp.models._models_py3.VolumeList]

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

cls
callable

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

Returns

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

Return type

Exceptions

replication_status

Get volume replication status.

Get the status of the replication.

async replication_status(resource_group_name: str, account_name: str, pool_name: str, volume_name: str, **kwargs: Any) -> azure.mgmt.netapp.models._models_py3.ReplicationStatus

Parameters

resource_group_name
str
Required

The name of the resource group.

account_name
str
Required

The name of the NetApp account.

pool_name
str
Required

The name of the capacity pool.

volume_name
str
Required

The name of the volume.

cls
callable

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

Returns

ReplicationStatus, or the result of cls(response)

Return type

Exceptions

Attributes

models

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