azure.mgmt.storage.v2024_01_01.operations module

class azure.mgmt.storage.v2024_01_01.operations.BlobContainersOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_object_level_worm(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) → LROPoller[None]

This operation migrates a blob container from container level WORM to object level immutability enabled container. Prerequisites require a container level immutability policy either in locked or unlocked state, Account level versioning must be enabled and there should be no Legal hold on the container.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: LegalHold | IO[bytes], **kwargs: Any) → LegalHold

Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• legal_hold (LegalHold or IO[bytes]) – The LegalHold property that will be clear from a blob container. Is either a LegalHold type or a IO[bytes] type. Required.

Returns:

LegalHold or the result of cls(response)

Return type:

LegalHold

Raises:

HttpResponseError –

create(resource_group_name: str, account_name: str, container_name: str, blob_container: BlobContainer | IO[bytes], **kwargs: Any) → BlobContainer

Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• blob_container (BlobContainer or IO[bytes]) – Properties of the blob container to create. Is either a BlobContainer type or a IO[bytes] type. Required.

Returns:

BlobContainer or the result of cls(response)

Return type:

BlobContainer

Raises:

HttpResponseError –

create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str | None = None, parameters: ImmutabilityPolicy | IO[bytes] | None = None, **kwargs: Any) → ImmutabilityPolicy

Creates or updates an unlocked immutability policy. ETag in If-Match is honored if given but not required for this operation.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• if_match (str) – The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. Default value is None.

• parameters (ImmutabilityPolicy or IO[bytes]) – The ImmutabilityPolicy Properties that will be created or updated to a blob container. Is either a ImmutabilityPolicy type or a IO[bytes] type. Default value is None.

Returns:

ImmutabilityPolicy or the result of cls(response)

Return type:

ImmutabilityPolicy

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) → None

Deletes specified container under its account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) → ImmutabilityPolicy

Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, the only way is to delete the container after deleting all expired blobs inside the policy locked container.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• if_match (str) – The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. Required.

Returns:

ImmutabilityPolicy or the result of cls(response)

Return type:

ImmutabilityPolicy

Raises:

HttpResponseError –

extend_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, parameters: ImmutabilityPolicy | IO[bytes] | None = None, **kwargs: Any) → ImmutabilityPolicy

Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• if_match (str) – The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. Required.

• parameters (ImmutabilityPolicy or IO[bytes]) – The ImmutabilityPolicy Properties that will be extended for a blob container. Is either a ImmutabilityPolicy type or a IO[bytes] type. Default value is None.

Returns:

ImmutabilityPolicy or the result of cls(response)

Return type:

ImmutabilityPolicy

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) → BlobContainer

Gets properties of a specified container.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

Returns:

BlobContainer or the result of cls(response)

Return type:

BlobContainer

Raises:

HttpResponseError –

get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str | None = None, **kwargs: Any) → ImmutabilityPolicy

Gets the existing immutability policy along with the corresponding ETag in response headers and body.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• if_match (str) – The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. Default value is None.

Returns:

ImmutabilityPolicy or the result of cls(response)

Return type:

ImmutabilityPolicy

Raises:

HttpResponseError –

lease(resource_group_name: str, account_name: str, container_name: str, parameters: LeaseContainerRequest | IO[bytes] | None = None, **kwargs: Any) → LeaseContainerResponse

The Lease Container operation establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• parameters (LeaseContainerRequest or IO[bytes]) – Lease Container request body. Is either a LeaseContainerRequest type or a IO[bytes] type. Default value is None.

Returns:

LeaseContainerResponse or the result of cls(response)

Return type:

LeaseContainerResponse

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, include: str | ListContainersInclude | None = None, **kwargs: Any) → Iterable[ListContainerItem]

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (str) – Optional. Specified maximum number of containers that can be included in the list. Default value is None.

• filter (str) – Optional. When specified, only container names starting with the filter will be listed. Default value is None.

• include (str or ListContainersInclude) – Optional, used to include the properties for soft deleted blob containers. “deleted” Default value is None.

Returns:

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

Return type:

ItemPaged[ListContainerItem]

Raises:

HttpResponseError –

lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) → ImmutabilityPolicy

Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• if_match (str) – The entity state (ETag) version of the immutability policy to update must be returned to the server for all update operations. The ETag value must include the leading and trailing double quotes as returned by the service. Required.

Returns:

