DiskPoolsOperations Class

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

Constructor

DiskPoolsOperations(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

Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.

begin_deallocate

Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.

begin_delete

Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.

begin_start

The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.

begin_update

Update a Disk pool.

begin_upgrade

Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.

get

Get a Disk pool.

list_by_resource_group

Gets a list of DiskPools in a resource group.

list_by_subscription

Gets a list of Disk Pools in a subscription.

list_outbound_network_dependencies_endpoints

Gets the network endpoints of all outbound dependencies of a Disk Pool.

begin_create_or_update

Create or Update Disk pool. This create or update operation can take 15 minutes to complete. This is expected service behavior.

async begin_create_or_update(resource_group_name: str, disk_pool_name: str, disk_pool_create_payload: azure.mgmt.storagepool.models._models_py3.DiskPoolCreate, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagepool.models._models_py3.DiskPool]

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

disk_pool_create_payload
<xref:storage_pool_management.models.DiskPoolCreate>
Required

Request payload for Disk Pool create 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 DiskPool or the result of cls(response)

Return type

AsyncLROPoller[<xref:storage_pool_management.models.DiskPool>]

Exceptions

begin_deallocate

Shuts down the Disk Pool and releases the compute resources. You are not billed for the compute resources that this Disk Pool uses. This operation can take 10 minutes to complete. This is expected service behavior.

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

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

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

Delete a Disk pool; attached disks are not affected. This delete operation can take 10 minutes to complete. This is expected service behavior.

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

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

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_start

The operation to start a Disk Pool. This start operation can take 10 minutes to complete. This is expected service behavior.

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

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

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 Disk pool.

async begin_update(resource_group_name: str, disk_pool_name: str, disk_pool_update_payload: azure.mgmt.storagepool.models._models_py3.DiskPoolUpdate, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.storagepool.models._models_py3.DiskPool]

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

disk_pool_update_payload
<xref:storage_pool_management.models.DiskPoolUpdate>
Required

Request payload for Disk Pool update 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 DiskPool or the result of cls(response)

Return type

AsyncLROPoller[<xref:storage_pool_management.models.DiskPool>]

Exceptions

begin_upgrade

Upgrade replaces the underlying virtual machine hosts one at a time. This operation can take 10-15 minutes to complete. This is expected service behavior.

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

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

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

get

Get a Disk pool.

async get(resource_group_name: str, disk_pool_name: str, **kwargs: Any) -> azure.mgmt.storagepool.models._models_py3.DiskPool

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

cls
callable

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

Returns

DiskPool, or the result of cls(response)

Return type

<xref:storage_pool_management.models.DiskPool>

Exceptions

list_by_resource_group

Gets a list of DiskPools in a resource group.

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

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

cls
callable

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

Returns

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

Return type

AsyncItemPaged[<xref:storage_pool_management.models.DiskPoolListResult>]

Exceptions

list_by_subscription

Gets a list of Disk Pools in a subscription.

list_by_subscription(**kwargs: Any) -> AsyncIterable[azure.mgmt.storagepool.models._models_py3.DiskPoolListResult]

Parameters

cls
callable

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

Returns

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

Return type

AsyncItemPaged[<xref:storage_pool_management.models.DiskPoolListResult>]

Exceptions

list_outbound_network_dependencies_endpoints

Gets the network endpoints of all outbound dependencies of a Disk Pool.

list_outbound_network_dependencies_endpoints(resource_group_name: str, disk_pool_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.storagepool.models._models_py3.OutboundEnvironmentEndpointList]

Parameters

resource_group_name
str
Required

The name of the resource group. The name is case insensitive.

disk_pool_name
str
Required

The name of the Disk Pool.

cls
callable

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

Returns

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

Return type

AsyncItemPaged[<xref:storage_pool_management.models.OutboundEnvironmentEndpointList>]

Exceptions

Attributes

models

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