aio package

Modules

blob_client_async
blob_service_client_async
container_client_async
lease_async
models

Classes

BlobServiceClient

A client to interact with the Blob Service at the account level.

This client provides operations to retrieve and configure the account properties as well as list, create and delete containers within the account. For operations relating to a specific container or blob, clients for those entities can also be retrieved using the get_client functions.

ContainerClient

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(blob, snapshot=None) function.

BlobClient

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

BlobType

An enumeration.

LeaseClient

Creates a new LeaseClient.

This client provides lease operations on a BlobClient or ContainerClient.

StorageErrorCode

An enumeration.

ExponentialRetry

Exponential retry.

LinearRetry

Linear retry.

NoRetry
LocationMode

Specifies the location the request should be sent to. This mode only applies for RA-GRS accounts which allow secondary read access. All other account types must use PRIMARY.

BlockState

Block blob block types.

StandardBlobTier

Specifies the blob tier to set the blob to. This is only applicable for block blobs on standard storage accounts.

PremiumPageBlobTier

Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts. Please take a look at: https://docs.microsoft.com/en-us/azure/storage/storage-premium-storage#scalability-and-performance-targets for detailed information on the corresponding IOPS and throughtput per PageBlobTier.

SequenceNumberAction

Sequence number actions.

PublicAccess

Specifies whether data in the container may be accessed publicly and the level of access.

Logging

Azure Analytics Logging settings.

Metrics

A summary of request statistics grouped by API in hour or minute aggregates for blobs.

RetentionPolicy

The retention policy which determines how long the associated data should persist.

StaticWebsite

The properties that enable an account to host a static website.

CorsRule

CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.

ContainerProperties

Blob container's properties class.

ContainerPropertiesPaged

An Iterable of Container properties.

BlobProperties

Blob Properties.

BlobPropertiesPaged

An Iterable of Blob properties.

BlobPrefix

An Iterable of Blob properties.

Returned from walk_blobs when a delimiter is used. Can be thought of as a virtual blob directory.

LeaseProperties

Blob Lease Properties.

ContentSettings

The content settings of a blob.

CopyProperties

Blob Copy Properties.

These properties will be None if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation, for example, using Set Blob Properties, Upload Blob, or Commit Block List.

BlobBlock

BlockBlob Block class.

PageRange

Page Range for page blob.

AccessPolicy

Access Policy class used by the set and get acl methods in each service.

A stored access policy can specify the start time, expiry time, and permissions for the Shared Access Signatures with which it's associated. Depending on how you want to control access to your resource, you can specify all of these parameters within the stored access policy, and omit them from the URL for the Shared Access Signature. Doing so permits you to modify the associated signature's behavior at any time, as well as to revoke it. Or you can specify one or more of the access policy parameters within the stored access policy, and the others on the URL. Finally, you can specify all of the parameters on the URL. In this case, you can use the stored access policy to revoke the signature, but not to modify its behavior.

Together the Shared Access Signature and the stored access policy must include all fields required to authenticate the signature. If any required fields are missing, the request will fail. Likewise, if a field is specified both in the Shared Access Signature URL and in the stored access policy, the request will fail with status code 400 (Bad Request).

ContainerPermissions

ContainerPermissions class to be used with generate_shared_access_signature(permission=None, expiry=None, start=None, policy_id=None, ip=None, protocol=None, account_name=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None) API and for the AccessPolicies used with set_container_access_policy(signed_identifiers=None, public_access=None, lease=None, timeout=None, **kwargs).

BlobPermissions

BlobPermissions class to be used with generate_shared_access_signature(permission=None, expiry=None, start=None, policy_id=None, ip=None, protocol=None, account_name=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None) API.

ResourceTypes

Specifies the resource types that are accessible with the account SAS.

AccountPermissions

ResourceTypes class to be used with generate_shared_access_signature method and for the AccessPolicies used with set_*_acl. There are two types of SAS which may be used to grant resource access. One is to grant access to a specific resource (resource-specific). Another is to grant access to the entire service for a specific account and allow certain operations based on perms found here.

StorageStreamDownloader

A streaming object to download from Azure Storage.

The stream downloader can iterated, or download to open file or stream over multiple threads.