ImmutabilityPolicy or the result of cls(response)

Return type:

ImmutabilityPolicy

Raises:

HttpResponseError –

set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: LegalHold | IO[bytes], **kwargs: Any) → LegalHold

Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• legal_hold (LegalHold or IO[bytes]) – The LegalHold property that will be set to a blob container. Is either a LegalHold type or a IO[bytes] type. Required.

Returns:

LegalHold or the result of cls(response)

Return type:

LegalHold

Raises:

HttpResponseError –

update(resource_group_name: str, account_name: str, container_name: str, blob_container: BlobContainer | IO[bytes], **kwargs: Any) → BlobContainer

Updates container properties as specified in request body. Properties not mentioned in the request will be unchanged. Update fails if the specified container doesn’t already exist.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• container_name (str) – The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• blob_container (BlobContainer or IO[bytes]) – Properties to update for the blob container. Is either a BlobContainer type or a IO[bytes] type. Required.

Returns:

BlobContainer or the result of cls(response)

Return type:

BlobContainer

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.BlobInventoryPoliciesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, properties: BlobInventoryPolicy | IO[bytes], **kwargs: Any) → BlobInventoryPolicy

Sets the blob inventory policy to the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• blob_inventory_policy_name (str or BlobInventoryPolicyName) – The name of the storage account blob inventory policy. It should always be ‘default’. “default” Required.

• properties (BlobInventoryPolicy or IO[bytes]) – The blob inventory policy set to a storage account. Is either a BlobInventoryPolicy type or a IO[bytes] type. Required.

Returns:

BlobInventoryPolicy or the result of cls(response)

Return type:

BlobInventoryPolicy

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, **kwargs: Any) → None

Deletes the blob inventory policy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• blob_inventory_policy_name (str or BlobInventoryPolicyName) – The name of the storage account blob inventory policy. It should always be ‘default’. “default” Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, **kwargs: Any) → BlobInventoryPolicy

Gets the blob inventory policy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• blob_inventory_policy_name (str or BlobInventoryPolicyName) – The name of the storage account blob inventory policy. It should always be ‘default’. “default” Required.

Returns:

BlobInventoryPolicy or the result of cls(response)

Return type:

BlobInventoryPolicy

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[BlobInventoryPolicy]

Gets the blob inventory policy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[BlobInventoryPolicy]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.BlobServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_service_properties(resource_group_name: str, account_name: str, **kwargs: Any) → BlobServiceProperties

Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

BlobServiceProperties or the result of cls(response)

Return type:

BlobServiceProperties

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[BlobServiceProperties]

List blob services of storage account. It returns a collection of one object named default.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[BlobServiceProperties]

Raises:

HttpResponseError –

set_service_properties(resource_group_name: str, account_name: str, parameters: BlobServiceProperties | IO[bytes], **kwargs: Any) → BlobServiceProperties

Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (BlobServiceProperties or IO[bytes]) – The properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. Is either a BlobServiceProperties type or a IO[bytes] type. Required.

Returns:

BlobServiceProperties or the result of cls(response)

Return type:

BlobServiceProperties

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.DeletedAccountsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get(deleted_account_name: str, location: str, **kwargs: Any) → DeletedAccount

Get properties of specified deleted account resource.

Parameters:

• deleted_account_name (str) – Name of the deleted storage account. Required.

• location (str) – The location of the deleted storage account. Required.

Returns:

DeletedAccount or the result of cls(response)

Return type:

DeletedAccount

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[DeletedAccount]

Lists deleted accounts under the subscription.

Returns:

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

Return type:

ItemPaged[DeletedAccount]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.EncryptionScopesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get(resource_group_name: str, account_name: str, encryption_scope_name: str, **kwargs: Any) → EncryptionScope

Returns the properties for the specified encryption scope.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• encryption_scope_name (str) – The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

Returns:

EncryptionScope or the result of cls(response)

Return type:

EncryptionScope

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, filter: str | None = None, include: str | ListEncryptionScopesInclude | None = None, **kwargs: Any) → Iterable[EncryptionScope]

Lists all the encryption scopes available under the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (int) – Optional, specifies the maximum number of encryption scopes that will be included in the list response. Default value is None.

• filter (str) – Optional. When specified, only encryption scope names starting with the filter will be listed. Default value is None.

