ContainerClient Class

Reference

A client to interact with a specific container, although that container may not yet exist.

For operations relating to a specific blob within this container, a blob client can be retrieved using the get_blob_client function.

For more optional configuration, please click here.

Inheritance: azure.storage.blob._shared.base_client.StorageAccountHostsMixin

ContainerClient

azure.storage.blob._encryption.StorageEncryptionMixin

ContainerClient

Constructor

ContainerClient(account_url: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parameters

Name	Description
account_url Required	str The URI to the storage account. In order to create a client given the full URI to the container, use the from_container_url classmethod.
container_name Required	str The name of the container for the blob.
credential	The credentials with which to authenticate. This is optional if the account URL already has a SAS token. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. Default value: None

Keyword-Only Parameters

Name	Description
api_version	str The Storage API version to use for requests. Default value is the most recent service version that is compatible with the current SDK. Setting to an older version may result in reduced feature compatibility. New in version 12.2.0.
secondary_hostname	str The hostname of the secondary endpoint.
max_block_size	int The maximum chunk size for uploading a block blob in chunks. Defaults to `410241024`, or 4MB.
max_single_put_size	int If the blob size is less than or equal max_single_put_size, then the blob will be uploaded with only one http PUT request. If the blob size is larger than max_single_put_size, the blob will be uploaded in chunks. Defaults to `6410241024`, or 64MB.
min_large_block_upload_threshold	int The minimum chunk size required to use the memory efficient algorithm when uploading a block blob. Defaults to `410241024`+1.
use_byte_buffer	bool Use a byte buffer for block blob uploads. Defaults to False.
max_page_size	int The maximum chunk size for uploading a page blob. Defaults to `410241024`, or 4MB.
max_single_get_size	int The maximum size for a blob to be downloaded in a single call, the exceeded part will be downloaded in chunks (could be parallel). Defaults to `3210241024`, or 32MB.
max_chunk_get_size	int The maximum chunk size used for downloading a blob. Defaults to `410241024`, or 4MB.
audience	str The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net.

Methods

acquire_lease	Requests a new lease. If the container does not have an active lease, the Blob service creates a lease on the container and returns a new lease ID.
close	This method is to close the sockets opened by the client. It need not be used when using with a context manager.
create_container	Creates a new container under the specified account. If the container with the same name already exists, the operation fails.
delete_blob	Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the delete_blob operation. If a delete retention policy is enabled for the service, then this operation soft deletes the blob or snapshot and retains the blob or snapshot for specified number of days. After specified number of days, blob's data is removed from the service during garbage collection. Soft deleted blob or snapshot is accessible through list_blobs specifying include=["deleted"] option. Soft-deleted blob or snapshot can be restored using <xref:azure.storage.blob.BlobClient.undelete>
delete_blobs	Marks the specified blobs or snapshots for deletion. The blobs are later deleted during garbage collection. Note that in order to delete blobs, you must delete all of their snapshots. You can delete both at the same time with the delete_blobs operation. If a delete retention policy is enabled for the service, then this operation soft deletes the blobs or snapshots and retains the blobs or snapshots for specified number of days. After specified number of days, blobs' data is removed from the service during garbage collection. Soft deleted blobs or snapshots are accessible through list_blobs specifying include=["deleted"] Soft-deleted blobs or snapshots can be restored using <xref:azure.storage.blob.BlobClient.undelete> The maximum number of blobs that can be deleted in a single request is 256.
delete_container	Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.
download_blob	Downloads a blob to the StorageStreamDownloader. The readall() method must be used to read all the content or readinto() must be used to download the blob into a stream. Using chunks() returns an iterator which allows the user to iterate over the content in chunks.
exists	Returns True if a container exists and returns False otherwise.
find_blobs_by_tags	Returns a generator to list the blobs under the specified container whose tags match the given search expression. The generator will lazily follow the continuation tokens returned by the service.
from_connection_string	Create ContainerClient from a Connection String.
from_container_url	Create ContainerClient from a container url.
get_account_information	Gets information related to the storage account. The information can also be retrieved if the user has a SAS to a container or blob. The keys in the returned dictionary include 'sku_name' and 'account_kind'.
get_blob_client	Get a client to interact with the specified blob. The blob need not already exist.
get_container_access_policy	Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.
get_container_properties	Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.
list_blob_names	Returns a generator to list the names of blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service. Note that no additional properties or metadata will be returned when using this API. Additionally, this API does not have an option to include additional blobs such as snapshots, versions, soft-deleted blobs, etc. To get any of this data, use list_blobs.
list_blobs	Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service.
set_container_access_policy	Sets the permissions for the specified container or stored access policies that may be used with Shared Access Signatures. The permissions indicate whether blobs in a container may be accessed publicly.
set_container_metadata	Sets one or more user-defined name-value pairs for the specified container. Each call to this operation replaces all existing metadata attached to the container. To remove all metadata from the container, call this operation with no metadata dict.
set_premium_page_blob_tier_blobs	Sets the page blob tiers on all blobs. This API is only supported for page blobs on premium accounts. The maximum number of blobs that can be updated in a single request is 256.
set_standard_blob_tier_blobs	This operation sets the tier on block blobs. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag. The maximum number of blobs that can be updated in a single request is 256.
upload_blob	Creates a new blob from a data source with automatic chunking.
walk_blobs	Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service. This operation will list blobs in accordance with a hierarchy, as delimited by the specified delimiter character.

acquire_lease

Requests a new lease. If the container does not have an active lease, the Blob service creates a lease on the container and returns a new lease ID.

acquire_lease(lease_duration: int = -1, lease_id: str | None = None, **kwargs: Any) -> BlobLeaseClient

Parameters

Name	Description
lease_duration Required	int Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. Default is -1 (infinite lease).
lease_id Required	str Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format.

Keyword-Only Parameters

Name	Description
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
BlobLeaseClient	A BlobLeaseClient object, that can be run in a context manager.

close

This method is to close the sockets opened by the client. It need not be used when using with a context manager.

close()

Keyword-Only Parameters

Name	Description
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

create_container

Creates a new container under the specified account. If the container with the same name already exists, the operation fails.

create_container(metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parameters

Name	Description
metadata Required	dict[str, str] A dict with name_value pairs to associate with the container as metadata. Example:{'Category':'test'}
public_access Required	PublicAccess Possible values include: 'container', 'blob'.

Keyword-Only Parameters

Name	Description
container_encryption_scope	dict or ContainerEncryptionScope Specifies the default encryption scope to set on the container and use for all future writes. New in version 12.2.0.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
Dict[str, Union[str, datetime]]	A dictionary of response headers.

delete_blob

Marks the specified blob or snapshot for deletion.

The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the delete_blob operation.

If a delete retention policy is enabled for the service, then this operation soft deletes the blob or snapshot and retains the blob or snapshot for specified number of days. After specified number of days, blob's data is removed from the service during garbage collection. Soft deleted blob or snapshot is accessible through list_blobs specifying include=["deleted"] option. Soft-deleted blob or snapshot can be restored using <xref:azure.storage.blob.BlobClient.undelete>

delete_blob(blob: str, delete_snapshots: str | None = None, **kwargs: Any) -> None

Parameters

Name	Description
blob Required	str The blob with which to interact.
delete_snapshots Required	str Required if the blob has associated snapshots. Values include: "only": Deletes only the blobs snapshots. "include": Deletes the blob along with all snapshots.

Keyword-Only Parameters

Name	Description
version_id	str The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to delete. New in version 12.4.0. This keyword argument was introduced in API version '2019-12-12'.
lease	BlobLeaseClient or str Required if the blob has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
if_tags_match_condition	str Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. `"\"tagname\"='my tag'"` New in version 12.4.0.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
None

delete_blobs

Marks the specified blobs or snapshots for deletion.

The blobs are later deleted during garbage collection. Note that in order to delete blobs, you must delete all of their snapshots. You can delete both at the same time with the delete_blobs operation.

If a delete retention policy is enabled for the service, then this operation soft deletes the blobs or snapshots and retains the blobs or snapshots for specified number of days. After specified number of days, blobs' data is removed from the service during garbage collection. Soft deleted blobs or snapshots are accessible through list_blobs specifying include=["deleted"] Soft-deleted blobs or snapshots can be restored using <xref:azure.storage.blob.BlobClient.undelete>

The maximum number of blobs that can be deleted in a single request is 256.

delete_blobs(*blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

Name	Description
blobs Required	Union[str, Dict[str, Any], BlobProperties] The blobs to delete. This can be a single blob, or multiple values can be supplied, where each value is either the name of the blob (str) or BlobProperties. Note When the blob type is dict, here's a list of keys, value rules. blob name: key: 'name', value type: str snapshot you want to delete: key: 'snapshot', value type: str version id: key: 'version_id', value type: str whether to delete snapshots when deleting blob: key: 'delete_snapshots', value: 'include' or 'only' if the blob modified or not: key: 'if_modified_since', 'if_unmodified_since', value type: datetime etag: key: 'etag', value type: str match the etag or not: key: 'match_condition', value type: MatchConditions tags match condition: key: 'if_tags_match_condition', value type: str lease: key: 'lease_id', value type: Union[str, LeaseClient] timeout for subrequest: key: 'timeout', value type: int

Name

Description

blobs

Required

Union[str, Dict[str, Any], BlobProperties]

The blobs to delete. This can be a single blob, or multiple values can be supplied, where each value is either the name of the blob (str) or BlobProperties.

Note

When the blob type is dict, here's a list of keys, value rules.

blob name:

key: 'name', value type: str

snapshot you want to delete:

key: 'snapshot', value type: str

version id:

key: 'version_id', value type: str

whether to delete snapshots when deleting blob:

key: 'delete_snapshots', value: 'include' or 'only'

if the blob modified or not:

key: 'if_modified_since', 'if_unmodified_since', value type: datetime

etag:

key: 'etag', value type: str

match the etag or not:

key: 'match_condition', value type: MatchConditions

tags match condition:

key: 'if_tags_match_condition', value type: str

lease:

key: 'lease_id', value type: Union[str, LeaseClient]

timeout for subrequest:

key: 'timeout', value type: int

Keyword-Only Parameters

Name	Description
delete_snapshots	str Required if a blob has associated snapshots. Values include: "only": Deletes only the blobs snapshots. "include": Deletes the blob along with all snapshots.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
if_tags_match_condition	str Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. `"\"tagname\"='my tag'"` New in version 12.4.0.
raise_on_any_failure	bool This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
Iterator[HttpResponse]	An iterator of responses, one for each blob in order

delete_container

Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.

delete_container(**kwargs: Any) -> None

Keyword-Only Parameters

Name	Description
lease	BlobLeaseClient or str If specified, delete_container only succeeds if the container's lease is active and matches this ID. Required if the container has an active lease.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
None

download_blob

Downloads a blob to the StorageStreamDownloader. The readall() method must be used to read all the content or readinto() must be used to download the blob into a stream. Using chunks() returns an iterator which allows the user to iterate over the content in chunks.

download_blob(blob: str, offset: int | None = None, length: int | None = None, *, encoding: str, **kwargs: Any) -> StorageStreamDownloader[str]

Parameters

Name	Description
blob Required	str The blob with which to interact.
offset Required	int Start of byte range to use for downloading a section of the blob. Must be set if length is provided.
length Required	int Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance.

Keyword-Only Parameters

Name	Description
version_id	str The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to download. New in version 12.4.0. This keyword argument was introduced in API version '2019-12-12'.
validate_content	bool If true, calculates an MD5 hash for each chunk of the blob. The storage service checks the hash of the content that has arrived with the hash that was sent. This is primarily valuable for detecting bitflips on the wire if using http instead of https, as https (the default), will already validate. Note that this MD5 hash is not stored with the blob. Also note that if enabled, the memory-efficient upload algorithm will not be used because computing the MD5 hash requires buffering entire blocks, and doing so defeats the purpose of the memory-efficient algorithm.
lease	BlobLeaseClient or str Required if the blob has an active lease. If specified, download_blob only succeeds if the blob's lease is active and matches this ID. Value can be a BlobLeaseClient object or the lease ID as a string.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
if_tags_match_condition	str Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. `"\"tagname\"='my tag'"` New in version 12.4.0.
cpk	CustomerProvidedEncryptionKey Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. As the encryption key itself is provided in the request, a secure connection must be established to transfer the key.
max_concurrency	int The number of parallel connections with which to download.
encoding	str Encoding to decode the downloaded bytes. Default is None, i.e. no decoding.
progress_hook	Callable[[int, int], None] A callback to track the progress of a long running download. The signature is function(current: int, total: int) where current is the number of bytes transferred so far, and total is the total size of the download.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here. This method may make multiple calls to the service and the timeout will apply to each call individually. multiple calls to the Azure service and the timeout will apply to each call individually.

Returns

Type	Description
StorageStreamDownloader	A streaming object (StorageStreamDownloader)

exists

Returns True if a container exists and returns False otherwise.

exists(**kwargs: Any) -> bool

Keyword-Only Parameters

Name	Description
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
bool	boolean

find_blobs_by_tags

Returns a generator to list the blobs under the specified container whose tags match the given search expression. The generator will lazily follow the continuation tokens returned by the service.

find_blobs_by_tags(filter_expression: str, **kwargs: Any) -> ItemPaged[FilteredBlob]

Parameters

Name	Description
filter_expression Required	str The expression to find blobs whose tags matches the specified condition. eg. ""yourtagname"='firsttag' and "yourtagname2"='secondtag'"

Keyword-Only Parameters

Name	Description
results_per_page	int The max result per page when paginating.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
ItemPaged[BlobProperties]	An iterable (auto-paging) response of FilteredBlob.

from_connection_string

Create ContainerClient from a Connection String.

from_connection_string(conn_str: str, container_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameters

Name	Description
conn_str Required	str A connection string to an Azure Storage account.
container_name Required	str The container name for the blob.
credential	AzureNamedKeyCredential or AzureSasCredential or TokenCredential or str or dict[str, str] or None The credentials with which to authenticate. This is optional if the account URL already has a SAS token, or the connection string already has shared access key values. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. Credentials provided here will take precedence over those in the connection string. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. Default value: None

Keyword-Only Parameters

Name	Description
audience	str The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net.

Returns

Type	Description
ContainerClient	A container client.

from_container_url

Create ContainerClient from a container url.

from_container_url(container_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameters

Name	Description
container_url Required	str The full endpoint URL to the Container, including SAS token if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.
credential	AzureNamedKeyCredential or AzureSasCredential or TokenCredential or str or dict[str, str] or None The credentials with which to authenticate. This is optional if the account URL already has a SAS token, or the connection string already has shared access key values. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key. Default value: None

Name

Description

container_url

Required

str

The full endpoint URL to the Container, including SAS token if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

credential

AzureNamedKeyCredential or AzureSasCredential or TokenCredential or str or dict[str, str] or None

The credentials with which to authenticate. This is optional if the account URL already has a SAS token, or the connection string already has shared access key values. The value can be a SAS token string, an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials, an account shared access key, or an instance of a TokenCredentials class from azure.identity. If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential

except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError. If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key" should be the storage account key.

Default value: None

Keyword-Only Parameters

Name	Description
audience	str The audience to use when requesting tokens for Azure Active Directory authentication. Only has an effect when credential is of type TokenCredential. The value could be https://storage.azure.com/ (default) or https://.blob.core.windows.net.

Returns

Type	Description
ContainerClient	A container client.

get_account_information

Gets information related to the storage account.

The information can also be retrieved if the user has a SAS to a container or blob. The keys in the returned dictionary include 'sku_name' and 'account_kind'.

get_account_information(**kwargs: Any) -> Dict[str, str]

Keyword-Only Parameters

Name	Description
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
dict(str, str)	A dict of account information (SKU and account type).

get_blob_client

Get a client to interact with the specified blob.

The blob need not already exist.

get_blob_client(blob: str, snapshot: str | None = None, *, version_id: str | None = None) -> BlobClient

Parameters

Name	Description
blob Required	str The blob with which to interact.
snapshot	str The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from create_snapshot. Default value: None

Keyword-Only Parameters

Name	Description
version_id	str The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on.

Returns

Type	Description
BlobClient	A BlobClient.

get_container_access_policy

Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.

get_container_access_policy(**kwargs: Any) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
lease	BlobLeaseClient or str If specified, get_container_access_policy only succeeds if the container's lease is active and matches this ID.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
dict[str, Any]	Access policy information in a dict.

get_container_properties

Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.

get_container_properties(**kwargs: Any) -> ContainerProperties

Keyword-Only Parameters

Name	Description
lease	BlobLeaseClient or str If specified, get_container_properties only succeeds if the container's lease is active and matches this ID.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
ContainerProperties	Properties for the specified container within a container object.

list_blob_names

Returns a generator to list the names of blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service.

Note that no additional properties or metadata will be returned when using this API. Additionally, this API does not have an option to include additional blobs such as snapshots, versions, soft-deleted blobs, etc. To get any of this data, use list_blobs.

list_blob_names(**kwargs: Any) -> ItemPaged[str]

Keyword-Only Parameters

Name	Description
name_starts_with	str Filters the results to return only blobs whose names begin with the specified prefix.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
ItemPaged[str]	An iterable (auto-paging) response of blob names as strings.

list_blobs

Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service.

list_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, **kwargs: Any) -> ItemPaged[BlobProperties]

Parameters

Name	Description
name_starts_with Required	str Filters the results to return only blobs whose names begin with the specified prefix.
include Required	list[str] or str Specifies one or more additional datasets to include in the response. Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.

Keyword-Only Parameters

Name	Description
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
ItemPaged[BlobProperties]	An iterable (auto-paging) response of BlobProperties.

set_container_access_policy

Sets the permissions for the specified container or stored access policies that may be used with Shared Access Signatures. The permissions indicate whether blobs in a container may be accessed publicly.

set_container_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: PublicAccess | str | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parameters

Name	Description
signed_identifiers Required	dict[str, AccessPolicy] A dictionary of access policies to associate with the container. The dictionary may contain up to 5 elements. An empty dictionary will clear the access policies set on the service.
public_access Required	PublicAccess Possible values include: 'container', 'blob'.

Keyword-Only Parameters

Name	Description
lease	BlobLeaseClient or str Required if the container has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string.
if_modified_since	datetime A datetime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified date/time.
if_unmodified_since	datetime A datetime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
dict[str, str, datetime]	Container-updated property dict (Etag and last modified).

set_container_metadata

Sets one or more user-defined name-value pairs for the specified container. Each call to this operation replaces all existing metadata attached to the container. To remove all metadata from the container, call this operation with no metadata dict.

set_container_metadata(metadata: Dict[str, str] | None = None, **kwargs: Any) -> Dict[str, str | datetime]

Parameters

Name	Description
metadata Required	dict[str, str] A dict containing name-value pairs to associate with the container as metadata. Example: {'category':'test'}

Keyword-Only Parameters

Name	Description
lease	BlobLeaseClient or str If specified, set_container_metadata only succeeds if the container's lease is active and matches this ID.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
dict[str, str, datetime]	Container-updated property dict (Etag and last modified).

set_premium_page_blob_tier_blobs

Sets the page blob tiers on all blobs. This API is only supported for page blobs on premium accounts.

The maximum number of blobs that can be updated in a single request is 256.

set_premium_page_blob_tier_blobs(premium_page_blob_tier: str | PremiumPageBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

Name

Description

premium_page_blob_tier

Required

PremiumPageBlobTier

A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts.

Note

If you want to set different tier on different blobs please set this positional parameter to None.

Then the blob tier on every BlobProperties will be taken.

blobs

Required

str or dict(str, Any) or BlobProperties

The blobs with which to interact. This can be a single blob, or multiple values can be supplied, where each value is either the name of the blob (str) or BlobProperties.

Note

When the blob type is dict, here's a list of keys, value rules.

blob name:

key: 'name', value type: str

premium blob tier:

key: 'blob_tier', value type: PremiumPageBlobTier

lease:

key: 'lease_id', value type: Union[str, LeaseClient]

timeout for subrequest:

key: 'timeout', value type: int

Keyword-Only Parameters

Name	Description
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.
raise_on_any_failure	bool This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure.

Returns

Type	Description
Iterator[HttpResponse]	An iterator of responses, one for each blob in order

set_standard_blob_tier_blobs

This operation sets the tier on block blobs.

A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.

The maximum number of blobs that can be updated in a single request is 256.

set_standard_blob_tier_blobs(standard_blob_tier: str | StandardBlobTier | None, *blobs: str | Dict[str, Any] | BlobProperties, **kwargs: Any) -> Iterator[HttpResponse]

Parameters

Name

Description

standard_blob_tier

Required

str or StandardBlobTier

Indicates the tier to be set on all blobs. Options include 'Hot', 'Cool', 'Archive'. The hot tier is optimized for storing data that is accessed frequently. The cool storage tier is optimized for storing data that is infrequently accessed and stored for at least a month. The archive tier is optimized for storing data that is rarely accessed and stored for at least six months with flexible latency requirements.

Note

If you want to set different tier on different blobs please set this positional parameter to None.

Then the blob tier on every BlobProperties will be taken.

blobs

Required

str or dict(str, Any) or BlobProperties

The blobs with which to interact. This can be a single blob, or multiple values can be supplied, where each value is either the name of the blob (str) or BlobProperties.

Note

When the blob type is dict, here's a list of keys, value rules.

blob name:

key: 'name', value type: str

standard blob tier:

key: 'blob_tier', value type: StandardBlobTier

rehydrate priority:

key: 'rehydrate_priority', value type: RehydratePriority

lease:

key: 'lease_id', value type: Union[str, LeaseClient]

snapshot:

key: "snapshot", value type: str

version id:

key: "version_id", value type: str

tags match condition:

key: 'if_tags_match_condition', value type: str

timeout for subrequest:

key: 'timeout', value type: int

Keyword-Only Parameters

Name	Description
rehydrate_priority	RehydratePriority Indicates the priority with which to rehydrate an archived blob
if_tags_match_condition	str Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. `"\"tagname\"='my tag'"` New in version 12.4.0.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.
raise_on_any_failure	bool This is a boolean param which defaults to True. When this is set, an exception is raised even if there is a single operation failure.

Returns

Type	Description
Iterator[HttpResponse]	An iterator of responses, one for each blob in order

upload_blob

Creates a new blob from a data source with automatic chunking.

upload_blob(name: str, data: bytes | str | Iterable | IO, blob_type: str | BlobType = BlobType.BLOCKBLOB, length: int | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> BlobClient

Parameters

Name	Description
name Required	str The blob with which to interact.
data Required	Union[bytes, str, Iterable[AnyStr], IO[AnyStr]] The blob data to upload.
blob_type Required	BlobType The type of the blob. This can be either BlockBlob, PageBlob or AppendBlob. The default value is BlockBlob.
length Required	int Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance.
metadata Required	dict(str, str) Name-value pairs associated with the blob as metadata.

Keyword-Only Parameters

Name	Description
overwrite	bool Whether the blob to be uploaded should overwrite the current data. If True, upload_blob will overwrite the existing data. If set to False, the operation will fail with ResourceExistsError. The exception to the above is with Append blob types: if set to False and the data already exists, an error will not be raised and the data will be appended to the existing blob. If set overwrite=True, then the existing append blob will be deleted, and a new one created. Defaults to False.
content_settings	ContentSettings ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.
validate_content	bool If true, calculates an MD5 hash for each chunk of the blob. The storage service checks the hash of the content that has arrived with the hash that was sent. This is primarily valuable for detecting bitflips on the wire if using http instead of https, as https (the default), will already validate. Note that this MD5 hash is not stored with the blob. Also note that if enabled, the memory-efficient upload algorithm will not be used, because computing the MD5 hash requires buffering entire blocks, and doing so defeats the purpose of the memory-efficient algorithm.
lease	BlobLeaseClient or str Required if the container has an active lease. Value can be a BlobLeaseClient object or the lease ID as a string.
if_modified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified time.
if_unmodified_since	datetime A DateTime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has not been modified since the specified date/time.
etag	str An ETag value, or the wildcard character (). Used to check if the resource has changed, and act according to the condition specified by the match_condition* parameter.
match_condition	MatchConditions The match condition to use upon the etag.
if_tags_match_condition	str Specify a SQL where clause on blob tags to operate only on blob with a matching value. eg. `"\"tagname\"='my tag'"` New in version 12.4.0.
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here. This method may make multiple calls to the service and the timeout will apply to each call individually.
premium_page_blob_tier	PremiumPageBlobTier A page blob tier value to set the blob to. The tier correlates to the size of the blob and number of allowed IOPS. This is only applicable to page blobs on premium storage accounts.
standard_blob_tier	StandardBlobTier A standard blob tier value to set the blob to. For this version of the library, this is only applicable to block blobs on standard storage accounts.
maxsize_condition	int Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).
max_concurrency	int Maximum number of parallel connections to use when the blob size exceeds 64MB.
cpk	CustomerProvidedEncryptionKey Encrypts the data on the service-side with the given key. Use of customer-provided keys must be done over HTTPS. As the encryption key itself is provided in the request, a secure connection must be established to transfer the key.
encryption_scope	str A predefined encryption scope used to encrypt the data on the service. An encryption scope can be created using the Management API and referenced here by name. If a default encryption scope has been defined at the container, this value will override it if the container-level scope is configured to allow overrides. Otherwise an error will be raised. New in version 12.2.0.
encoding	str Defaults to UTF-8.
progress_hook	Callable[[int, Optional[int]], None] A callback to track the progress of a long running upload. The signature is function(current: int, total: Optional[int]) where current is the number of bytes transferred so far, and total is the size of the blob or None if the size is unknown.

Returns

Type	Description
BlobClient	A BlobClient to interact with the newly uploaded blob.

walk_blobs

Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service. This operation will list blobs in accordance with a hierarchy, as delimited by the specified delimiter character.

walk_blobs(name_starts_with: str | None = None, include: str | List[str] | None = None, delimiter: str = '/', **kwargs: Any) -> ItemPaged[BlobProperties]

Parameters

Name	Description
name_starts_with Required	str Filters the results to return only blobs whose names begin with the specified prefix.
include Required	list[str] or str Specifies one or more additional datasets to include in the response. Options include: 'snapshots', 'metadata', 'uncommittedblobs', 'copy', 'deleted', 'deletedwithversions', 'tags', 'versions', 'immutabilitypolicy', 'legalhold'.
delimiter Required	str When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

Keyword-Only Parameters

Name	Description
timeout	int Sets the server-side timeout for the operation in seconds. For more details see https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. This value is not tracked or validated on the client. To configure client-side network timesouts see here.

Returns

Type	Description
ItemPaged[BlobProperties]	An iterable (auto-paging) response of BlobProperties.

Attributes

api_version

The version of the Storage API used for requests.

Returns

Type	Description
str

location_mode

The location mode that the client is currently using.

By default this will be "primary". Options include "primary" and "secondary".

Returns

Type	Description
str

primary_endpoint

The full primary endpoint URL.

Returns

Type	Description
str

primary_hostname

The hostname of the primary endpoint.

Returns

Type	Description
str

secondary_endpoint

The full secondary endpoint URL if configured.

If not available a ValueError will be raised. To explicitly specify a secondary hostname, use the optional secondary_hostname keyword argument on instantiation.

Returns

Type	Description
str

Exceptions

Type	Description
ValueError

secondary_hostname

The hostname of the secondary endpoint.

If not available this will be None. To explicitly specify a secondary hostname, use the optional secondary_hostname keyword argument on instantiation.

Returns

Type	Description
Optional[str]

url

The full endpoint URL to this entity, including SAS token if used.

This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode. :returns: The full endpoint URL to this entity, including SAS token if used. :rtype: str

Share via

ContainerClient Class

Constructor

Parameters

Keyword-Only Parameters

Methods

acquire_lease

Parameters

Keyword-Only Parameters

Returns

close

Keyword-Only Parameters

create_container

Parameters

Keyword-Only Parameters

Returns

delete_blob

Parameters

Keyword-Only Parameters

Returns

delete_blobs

Parameters

Keyword-Only Parameters

Returns

delete_container

Keyword-Only Parameters

Returns

download_blob

Parameters

Keyword-Only Parameters

Returns

exists

Keyword-Only Parameters

Returns

find_blobs_by_tags

Parameters

Keyword-Only Parameters

Returns

from_connection_string

Parameters

Keyword-Only Parameters

Returns

from_container_url

Parameters

Keyword-Only Parameters

Returns

get_account_information

Keyword-Only Parameters

Returns

get_blob_client

Parameters

Keyword-Only Parameters

Returns

get_container_access_policy

Keyword-Only Parameters

Returns

get_container_properties

Keyword-Only Parameters

Returns

list_blob_names

Keyword-Only Parameters

Returns

list_blobs

Parameters

Keyword-Only Parameters

Returns

set_container_access_policy

Parameters

Keyword-Only Parameters

Returns

set_container_metadata

Parameters

Keyword-Only Parameters

Returns

set_premium_page_blob_tier_blobs

Parameters

Keyword-Only Parameters

Returns

set_standard_blob_tier_blobs

Parameters