models module

Classes

AccountInformation

Holds information related to the storage account.

AppendBlockProperties

Response for an append block request.

BatchDeleteSubRequest

Represents one request in batch of multiple blob delete requests

Organizes HttpRequest objects together for batch REST operations to a single host endpoint.

BatchSetBlobTierSubRequest

Represents one request in batch of multiple set block blob tier requests

Organizes HttpRequest objects together for batch REST operations to a single host endpoint.

BatchSubResponse

Sub-response parsed from batch http sub-response

Organizes batch sub-response info and batch sub-request together for easier processing

:ivar HTTPResponse http_response: Parsed batch sub-response, in HTTPResponse format

Blob

Blob class.

BlobBlock

BlockBlob Block class.

BlobBlockList

Blob Block List class.

BlobBlockState

Block blob block types.

BlobPermissions

BlobPermissions class to be used with generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None) API.

BlobPrefix

BlobPrefix objects may potentially returned in the blob list when list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None) is used with a delimiter. Prefixes can be thought of as virtual blob directories.

BlobProperties

Blob Properties

BlockListType

Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together.

Container

Blob container class.

ContainerPermissions

ContainerPermissions class to be used with generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=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_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None).

ContainerProperties

Blob container's properties class.

ContentSettings

Used to store the content settings of a blob.

CopyProperties

Blob Copy Properties.

CustomerProvidedEncryptionKey

All data in Azure Storage is encrypted at-rest using an account-level encryption key. In versions 2018-06-17 and newer, you can manage the key used to encrypt blob contents and application metadata per-blob by providing an AES-256 encryption key in requests to the storage service.

When you use a customer-provided key, Azure Storage does not manage or persist your key. When writing data to a blob, the provided key is used to encrypt your data before writing it to disk. A SHA-256 hash of the encryption key is written alongside the blob contents, and is used to verify that all subsequent operations against the blob use the same encryption key. This hash cannot be used to retrieve the encryption key or decrypt the contents of the blob. When reading a blob, the provided key is used to decrypt your data after reading it from disk. In both cases, the provided encryption key is securely discarded as soon as the encryption or decryption process completes.

DeleteSnapshot

Required if the blob has associated snapshots. Specifies how to handle the snapshots.

Include

Specifies the datasets to include in the blob list response.

LeaseProperties

Blob Lease Properties.

PageBlobProperties

Response for a page request.

PageRange

Page Range for page blob.

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.

PublicAccess

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

RehydratePriority

Indicates the priority with which to rehydrate an archived blob

ResourceProperties

Base response for a resource request.

SequenceNumberAction

Sequence number actions.

StandardBlobTier

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

UserDelegationKey

Represents a user delegation key, provided to the user by Azure Storage based on their Azure Active Directory access token.

The fields are saved as simple strings since the user does not have to interact with this object; to generate an identify SAS, the user can simply pass it to the right API.