• include (str or ListEncryptionScopesInclude) – Optional, when specified, will list encryption scopes with the specific state. Defaults to All. Known values are: “All”, “Enabled”, and “Disabled”. Default value is None.

Returns:

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

Return type:

ItemPaged[EncryptionScope]

Raises:

HttpResponseError –

patch(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: EncryptionScope | IO[bytes], **kwargs: Any) → EncryptionScope

Update encryption scope properties as specified in the request body. Update fails if the specified encryption scope does not already exist.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• encryption_scope_name (str) – The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• encryption_scope (EncryptionScope or IO[bytes]) – Encryption scope properties to be used for the update. Is either a EncryptionScope type or a IO[bytes] type. Required.

Returns:

EncryptionScope or the result of cls(response)

Return type:

EncryptionScope

Raises:

HttpResponseError –

put(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: EncryptionScope | IO[bytes], **kwargs: Any) → EncryptionScope

Synchronously creates or updates an encryption scope under the specified storage account. If an encryption scope is already created and a subsequent request is issued with different properties, the encryption scope properties will be updated per the specified request.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• encryption_scope_name (str) – The name of the encryption scope within the specified storage account. Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• encryption_scope (EncryptionScope or IO[bytes]) – Encryption scope properties to be used for the create or update. Is either a EncryptionScope type or a IO[bytes] type. Required.

Returns:

EncryptionScope or the result of cls(response)

Return type:

EncryptionScope

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.FileServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_service_properties(resource_group_name: str, account_name: str, **kwargs: Any) → FileServiceProperties

Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

FileServiceProperties or the result of cls(response)

Return type:

FileServiceProperties

Raises:

HttpResponseError –

get_service_usage(resource_group_name: str, account_name: str, **kwargs: Any) → FileServiceUsage

Gets the usage of file service in storage account including account limits, file share limits and constants used in recommendations and bursting formula.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

FileServiceUsage or the result of cls(response)

Return type:

FileServiceUsage

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → FileServiceItems

List all file services in storage accounts.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

FileServiceItems or the result of cls(response)

Return type:

FileServiceItems

Raises:

HttpResponseError –

list_service_usages(resource_group_name: str, account_name: str, maxpagesize: int | None = None, **kwargs: Any) → Iterable[FileServiceUsage]

Gets the usages of file service in storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (int) – Optional, specifies the maximum number of file service usages to be included in the list response. Default value is None.

Returns:

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

Return type:

ItemPaged[FileServiceUsage]

Raises:

HttpResponseError –

set_service_properties(resource_group_name: str, account_name: str, parameters: FileServiceProperties | IO[bytes], **kwargs: Any) → FileServiceProperties

Sets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (FileServiceProperties or IO[bytes]) – The properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules. Is either a FileServiceProperties type or a IO[bytes] type. Required.

Returns:

FileServiceProperties or the result of cls(response)

Return type:

FileServiceProperties

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.FileSharesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create(resource_group_name: str, account_name: str, share_name: str, file_share: FileShare | IO[bytes], expand: str | None = None, **kwargs: Any) → FileShare

Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• file_share (FileShare or IO[bytes]) – Properties of the file share to create. Is either a FileShare type or a IO[bytes] type. Required.

• expand (str) – Optional, used to expand the properties within share’s properties. Valid values are: snapshots. Should be passed as a string with delimiter ‘,’. Default value is None.

Returns:

FileShare or the result of cls(response)

Return type:

FileShare

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) → None

Deletes specified share under its account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• x_ms_snapshot (str) – Optional, used to delete a snapshot. Default value is None.

• include (str) – Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For ‘snapshots’, the file share is deleted including all of its file share snapshots. If the file share contains leased-snapshots, the deletion fails. For ‘leased-snapshots’, the file share is deleted included all of its file share snapshots (leased/unleased). For ‘none’, the file share is deleted if it has no share snapshots. If the file share contains any snapshots (leased or unleased), the deletion fails. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, share_name: str, expand: str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) → FileShare

Gets properties of a specified share.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• expand (str) – Optional, used to expand the properties within share’s properties. Valid values are: stats. Should be passed as a string with delimiter ‘,’. Default value is None.

• x_ms_snapshot (str) – Optional, used to retrieve properties of a snapshot. Default value is None.

Returns:

FileShare or the result of cls(response)

Return type:

FileShare

Raises:

HttpResponseError –

lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, parameters: LeaseShareRequest | IO[bytes] | None = None, **kwargs: Any) → LeaseShareResponse

The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• x_ms_snapshot (str) – Optional. Specify the snapshot time to lease a snapshot. Default value is None.

• parameters (LeaseShareRequest or IO[bytes]) – Lease Share request body. Is either a LeaseShareRequest type or a IO[bytes] type. Default value is None.

Returns:

LeaseShareResponse or the result of cls(response)

Return type:

LeaseShareResponse

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any) → Iterable[FileShareItem]

Lists all shares.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (str) – Optional. Specified maximum number of shares that can be included in the list. Default value is None.

• filter (str) – Optional. When specified, only share names starting with the filter will be listed. Default value is None.

• expand (str) – Optional, used to expand the properties within share’s properties. Valid values are: deleted, snapshots. Should be passed as a string with delimiter ‘,’. Default value is None.

Returns:

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

Return type:

ItemPaged[FileShareItem]

Raises:

HttpResponseError –

restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: DeletedShare | IO[bytes], **kwargs: Any) → None

Restore a file share within a valid retention days if share soft delete is enabled.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• deleted_share (DeletedShare or IO[bytes]) – Is either a DeletedShare type or a IO[bytes] type. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

update(resource_group_name: str, account_name: str, share_name: str, file_share: FileShare | IO[bytes], **kwargs: Any) → FileShare

Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• share_name (str) – The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number. Required.

• file_share (FileShare or IO[bytes]) – Properties to update for the file share. Is either a FileShare type or a IO[bytes] type. Required.

Returns:

FileShare or the result of cls(response)

Return type:

FileShare

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.LocalUsersOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, account_name: str, username: str, properties: LocalUser | IO[bytes], **kwargs: Any) → LocalUser

Create or update the properties of a local user associated with the storage account. Properties for NFSv3 enablement and extended groups cannot be set with other properties.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• username (str) – The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

• properties (LocalUser or IO[bytes]) – The local user associated with a storage account. Is either a LocalUser type or a IO[bytes] type. Required.

Returns:

LocalUser or the result of cls(response)

Return type:

LocalUser

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, username: str, **kwargs: Any) → None

Deletes the local user associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• username (str) – The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, username: str, **kwargs: Any) → LocalUser

Get the local user of the storage account by username.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• username (str) – The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns:

LocalUser or the result of cls(response)

Return type:

LocalUser

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, filter: str | None = None, include: str | ListLocalUserIncludeParam | None = None, **kwargs: Any) → Iterable[LocalUser]

List the local users associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (int) – Optional, specifies the maximum number of local users that will be included in the list response. Default value is None.

• filter (str) – Optional. When specified, only local user names starting with the filter will be listed. Default value is None.

• include (str or ListLocalUserIncludeParam) – Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default. “nfsv3” Default value is None.

Returns:

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

Return type:

ItemPaged[LocalUser]

Raises:

HttpResponseError –

list_keys(resource_group_name: str, account_name: str, username: str, **kwargs: Any) → LocalUserKeys

List SSH authorized keys and shared key of the local user.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• username (str) – The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns:

LocalUserKeys or the result of cls(response)

Return type:

LocalUserKeys

Raises:

HttpResponseError –

regenerate_password(resource_group_name: str, account_name: str, username: str, **kwargs: Any) → LocalUserRegeneratePasswordResult

Regenerate the local user SSH password.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• username (str) – The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account. Required.

Returns:

LocalUserRegeneratePasswordResult or the result of cls(response)

Return type:

LocalUserRegeneratePasswordResult

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.ManagementPoliciesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, properties: ManagementPolicy | IO[bytes], **kwargs: Any) → ManagementPolicy

Sets the managementpolicy to the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• management_policy_name (str or ManagementPolicyName) – The name of the Storage Account Management Policy. It should always be ‘default’. “default” Required.

• properties (ManagementPolicy or IO[bytes]) – The ManagementPolicy set to a storage account. Is either a ManagementPolicy type or a IO[bytes] type. Required.

Returns:

ManagementPolicy or the result of cls(response)

Return type:

ManagementPolicy

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, **kwargs: Any) → None

Deletes the managementpolicy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• management_policy_name (str or ManagementPolicyName) – The name of the Storage Account Management Policy. It should always be ‘default’. “default” Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, **kwargs: Any) → ManagementPolicy

