azure.mgmt.storage.v2016_01_01.operations module

class azure.mgmt.storage.v2016_01_01.operations.StorageAccountsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageManagementClient’s storage_accounts attribute.

begin_create(resource_group_name: str, account_name: str, parameters: StorageAccountCreateParameters | IO[bytes], **kwargs: Any) → LROPoller[StorageAccount][source]

Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

  • parameters (StorageAccountCreateParameters or IO[bytes]) – The parameters to provide for the created account. Is either a StorageAccountCreateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[StorageAccount]

Raises:

HttpResponseError –

check_name_availability(account_name: StorageAccountCheckNameAvailabilityParameters | IO[bytes], **kwargs: Any) → CheckNameAvailabilityResult[source]

Checks that the storage account name is valid and is not already in use.

Parameters:

account_name (StorageAccountCheckNameAvailabilityParameters or IO[bytes]) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Is either a StorageAccountCheckNameAvailabilityParameters type or a IO[bytes] type. Required.

Returns:

CheckNameAvailabilityResult or the result of cls(response)

Return type:

CheckNameAvailabilityResult

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, **kwargs: Any) → None[source]

Deletes a storage account in Microsoft Azure.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get_properties(resource_group_name: str, account_name: str, **kwargs: Any) → StorageAccount[source]

Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

Returns:

StorageAccount or the result of cls(response)

Return type:

StorageAccount

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[StorageAccount][source]

Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.

Returns:

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

Return type:

ItemPaged[StorageAccount]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[StorageAccount][source]

Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.

Parameters:

resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

Returns:

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

Return type:

ItemPaged[StorageAccount]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) → StorageAccountListKeysResult[source]

Lists the access keys for the specified storage account.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

Returns:

StorageAccountListKeysResult or the result of cls(response)

Return type:

StorageAccountListKeysResult

Raises:

HttpResponseError –

regenerate_key(resource_group_name: str, account_name: str, regenerate_key: StorageAccountRegenerateKeyParameters | IO[bytes], **kwargs: Any) → StorageAccountListKeysResult[source]

Regenerates one of the access keys for the specified storage account.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

  • regenerate_key (StorageAccountRegenerateKeyParameters or IO[bytes]) – Specifies name of the key which should be regenerated – key1 or key2. Is either a StorageAccountRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns:

StorageAccountListKeysResult or the result of cls(response)

Return type:

StorageAccountListKeysResult

Raises:

HttpResponseError –

update(resource_group_name: str, account_name: str, parameters: StorageAccountUpdateParameters | IO[bytes], **kwargs: Any) → StorageAccount[source]

The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.

Parameters:

  • resource_group_name (str) – The name of the resource group within the user’s subscription. Required.

  • account_name (str) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.

  • parameters (StorageAccountUpdateParameters or IO[bytes]) – The parameters to provide for the updated account. Is either a StorageAccountUpdateParameters type or a IO[bytes] type. Required.

Returns:

StorageAccount or the result of cls(response)

Return type:

StorageAccount

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storage.v2016_01_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2016_01_01/models/__init__.py'>
class azure.mgmt.storage.v2016_01_01.operations.UsageOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through StorageManagementClient’s usage attribute.

list(**kwargs: Any) → Iterable[Usage][source]

Gets the current usage count and the limit for the resources under the subscription.

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.storage.v2016_01_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2016_01_01/models/__init__.py'>