azure.mgmt.storage.v2018_02_01.operations module¶

class azure.mgmt.storage.v2018_02_01.operations.BlobContainersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LegalHold[source]¶

clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – The LegalHold property that will be clear from a blob container. Is either a LegalHold type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LegalHold or the result of cls(response)

Return type

Raises

HttpResponseError –

create(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BlobContainer[source]¶

create(resource_group_name: str, account_name: str, container_name: str, blob_container: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – Properties of the blob container to create. Is either a BlobContainer type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

BlobContainer or the result of cls(response)

Return type

Raises

HttpResponseError –

create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: Union[str, _models.Enum12], if_match: Optional[str] = None, parameters: Optional[_models.ImmutabilityPolicy] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ImmutabilityPolicy[source]¶

create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: Union[str, _models.Enum12], if_match: Optional[str] = None, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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.
immutability_policy_name (str or Enum12) – 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) – The ImmutabilityPolicy Properties that will be created or updated to a blob container. Is either a ImmutabilityPolicy type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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 [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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: Union[str, azure.mgmt.storage.v2018_02_01.models._storage_management_client_enums.Enum12], if_match: str, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.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, only way is to delete the container after deleting all blobs inside 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.
immutability_policy_name (str or Enum12) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: Optional[_models.ImmutabilityPolicy] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ImmutabilityPolicy[source]¶

extend_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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. 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) – The ImmutabilityPolicy Properties that will be extended for a blob container. Is either a ImmutabilityPolicy type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

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) → azure.mgmt.storage.v2018_02_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BlobContainer or the result of cls(response)

Return type

Raises

HttpResponseError –

get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: Union[str, azure.mgmt.storage.v2018_02_01.models._storage_management_client_enums.Enum12], if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.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 Enum12) – 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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: Optional[_models.LeaseContainerRequest] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LeaseContainerResponse[source]¶

lease(resource_group_name: str, account_name: str, container_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – Lease Container request body. Is either a LeaseContainerRequest type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LeaseContainerResponse or the result of cls(response)

Return type

LeaseContainerResponse

Raises

HttpResponseError –

list(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.ListContainerItems[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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ListContainerItems or the result of cls(response)

Return type

ListContainerItems

Raises

HttpResponseError –

lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

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: _models.LegalHold, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LegalHold[source]¶

set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – The LegalHold property that will be set to a blob container. Is either a LegalHold type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LegalHold or the result of cls(response)

Return type

Raises

HttpResponseError –

update(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BlobContainer[source]¶

update(resource_group_name: str, account_name: str, container_name: str, blob_container: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – Properties to update for the blob container. Is either a BlobContainer type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

BlobContainer or the result of cls(response)

Return type

Raises

HttpResponseError –

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

class azure.mgmt.storage.v2018_02_01.operations.Operations(*args, **kwargs)[source]¶

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[azure.mgmt.storage.v2018_02_01.models._models_py3.Operation][source]¶

Lists all of the available Storage Rest API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2018_02_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/storage/v2018_02_01/models/__init__.py'>¶

class azure.mgmt.storage.v2018_02_01.operations.SkusOperations(*args, **kwargs)[source]¶

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[azure.mgmt.storage.v2018_02_01.models._models_py3.Sku][source]¶

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

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Sku or the result of cls(response)
Return type: ItemPaged[Sku]
Raises: HttpResponseError –

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

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

Bases: object

Warning

DO NOT instantiate this class directly.

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

begin_create(resource_group_name: str, account_name: str, parameters: _models.StorageAccountCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.StorageAccount][source]¶

begin_create(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.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) – The parameters to provide for the created account. Is either a StorageAccountCreateParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[StorageAccount]

Raises

HttpResponseError –

check_name_availability(account_name: _models.StorageAccountCheckNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult[source]¶

check_name_availability(account_name: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityResult

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

Parameters

account_name (StorageAccountCheckNameAvailabilityParameters or IO) – 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 type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityResult or the result of cls(response)

Return type

CheckNameAvailabilityResult

Raises

HttpResponseError –

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

Deletes a storage account in Microsoft Azure.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get_properties(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageAccount or the result of cls(response)

Return type

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.storage.v2018_02_01.models._models_py3.StorageAccount][source]¶

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

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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: _models.AccountSasParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ListAccountSasResponse[source]¶

list_account_sas(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – The parameters to provide to list SAS credentials for the storage account. Is either a AccountSasParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ListAccountSasResponse or the result of cls(response)

Return type

ListAccountSasResponse

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.storage.v2018_02_01.models._models_py3.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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either StorageAccount or the result of cls(response)
Return type: ItemPaged[StorageAccount]
Raises: HttpResponseError –

list_keys(resource_group_name: str, account_name: str, **kwargs: Any) → azure.mgmt.storage.v2018_02_01.models._models_py3.StorageAccountListKeysResult[source]¶

Lists the access keys for the specified storage account.

Parameters

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageAccountListKeysResult or the result of cls(response)

Return type

StorageAccountListKeysResult

Raises

HttpResponseError –

list_service_sas(resource_group_name: str, account_name: str, parameters: _models.ServiceSasParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ListServiceSasResponse[source]¶

list_service_sas(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – The parameters to provide to list service SAS credentials. Is either a ServiceSasParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ListServiceSasResponse or the result of cls(response)

Return type

ListServiceSasResponse

Raises

HttpResponseError –

regenerate_key(resource_group_name: str, account_name: str, regenerate_key: _models.StorageAccountRegenerateKeyParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StorageAccountListKeysResult[source]¶

regenerate_key(resource_group_name: str, account_name: str, regenerate_key: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StorageAccountListKeysResult

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

Parameters

resource_group_name (str) – The name of the resource group within the user’s subscription. 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) – Specifies name of the key which should be regenerated – key1 or key2. Is either a StorageAccountRegenerateKeyParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageAccountListKeysResult or the result of cls(response)

Return type

StorageAccountListKeysResult

Raises

HttpResponseError –

update(resource_group_name: str, account_name: str, parameters: _models.StorageAccountUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StorageAccount[source]¶

update(resource_group_name: str, account_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.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) – The parameters to provide for the updated account. Is either a StorageAccountUpdateParameters type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageAccount or the result of cls(response)

Return type

Raises

HttpResponseError –

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

class azure.mgmt.storage.v2018_02_01.operations.UsageOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

list(**kwargs: Any) → Iterable[azure.mgmt.storage.v2018_02_01.models._models_py3.Usage][source]¶

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

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Usage or the result of cls(response)
Return type: ItemPaged[Usage]
Raises: HttpResponseError –

list_by_location(location: str, **kwargs: Any) → Iterable[azure.mgmt.storage.v2018_02_01.models._models_py3.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.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.v2018_02_01.models' from '/mnt/vss/_work/1/s/sdk/storage/azure-mgmt-storage/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/storage/v2018_02_01/models/__init__.py'>¶