Gets the managementpolicy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• management_policy_name (str or ManagementPolicyName) – The name of the Storage Account Management Policy. It should always be ‘default’. “default” Required.

Returns:

ManagementPolicy or the result of cls(response)

Return type:

ManagementPolicy

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.NetworkSecurityPerimeterConfigurationsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_reconcile(resource_group_name: str, account_name: str, network_security_perimeter_configuration_name: str, **kwargs: Any) → LROPoller[None]

Refreshes any information about the association.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• network_security_perimeter_configuration_name (str) – The name for Network Security Perimeter configuration. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, network_security_perimeter_configuration_name: str, **kwargs: Any) → NetworkSecurityPerimeterConfiguration

Gets effective NetworkSecurityPerimeterConfiguration for association.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• network_security_perimeter_configuration_name (str) – The name for Network Security Perimeter configuration. Required.

Returns:

NetworkSecurityPerimeterConfiguration or the result of cls(response)

Return type:

NetworkSecurityPerimeterConfiguration

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[NetworkSecurityPerimeterConfiguration]

Gets list of effective NetworkSecurityPerimeterConfiguration for storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[NetworkSecurityPerimeterConfiguration]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.ObjectReplicationPoliciesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, account_name: str, object_replication_policy_id: str, properties: ObjectReplicationPolicy | IO[bytes], **kwargs: Any) → ObjectReplicationPolicy

Create or update the object replication policy of the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• object_replication_policy_id (str) – For the destination account, provide the value ‘default’. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. Required.

• properties (ObjectReplicationPolicy or IO[bytes]) – The object replication policy set to a storage account. A unique policy ID will be created if absent. Is either a ObjectReplicationPolicy type or a IO[bytes] type. Required.

Returns:

ObjectReplicationPolicy or the result of cls(response)

Return type:

ObjectReplicationPolicy

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, object_replication_policy_id: str, **kwargs: Any) → None

Deletes the object replication policy associated with the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• object_replication_policy_id (str) – For the destination account, provide the value ‘default’. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, object_replication_policy_id: str, **kwargs: Any) → ObjectReplicationPolicy

Get the object replication policy of the storage account by policy ID.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• object_replication_policy_id (str) – For the destination account, provide the value ‘default’. Configure the policy on the destination account first. For the source account, provide the value of the policy ID that is returned when you download the policy that was defined on the destination account. The policy is downloaded as a JSON file. Required.

Returns:

ObjectReplicationPolicy or the result of cls(response)

Return type:

ObjectReplicationPolicy

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[ObjectReplicationPolicy]

List the object replication policies associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[ObjectReplicationPolicy]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[Operation]

Lists all of the available Storage Rest API operations.

Returns:

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

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → None

Deletes the specified private endpoint connection associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection

Gets the specified private endpoint connection associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection]

List all the private endpoint connections associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

put(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, properties: PrivateEndpointConnection | IO[bytes], **kwargs: Any) → PrivateEndpointConnection

Update the state of specified private endpoint connection associated with the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• private_endpoint_connection_name (str) – The name of the private endpoint connection associated with the Azure resource. Required.

• properties (PrivateEndpointConnection or IO[bytes]) – The private endpoint connection properties. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.PrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_storage_account(resource_group_name: str, account_name: str, **kwargs: Any) → PrivateLinkResourceListResult

Gets the private link resources that need to be created for a storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

PrivateLinkResourceListResult or the result of cls(response)

Return type:

PrivateLinkResourceListResult

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.QueueOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create(resource_group_name: str, account_name: str, queue_name: str, queue: StorageQueue | IO[bytes], **kwargs: Any) → StorageQueue

Creates a new queue with the specified queue name, under the specified account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• queue_name (str) – A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. Required.

• queue (StorageQueue or IO[bytes]) – Queue properties and metadata to be created with. Is either a StorageQueue type or a IO[bytes] type. Required.

Returns:

StorageQueue or the result of cls(response)

Return type:

StorageQueue

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) → None

Deletes the queue with the specified queue name, under the specified account if it exists.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• queue_name (str) – A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) → StorageQueue

Gets the queue with the specified queue name, under the specified account if it exists.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• queue_name (str) – A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. Required.

Returns:

StorageQueue or the result of cls(response)

Return type:

StorageQueue

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, **kwargs: Any) → Iterable[ListQueue]

