azure.mgmt.storage.v2019_06_01.operations module
- class azure.mgmt.storage.v2019_06_01.operations.BlobContainersOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sblob_containersattribute.- clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: LegalHold | IO[bytes], **kwargs: Any) LegalHold[source]
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:
- Raises:
- create(resource_group_name: str, account_name: str, container_name: str, blob_container: BlobContainer | IO[bytes], **kwargs: Any) BlobContainer[source]
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:
- Raises:
- create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum27, if_match: str | None = None, parameters: ImmutabilityPolicy | IO[bytes] | None = None, **kwargs: Any) ImmutabilityPolicy[source]
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.
immutability_policy_name (str or Enum27) – The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be ‘default’. “default” Required.
if_match (str) – The entity state (ETag) version of the immutability policy to update. A value of “*” can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. 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:
- Raises:
- delete(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) None[source]
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:
- delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum27, if_match: str, **kwargs: Any) ImmutabilityPolicy[source]
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.
immutability_policy_name (str or Enum27) – The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be ‘default’. “default” Required.
if_match (str) – The entity state (ETag) version of the immutability policy to update. A value of “*” can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. Required.
- Returns:
ImmutabilityPolicy or the result of cls(response)
- Return type:
- Raises:
- 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[source]
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. A value of “*” can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. 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:
- Raises:
- get(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) BlobContainer[source]
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:
- Raises:
- get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum27, if_match: str | None = None, **kwargs: Any) ImmutabilityPolicy[source]
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.
immutability_policy_name (str or Enum27) – The name of the blob container immutabilityPolicy within the specified storage account. ImmutabilityPolicy Name must be ‘default’. “default” Required.
if_match (str) – The entity state (ETag) version of the immutability policy to update. A value of “*” can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. Default value is None.
- Returns:
ImmutabilityPolicy or the result of cls(response)
- Return type:
- Raises:
- lease(resource_group_name: str, account_name: str, container_name: str, parameters: LeaseContainerRequest | IO[bytes] | None = None, **kwargs: Any) LeaseContainerResponse[source]
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:
- Raises:
- 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][source]
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:
- Raises:
- lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) ImmutabilityPolicy[source]
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. A value of “*” can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied. Required.
- Returns:
ImmutabilityPolicy or the result of cls(response)
- Return type:
- Raises:
- set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: LegalHold | IO[bytes], **kwargs: Any) LegalHold[source]
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:
- Raises:
- update(resource_group_name: str, account_name: str, container_name: str, blob_container: BlobContainer | IO[bytes], **kwargs: Any) BlobContainer[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.BlobInventoryPoliciesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sblob_inventory_policiesattribute.- create_or_update(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, properties: BlobInventoryPolicy | IO[bytes], **kwargs: Any) BlobInventoryPolicy[source]
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:
- Raises:
- delete(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, **kwargs: Any) None[source]
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:
- get(resource_group_name: str, account_name: str, blob_inventory_policy_name: str | BlobInventoryPolicyName, **kwargs: Any) BlobInventoryPolicy[source]
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:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[BlobInventoryPolicy][source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.BlobServicesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sblob_servicesattribute.- get_service_properties(resource_group_name: str, account_name: str, blob_services_name: str | Enum27, **kwargs: Any) BlobServiceProperties[source]
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.
blob_services_name (str or Enum27) – The name of the blob Service within the specified storage account. Blob Service Name must be ‘default’. “default” Required.
- Returns:
BlobServiceProperties or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[BlobServiceProperties][source]
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:
- Raises:
- set_service_properties(resource_group_name: str, account_name: str, blob_services_name: str | Enum27, parameters: BlobServiceProperties | IO[bytes], **kwargs: Any) BlobServiceProperties[source]
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.
blob_services_name (str or Enum27) – The name of the blob Service within the specified storage account. Blob Service Name must be ‘default’. “default” 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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.EncryptionScopesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sencryption_scopesattribute.- get(resource_group_name: str, account_name: str, encryption_scope_name: str, **kwargs: Any) EncryptionScope[source]
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:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[EncryptionScope][source]
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.
- Returns:
An iterator like instance of either EncryptionScope or the result of cls(response)
- Return type:
- Raises:
- patch(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: EncryptionScope | IO[bytes], **kwargs: Any) EncryptionScope[source]
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:
- Raises:
- put(resource_group_name: str, account_name: str, encryption_scope_name: str, encryption_scope: EncryptionScope | IO[bytes], **kwargs: Any) EncryptionScope[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.FileServicesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sfile_servicesattribute.- get_service_properties(resource_group_name: str, account_name: str, file_services_name: str | Enum27, **kwargs: Any) FileServiceProperties[source]
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.
file_services_name (str or Enum27) – The name of the file Service within the specified storage account. File Service Name must be “default”. “default” Required.
- Returns:
FileServiceProperties or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) FileServiceItems[source]
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:
- Raises:
- set_service_properties(resource_group_name: str, account_name: str, file_services_name: str | Enum27, parameters: FileServiceProperties | IO[bytes], **kwargs: Any) FileServiceProperties[source]
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.
file_services_name (str or Enum27) – The name of the file Service within the specified storage account. File Service Name must be “default”. “default” 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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sfile_sharesattribute.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.
- Returns:
FileShare or the result of cls(response)
- Return type:
- Raises:
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.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
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. Known values are “stats” and None. Default value is “stats”.
- Returns:
FileShare or the result of cls(response)
- Return type:
- Raises:
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. Known values are “deleted” and None. Default value is “deleted”.
- Returns:
An iterator like instance of either FileShareItem or the result of cls(response)
- Return type:
- Raises:
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:
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:
- Raises:
- class azure.mgmt.storage.v2019_06_01.operations.ManagementPoliciesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’smanagement_policiesattribute.- create_or_update(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, properties: ManagementPolicy | IO[bytes], **kwargs: Any) ManagementPolicy[source]
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:
- Raises:
- delete(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, **kwargs: Any) None[source]
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:
- get(resource_group_name: str, account_name: str, management_policy_name: str | ManagementPolicyName, **kwargs: Any) ManagementPolicy[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.ObjectReplicationPoliciesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sobject_replication_policiesattribute.- create_or_update(resource_group_name: str, account_name: str, object_replication_policy_id: str, properties: ObjectReplicationPolicy | IO[bytes], **kwargs: Any) ObjectReplicationPolicy[source]
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) – The ID of object replication policy or ‘default’ if the policy ID is unknown. 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:
- Raises:
- delete(resource_group_name: str, account_name: str, object_replication_policy_id: str, **kwargs: Any) None[source]
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) – The ID of object replication policy or ‘default’ if the policy ID is unknown. Required.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, account_name: str, object_replication_policy_id: str, **kwargs: Any) ObjectReplicationPolicy[source]
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) – The ID of object replication policy or ‘default’ if the policy ID is unknown. Required.
- Returns:
ObjectReplicationPolicy or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[ObjectReplicationPolicy][source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.Operations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’soperationsattribute.- list(**kwargs: Any) Iterable[Operation][source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sprivate_endpoint_connectionsattribute.- delete(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) None[source]
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:
- get(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, **kwargs: Any) PrivateEndpointConnection[source]
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:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[PrivateEndpointConnection][source]
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:
- Raises:
- put(resource_group_name: str, account_name: str, private_endpoint_connection_name: str, properties: PrivateEndpointConnection | IO[bytes], **kwargs: Any) PrivateEndpointConnection[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sprivate_link_resourcesattribute.- list_by_storage_account(resource_group_name: str, account_name: str, **kwargs: Any) PrivateLinkResourceListResult[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.QueueOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’squeueattribute.- create(resource_group_name: str, account_name: str, queue_name: str, queue: StorageQueue | IO[bytes], **kwargs: Any) StorageQueue[source]
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:
- Raises:
- delete(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) None[source]
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:
- get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) StorageQueue[source]
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:
- Raises:
- list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, **kwargs: Any) Iterable[ListQueue][source]
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:
- Raises:
- update(resource_group_name: str, account_name: str, queue_name: str, queue: StorageQueue | IO[bytes], **kwargs: Any) StorageQueue[source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.QueueServicesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’squeue_servicesattribute.- get_service_properties(resource_group_name: str, account_name: str, queue_service_name: str | Enum27, **kwargs: Any) QueueServiceProperties[source]
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.
queue_service_name (str or Enum27) – The name of the Queue Service within the specified storage account. Queue Service Name must be ‘default’. “default” Required.
- Returns:
QueueServiceProperties or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) ListQueueServices[source]
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:
- Raises:
- set_service_properties(resource_group_name: str, account_name: str, queue_service_name: str | Enum27, parameters: QueueServiceProperties | IO[bytes], **kwargs: Any) QueueServiceProperties[source]
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.
queue_service_name (str or Enum27) – The name of the Queue Service within the specified storage account. Queue Service Name must be ‘default’. “default” 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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.SkusOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sskusattribute.- list(**kwargs: Any) Iterable[SkuInformation][source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.StorageAccountsOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’sstorage_accountsattribute.- begin_create(resource_group_name: str, account_name: str, parameters: StorageAccountCreateParameters | IO[bytes], **kwargs: Any) LROPoller[StorageAccount][source]
Asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed.
- Parameters:
resource_group_name (str) – The name of the resource group within the user’s subscription. 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:
- Raises:
- begin_failover(resource_group_name: str, account_name: str, **kwargs: Any) LROPoller[None][source]
Failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account’s primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover.
- 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:
- begin_restore_blob_ranges(resource_group_name: str, account_name: str, parameters: BlobRestoreParameters | IO[bytes], **kwargs: Any) LROPoller[BlobRestoreStatus][source]
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:
- Raises:
- check_name_availability(account_name: StorageAccountCheckNameAvailabilityParameters | IO[bytes], **kwargs: Any) CheckNameAvailabilityResult[source]
Checks that the storage account name is valid and is not already in use.
- Parameters:
account_name (StorageAccountCheckNameAvailabilityParameters or IO[bytes]) – The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Is either a StorageAccountCheckNameAvailabilityParameters type or a IO[bytes] type. Required.
- Returns:
CheckNameAvailabilityResult or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, account_name: str, **kwargs: Any) None[source]
Deletes a storage account in Microsoft Azure.
- Parameters:
resource_group_name (str) – The name of the resource group within the user’s subscription. 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:
- get_properties(resource_group_name: str, account_name: str, expand: str | StorageAccountExpand | None = None, **kwargs: Any) StorageAccount[source]
Returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys.
- Parameters:
resource_group_name (str) – The name of the resource group within the user’s subscription. 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:
- Raises:
- list(**kwargs: Any) Iterable[StorageAccount][source]
Lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.
- Returns:
An iterator like instance of either StorageAccount or the result of cls(response)
- Return type:
- Raises:
- list_account_sas(resource_group_name: str, account_name: str, parameters: AccountSasParameters | IO[bytes], **kwargs: Any) ListAccountSasResponse[source]
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:
- Raises:
- list_by_resource_group(resource_group_name: str, **kwargs: Any) Iterable[StorageAccount][source]
Lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.
- Parameters:
resource_group_name (str) – The name of the resource group within the user’s subscription. The name is case insensitive. Required.
- Returns:
An iterator like instance of either StorageAccount or the result of cls(response)
- Return type:
- Raises:
- list_keys(resource_group_name: str, account_name: str, expand: Literal['kerb'] = 'kerb', **kwargs: Any) StorageAccountListKeysResult[source]
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:
- Raises:
- list_service_sas(resource_group_name: str, account_name: str, parameters: ServiceSasParameters | IO[bytes], **kwargs: Any) ListServiceSasResponse[source]
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:
- Raises:
- regenerate_key(resource_group_name: str, account_name: str, regenerate_key: StorageAccountRegenerateKeyParameters | IO[bytes], **kwargs: Any) StorageAccountListKeysResult[source]
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:
- Raises:
- revoke_user_delegation_keys(resource_group_name: str, account_name: str, **kwargs: Any) None[source]
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:
- update(resource_group_name: str, account_name: str, parameters: StorageAccountUpdateParameters | IO[bytes], **kwargs: Any) StorageAccount[source]
The update operation can be used to update the SKU, encryption, access tier, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account; the replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.
- Parameters:
resource_group_name (str) – The name of the resource group within the user’s subscription. 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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.TableOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’stableattribute.- create(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) Table[source]
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.
- Returns:
Table or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) None[source]
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:
- get(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) Table[source]
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:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) Iterable[Table][source]
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:
- Raises:
- update(resource_group_name: str, account_name: str, table_name: str, **kwargs: Any) Table[source]
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.
- Returns:
Table or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.TableServicesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’stable_servicesattribute.- get_service_properties(resource_group_name: str, account_name: str, table_service_name: str | Enum27, **kwargs: Any) TableServiceProperties[source]
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.
table_service_name (str or Enum27) – The name of the Table Service within the specified storage account. Table Service Name must be ‘default’. “default” Required.
- Returns:
TableServiceProperties or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, account_name: str, **kwargs: Any) ListTableServices[source]
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:
- Raises:
- set_service_properties(resource_group_name: str, account_name: str, table_service_name: str | Enum27, parameters: TableServiceProperties | IO[bytes], **kwargs: Any) TableServiceProperties[source]
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.
table_service_name (str or Enum27) – The name of the Table Service within the specified storage account. Table Service Name must be ‘default’. “default” 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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>
- class azure.mgmt.storage.v2019_06_01.operations.UsagesOperations(*args, **kwargs)[source]
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
StorageManagementClient’susagesattribute.- list_by_location(location: str, **kwargs: Any) Iterable[Usage][source]
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:
- Raises:
- models = <module 'azure.mgmt.storage.v2019_06_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/storage/v2019_06_01/models/__init__.py'>