Gets a list of all the queues under the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• maxpagesize (str) – Optional, a maximum number of queues that should be included in a list queue response. Default value is None.

• filter (str) – Optional, When specified, only the queues with a name starting with the given filter will be listed. Default value is None.

Returns:

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

Return type:

ItemPaged[ListQueue]

Raises:

HttpResponseError –

update(resource_group_name: str, account_name: str, queue_name: str, queue: StorageQueue | IO[bytes], **kwargs: Any) → StorageQueue

Creates a new queue with the specified queue name, under the specified account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• queue_name (str) – A queue name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of lowercase alphanumeric and dash(-) characters only, it should begin and end with an alphanumeric character and it cannot have two consecutive dash(-) characters. Required.

• queue (StorageQueue or IO[bytes]) – Queue properties and metadata to be created with. Is either a StorageQueue type or a IO[bytes] type. Required.

Returns:

StorageQueue or the result of cls(response)

Return type:

StorageQueue

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.QueueServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_service_properties(resource_group_name: str, account_name: str, **kwargs: Any) → QueueServiceProperties

Gets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

QueueServiceProperties or the result of cls(response)

Return type:

QueueServiceProperties

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → ListQueueServices

List all queue services for the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

ListQueueServices or the result of cls(response)

Return type:

ListQueueServices

Raises:

HttpResponseError –

set_service_properties(resource_group_name: str, account_name: str, parameters: QueueServiceProperties | IO[bytes], **kwargs: Any) → QueueServiceProperties

Sets the properties of a storage account’s Queue service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (QueueServiceProperties or IO[bytes]) – The properties of a storage account’s Queue service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified. Is either a QueueServiceProperties type or a IO[bytes] type. Required.

Returns:

QueueServiceProperties or the result of cls(response)

Return type:

QueueServiceProperties

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.SkusOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[SkuInformation]

Lists the available SKUs supported by Microsoft.Storage for given subscription.

Returns:

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

Return type:

ItemPaged[SkuInformation]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.StorageAccountsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_abort_hierarchical_namespace_migration(resource_group_name: str, account_name: str, **kwargs: Any) → LROPoller[None]

Abort live Migration of storage account to enable Hns.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

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

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. The name is case insensitive. 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 –

begin_customer_initiated_migration(resource_group_name: str, account_name: str, parameters: StorageAccountMigration | IO[bytes], **kwargs: Any) → LROPoller[None]

Account Migration request can be triggered for a storage account to change its redundancy level. The migration updates the non-zonal redundant storage account to a zonal redundant account or vice-versa in order to have better reliability and availability. Zone-redundant storage (ZRS) replicates your storage account synchronously across three Azure availability zones in the primary region.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (StorageAccountMigration or IO[bytes]) – The request parameters required to perform storage account migration. Is either a StorageAccountMigration type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_failover(resource_group_name: str, account_name: str, failover_type: Literal['Planned'] = 'Planned', **kwargs: Any) → LROPoller[None]

A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account’s primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to ‘Planned’. Learn more about the failover options here- https://learn.microsoft.com/azure/storage/common/storage-disaster-recovery-guidance.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• failover_type (str) – The parameter is set to ‘Planned’ to indicate whether a Planned failover is requested. Known values are “Planned” and None. Default value is “Planned”.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_hierarchical_namespace_migration(resource_group_name: str, account_name: str, request_type: str, **kwargs: Any) → LROPoller[None]

Live Migration of storage account to enable Hns.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• request_type (str) – Required. Hierarchical namespace migration type can either be a hierarchical namespace validation request ‘HnsOnValidationRequest’ or a hydration request ‘HnsOnHydrationRequest’. The validation request will validate the migration whereas the hydration request will migrate the account. Required.

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_restore_blob_ranges(resource_group_name: str, account_name: str, parameters: BlobRestoreParameters | IO[bytes], **kwargs: Any) → LROPoller[BlobRestoreStatus]

Restore blobs in the specified blob ranges.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (BlobRestoreParameters or IO[bytes]) – The parameters to provide for restore blob ranges. Is either a BlobRestoreParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[BlobRestoreStatus]

Raises:

HttpResponseError –

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

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

Deletes a storage account in Microsoft Azure.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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_customer_initiated_migration(resource_group_name: str, account_name: str, migration_name: str | MigrationName, **kwargs: Any) → StorageAccountMigration

Gets the status of the ongoing migration for the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• migration_name (str or MigrationName) – The name of the Storage Account Migration. It should always be ‘default’. “default” Required.

Returns:

StorageAccountMigration or the result of cls(response)

Return type:

StorageAccountMigration

Raises:

HttpResponseError –

get_properties(resource_group_name: str, account_name: str, expand: str | StorageAccountExpand | None = None, **kwargs: Any) → StorageAccount

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. The name is case insensitive. 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.

• expand (str or StorageAccountExpand) – May be used to expand the properties within account’s properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats and blobRestoreStatus. Known values are: “geoReplicationStats” and “blobRestoreStatus”. Default value is None.

Returns:

StorageAccount or the result of cls(response)

Return type:

StorageAccount

Raises:

HttpResponseError –

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

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_account_sas(resource_group_name: str, account_name: str, parameters: AccountSasParameters | IO[bytes], **kwargs: Any) → ListAccountSasResponse

List SAS credentials of a storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (AccountSasParameters or IO[bytes]) – The parameters to provide to list SAS credentials for the storage account. Is either a AccountSasParameters type or a IO[bytes] type. Required.

Returns:

ListAccountSasResponse or the result of cls(response)

Return type:

ListAccountSasResponse

Raises:

HttpResponseError –

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

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. The name is case insensitive. 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, expand: Literal['kerb'] = 'kerb', **kwargs: Any) → StorageAccountListKeysResult

Lists the access keys or Kerberos keys (if active directory enabled) for the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• expand (str) – Specifies type of the key to be listed. Possible value is kerb. Known values are “kerb” and None. Default value is “kerb”.

Returns:

StorageAccountListKeysResult or the result of cls(response)

Return type:

StorageAccountListKeysResult

Raises:

HttpResponseError –

list_service_sas(resource_group_name: str, account_name: str, parameters: ServiceSasParameters | IO[bytes], **kwargs: Any) → ListServiceSasResponse

List service SAS credentials of a specific resource.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (ServiceSasParameters or IO[bytes]) – The parameters to provide to list service SAS credentials. Is either a ServiceSasParameters type or a IO[bytes] type. Required.

Returns:

ListServiceSasResponse or the result of cls(response)

Return type:

ListServiceSasResponse

Raises:

HttpResponseError –

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

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

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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, key2, kerb1, kerb2. Is either a StorageAccountRegenerateKeyParameters type or a IO[bytes] type. Required.

Returns:

StorageAccountListKeysResult or the result of cls(response)

Return type:

StorageAccountListKeysResult

Raises:

HttpResponseError –

revoke_user_delegation_keys(resource_group_name: str, account_name: str, **kwargs: Any) → None

Revoke user delegation keys.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 –

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

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. The name is case insensitive. 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.v2024_01_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2024_01_01/models/__init__.py'>

class azure.mgmt.storage.v2024_01_01.operations.StorageTaskAssignmentInstancesReportOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(resource_group_name: str, account_name: str, storage_task_assignment_name: str, maxpagesize: int | None = None, filter: str | None = None, **kwargs: Any) → Iterable[StorageTaskReportInstance]

Fetch the report summary of a single storage task assignment’s instances.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

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

• maxpagesize (int) – Optional, specifies the maximum number of storage task assignment instances to be included in the list response. Default value is None.

• filter (str) – Optional. When specified, it can be used to query using reporting properties. See Constructing Filter Strings for details. Default value is None.

Returns:

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

Return type:

ItemPaged[StorageTaskReportInstance]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.StorageTaskAssignmentsInstancesReportOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, filter: str | None = None, **kwargs: Any) → Iterable[StorageTaskReportInstance]

Fetch the report summary of all the storage task assignments and instances in an account.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

• maxpagesize (int) – Optional, specifies the maximum number of storage task assignment instances to be included in the list response. Default value is None.

• filter (str) –

  Optional. When specified, it can be used to query using reporting properties. See Constructing Filter Strings for details. Default value is None.

Returns:

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

Return type:

ItemPaged[StorageTaskReportInstance]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.StorageTaskAssignmentsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, account_name: str, storage_task_assignment_name: str, parameters: StorageTaskAssignment | IO[bytes], **kwargs: Any) → LROPoller[StorageTaskAssignment]

Asynchronously creates a new storage task assignment sub-resource with the specified parameters. If a storage task assignment is already created and a subsequent create request is issued with different properties, the storage task assignment properties will be updated. If a storage task assignment 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. The name is case insensitive. 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.

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

• parameters (StorageTaskAssignment or IO[bytes]) – The parameters to create a Storage Task Assignment. Is either a StorageTaskAssignment type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[StorageTaskAssignment]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, account_name: str, storage_task_assignment_name: str, **kwargs: Any) → LROPoller[None]

Delete the storage task assignment sub-resource.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

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

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_update(resource_group_name: str, account_name: str, storage_task_assignment_name: str, parameters: StorageTaskAssignmentUpdateParameters | IO[bytes], **kwargs: Any) → LROPoller[StorageTaskAssignment]

Update storage task assignment properties.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

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

• parameters (StorageTaskAssignmentUpdateParameters or IO[bytes]) – The parameters to update a Storage Task Assignment. Is either a StorageTaskAssignmentUpdateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[StorageTaskAssignment]

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, storage_task_assignment_name: str, **kwargs: Any) → StorageTaskAssignment

Get the storage task assignment properties.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

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

Returns:

StorageTaskAssignment or the result of cls(response)

Return type:

StorageTaskAssignment

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, maxpagesize: int | None = None, **kwargs: Any) → Iterable[StorageTaskAssignment]

List all the storage task assignments in an account.

Parameters:

• resource_group_name (str) – The name of the resource group. The name is case insensitive. 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.

• maxpagesize (int) – Optional, specifies the maximum number of storage task assignment Ids to be included in the list response. Default value is None.

Returns:

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

Return type:

ItemPaged[StorageTaskAssignment]

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.TableOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create(resource_group_name: str, account_name: str, table_name: str, parameters: Table | IO[bytes] | None = None, **kwargs: Any) → Table

Creates a new table with the specified table name, under the specified account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• table_name (str) – A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. Required.

• parameters (Table or IO[bytes]) – The parameters to provide to create a table. Is either a Table type or a IO[bytes] type. Default value is None.

Returns:

Table or the result of cls(response)

Return type:

Table

Raises:

HttpResponseError –

delete(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → None

Deletes the table with the specified table name, under the specified account if it exists.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• table_name (str) – A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) → Table

Gets the table with the specified table name, under the specified account if it exists.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• table_name (str) – A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. Required.

Returns:

Table or the result of cls(response)

Return type:

Table

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → Iterable[Table]

Gets a list of all the tables under the specified storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

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

Return type:

ItemPaged[Table]

Raises:

HttpResponseError –

update(resource_group_name: str, account_name: str, table_name: str, parameters: Table | IO[bytes] | None = None, **kwargs: Any) → Table

Creates a new table with the specified table name, under the specified account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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.

• table_name (str) – A table name must be unique within a storage account and must be between 3 and 63 characters.The name must comprise of only alphanumeric characters and it cannot begin with a numeric character. Required.

• parameters (Table or IO[bytes]) – The parameters to provide to create a table. Is either a Table type or a IO[bytes] type. Default value is None.

Returns:

Table or the result of cls(response)

Return type:

Table

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.TableServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_service_properties(resource_group_name: str, account_name: str, **kwargs: Any) → TableServiceProperties

Gets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

TableServiceProperties or the result of cls(response)

Return type:

TableServiceProperties

Raises:

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → ListTableServices

List all table services for the storage account.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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:

ListTableServices or the result of cls(response)

Return type:

ListTableServices

Raises:

HttpResponseError –

set_service_properties(resource_group_name: str, account_name: str, parameters: TableServiceProperties | IO[bytes], **kwargs: Any) → TableServiceProperties

Sets the properties of a storage account’s Table service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.

Parameters:

• resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. 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 (TableServiceProperties or IO[bytes]) – The properties of a storage account’s Table service, only properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules can be specified. Is either a TableServiceProperties type or a IO[bytes] type. Required.

Returns:

TableServiceProperties or the result of cls(response)

Return type:

TableServiceProperties

Raises:

HttpResponseError –

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

class azure.mgmt.storage.v2024_01_01.operations.UsagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_location(location: str, **kwargs: Any) → Iterable[Usage]

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

Parameters:

location (str) – The location of the Azure Storage resource. Required.

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.v2024_01_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2024_01_01/models/__init__.py'>