azure.storage.blob package Azure SDK for Python 2.0.0 documentation

There is a partial failure in batch operations.

• message (str) – The message of the exception.

• response – Server response to be deserialized.

• parts (list) – A list of the parts in multipart response.

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Access Policy class used by the set and get access policy 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).

• permission (str or ContainerSasPermissions) – The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy.

• expiry (datetime or str) – The time at which the shared access signature becomes invalid. Required unless an id is given referencing a stored access policy which contains this field. This field must be omitted if it has been specified in an associated stored access policy. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

• start (datetime or str) – The time at which the shared access signature becomes valid. If omitted, start time for this call is assumed to be the time when the storage service receives the request. Azure will always convert values to UTC. If a date is passed in without timezone info, it is assumed to be UTC.

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

key_transformer (function) – A key transformer function.

A dict JSON compatible object

dict

Parse a str using the RestAPI syntax and return a model.

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

keep_readonly (bool) – If you want to serialize the readonly attributes

A dict JSON compatible object

dict

Validate this model recursively and return a list of ValidationError.

A list of validation error

list

ResourceTypes class to be used with generate_account_sas function 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.

• read (bool) – Valid for all signed resources types (Service, Container, and Object). Permits read permissions to the specified resource type.

• write (bool) – Valid for all signed resources types (Service, Container, and Object). Permits write permissions to the specified resource type.

• delete (bool) – Valid for Container and Object resource types, except for queue messages.

• delete_previous_version (bool) – Delete the previous blob version for the versioning enabled storage account.

• list (bool) – Valid for Service and Container resource types only.

• add (bool) – Valid for the following Object resource types only: queue messages, and append blobs.

• create (bool) – Valid for the following Object resource types only: blobs and files. Users can create new blobs or files, but may not overwrite existing blobs or files.

• update (bool) – Valid for the following Object resource types only: queue messages.

• process (bool) – Valid for the following Object resource type only: queue messages.

• tag (bool) – To enable set or get tags on the blobs in the container.

• filter_by_tags (bool) – To enable get blobs by tags, this should be used together with list permission.

• set_immutability_policy (bool) – To enable operations related to set/delete immutability policy. To get immutability policy, you just need read permission.

Create AccountSasPermissions from a string.

To specify read, write, delete, etc. permissions you need only to include the first letter of the word in the string. E.g. for read and write permissions you would provide a string “rw”.

permission (str) – Specify permissions in the string with the first letter of the word.

An AccountSasPermissions object

AccountSasPermissions

field of an arrow schema.

All required parameters must be populated in order to send to Azure.

type (ArrowType) – Arrow field type.

• name (str) – The name of the field.

• precision (int) – The precision of the field.

• scale (int) – The scale of the field.

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

key_transformer (function) – A key transformer function.

A dict JSON compatible object

dict

Parse a str using the RestAPI syntax and return a model.

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

keep_readonly (bool) – If you want to serialize the readonly attributes

A dict JSON compatible object

dict

Validate this model recursively and return a list of ValidationError.

A list of validation error

list

An enumeration.

Azure Analytics Logging settings.

• version (str) – The version of Storage Analytics to configure. The default value is 1.0.

• delete (bool) – Indicates whether all delete requests should be logged. The default value is False.

• read (bool) – Indicates whether all read requests should be logged. The default value is False.

• write (bool) – Indicates whether all write requests should be logged. The default value is False.

• retention_policy (RetentionPolicy) – Determines how long the associated data should persist. If not specified the retention policy will be disabled by default.

Return a dict that can be JSONify using json.dump.

Advanced usage might optionaly use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains ‘type’ with the msrest type and ‘key’ with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

key_transformer (function) – A key transformer function.

A dict JSON compatible object

dict

Parse a str using the RestAPI syntax and return a model.

• data (str) – A str using RestAPI structure. JSON by default.

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

• data (dict) – A dict using RestAPI structure

• content_type (str) – JSON by default, set application/xml if XML.

An instance of this model

DeserializationError if something went wrong

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

keep_readonly (bool) – If you want to serialize the readonly attributes

A dict JSON compatible object

dict

Validate this model recursively and return a list of ValidationError.

A list of validation error

list

BlockBlob Block class.

• block_id (str) – Block id.

• state (str) – Block state. Possible values: committed|uncommitted

size (int) – Block size in bytes.

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

For more optional configuration, please click here.

• account_url (str) – The URI to the storage account. In order to create a client given the full URI to the blob, use the from_blob_url() classmethod.

• container_name (str) – The container name for the blob.

• blob_name (str) – The name of the blob with which to interact. If specified, this value will override a blob value specified in the blob URL.

• snapshot (str) – The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from create_snapshot().

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

• api_version (str) –

  The Storage API version to use for requests. Default value is ‘2019-07-07’. 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 4*1024*1024, 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 64*1024*1024, 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 4*1024*1024+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 4*1024*1024, 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 32*1024*1024, or 32MB.

• max_chunk_get_size (int) – The maximum chunk size used for downloading a blob. Defaults to 4*1024*1024, or 4MB.

Example:

from azure.storage.blob import BlobClient blob_client = BlobClient.from_blob_url(blob_url="https://account.blob.core.windows.net/container/blob-name") 

from azure.storage.blob import BlobClient sas_url = "https://account.blob.core.windows.net/container/blob-name?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D" blob_client = BlobClient.from_blob_url(sas_url) 

Abort an ongoing copy operation.

This will leave a destination blob with zero length and full metadata. This will raise an error if the copy operation has already ended.

copy_id (str or BlobProperties) – The copy operation to abort. This can be either an ID string, or an instance of BlobProperties.

None

Example:

# Passing in copy id to abort copy operation copied_blob.abort_copy(copy_id) # check copy status props = copied_blob.get_blob_properties() print(props.copy.status) 

Requests a new lease.

If the blob does not have an active lease, the Blob Service creates a lease on the blob and returns a new lease.

• lease_duration (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 (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.

• 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) – The timeout parameter is expressed in seconds.

A BlobLeaseClient object.

BlobLeaseClient

Example:

# Acquire a lease on the blob lease = blob_client.acquire_lease() # Delete blob by passing in the lease blob_client.delete_blob(lease=lease) 

Commits a new block of data to the end of the existing append blob.

• data (bytes or str or Iterable) – Content of the block. This can be bytes, text, an iterable or a file-like object.

• length (int) – Size of the block in bytes.

• validate_content (bool) – If true, calculates an MD5 hash of the block content. 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.

• 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).

• appendpos_condition (int) – Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).

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

• encoding (str) – Defaults to UTF-8.

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag, last modified, append offset, committed block count).

dict(str, Any)

Creates a new block to be committed as part of a blob, where the contents are read from a source url.

• copy_source_url (str) – The URL of the source data. It can point to any Azure Blob or File, that is either public or has a shared access signature attached.

• source_offset (int) – This indicates the start of the range of bytes (inclusive) that has to be taken from the copy source.

• source_length (int) – This indicates the end of the range of bytes that has to be taken from the copy source.

• source_content_md5 (bytearray) – If given, the service will calculate the MD5 hash of the block content and compare against this value.

• 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).

• appendpos_condition (int) – Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).

• 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) – The destination 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 destination 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.

• source_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 source resource has been modified since the specified time.

• source_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 source resource has not been modified since the specified date/time.

• source_etag (str) – The source 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.

• source_match_condition (MatchConditions) – The source match condition to use upon the etag.

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

• timeout (int) – The timeout parameter is expressed in seconds.

• source_authorization (str) – Authenticate as a service principal using a client secret to access a source blob. Ensure “bearer ” is the prefix of the source_authorization string.

Clears a range of pages.

• offset (int) – Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• length (int) – Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• 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_sequence_number_lte (int) – If the blob’s sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_lt (int) – If the blob’s sequence number is less than the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_eq (int) – If the blob’s sequence number is equal to the specified value, the request proceeds; otherwise it fails.

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict(str, Any)

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

The Commit Block List operation writes a blob by specifying the list of block IDs that make up the blob.

• block_list (list) – List of Blockblobs.

• content_settings (ContentSettings) – ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.

• metadata (dict[str, str]) – Name-value pairs associated with the blob as metadata.

• tags (dict(str, str)) –

  Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

  New in version 12.4.0.

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

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• legal_hold (bool) –

  Specified if a legal hold should be set on the blob.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• validate_content (bool) – If true, calculates an MD5 hash of the page content. 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.

• 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 destination blob with a matching value.

  New in version 12.4.0.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict(str, Any)

Creates a new Append Blob.

• content_settings (ContentSettings) – ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.

• metadata (dict(str, str)) – Name-value pairs associated with the blob as metadata.

• tags (dict(str, str)) –

  Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

  New in version 12.4.0.

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

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• legal_hold (bool) –

  Specified if a legal hold should be set on the blob.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict[str, Any]

Creates a new Page Blob of the specified size.

• size (int) – This specifies the maximum size for the page blob, up to 1 TB. The page blob size must be aligned to a 512-byte boundary.

• content_settings (ContentSettings) – ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.

• metadata (dict(str, str)) – Name-value pairs associated with the blob as metadata.

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

• tags (dict(str, str)) –

  Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

  New in version 12.4.0.

• sequence_number (int) – Only for Page blobs. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1.The default value is 0.

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

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• legal_hold (bool) –

  Specified if a legal hold should be set on the blob.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict[str, Any]

Creates a snapshot of the blob.

A snapshot is a read-only version of a blob that’s taken at a point in time. It can be read, copied, or deleted, but not modified. Snapshots provide a way to back up a blob as it appears at a moment in time.

A snapshot of a blob has the same name as the base blob from which the snapshot is taken, with a DateTime value appended to indicate the time at which the snapshot was taken.

metadata (dict(str, str)) – Name-value pairs associated with the blob as metadata.

• 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 destination blob with a matching value.

  New in version 12.4.0.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Snapshot ID, Etag, and last modified).

dict[str, Any]

Example:

# Create a read-only snapshot of the blob at this point in time snapshot_blob = blob_client.create_snapshot() # Get the snapshot ID print(snapshot_blob.get('snapshot')) 

Marks the specified blob 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 and retains the blob for a specified number of days. After the specified number of days, the blob’s data is removed from the service during garbage collection. Soft deleted blob is accessible through list_blobs() specifying include=[‘deleted’] option. Soft-deleted blob can be restored using undelete() operation.

delete_snapshots (str) –

• ”only”: Deletes only the blobs snapshots.

• ”include”: Deletes the blob along with all snapshots.

• 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. If specified, delete_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.

• timeout (int) – The timeout parameter is expressed in seconds.

None

Example:

blob_client.delete_blob() 

The Delete Immutability Policy operation deletes the immutability policy on the blob.

New in version 12.10.0: This operation was introduced in API version ‘2020-10-02’.

timeout (int) – The timeout parameter is expressed in seconds.

Key value pairs of blob tags.

Dict[str, str]

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.

• offset (int) – Start of byte range to use for downloading a section of the blob. Must be set if length is provided.

• length (int) – Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance.

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

• timeout (int) – The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually.

A streaming object (StorageStreamDownloader)

StorageStreamDownloader

Example:

with open(DEST_FILE, "wb") as my_blob: download_stream = blob_client.download_blob() my_blob.write(download_stream.readall()) 

Returns True if a blob exists with the defined parameters, and returns False otherwise.

• version_id (str) – The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to check if it exists.

• timeout (int) – The timeout parameter is expressed in seconds.

boolean

Create BlobClient from a blob url. This doesn’t support customized blob url with ‘/’ in blob name.

• blob_url (str) – The full endpoint URL to the Blob, including SAS token and snapshot if used. This could be either the primary endpoint, or the secondary endpoint depending on the current location_mode.

• credential – 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 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.

• snapshot (str) – The optional blob snapshot on which to operate. This can be the snapshot ID string or the response returned from create_snapshot(). If specified, this will override the snapshot in the url.

A Blob client.

BlobClient

Create BlobClient from a Connection String.

• conn_str (str) – A connection string to an Azure Storage account.

• container_name (str) – The container name for the blob.

• blob_name (str) – The name of 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().

• credential – 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 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.

A Blob client.

BlobClient

Example:

from azure.storage.blob import BlobClient blob_client = BlobClient.from_connection_string( self.connection_string, container_name="mycontainer", blob_name="blobname.txt") 

Gets information related to the storage account in which the blob resides.

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

A dict of account information (SKU and account type).

dict(str, str)

Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.

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

• version_id (str) –

  The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to get properties.

  New in version 12.4.0.

  This keyword argument was introduced in API version ‘2019-12-12’.

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

• timeout (int) – The timeout parameter is expressed in seconds.

BlobProperties

BlobProperties

Example:

properties = blob_client.get_blob_properties() 

The Get Tags operation enables users to get tags on a blob or specific blob version, or snapshot.

New in version 12.4.0: This operation was introduced in API version ‘2019-12-12’.

• version_id (str) – The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to add tags to.

• if_tags_match_condition (str) – Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. eg. "\"tagname\"='my tag'"

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

• timeout (int) – The timeout parameter is expressed in seconds.

Key value pairs of blob tags.

Dict[str, str]

The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block blob.

block_list_type (str) – Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. Possible values include: ‘committed’, ‘uncommitted’, ‘all’

• 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_tags_match_condition (str) –

  Specify a SQL where clause on blob tags to operate only on destination blob with a matching value.

  New in version 12.4.0.

• timeout (int) – The timeout parameter is expressed in seconds.

A tuple of two lists - committed and uncommitted blocks

tuple(list(BlobBlock), list(BlobBlock))

Returns the list of valid page ranges for a managed disk or snapshot.

Note

This operation is only available for managed disk accounts.

New in version 12.2.0: This operation was introduced in API version ‘2019-07-07’.

• previous_snapshot_url – Specifies the URL of a previous snapshot of the managed disk. The response will only contain pages that were changed between the target blob and its previous snapshot.

• offset (int) – Start of byte range to use for getting valid page ranges. If no length is given, all bytes after the offset will be searched. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• length (int) – Number of bytes to use for getting valid page ranges. If length is given, offset must be provided. This range will return valid page ranges from the offset start up to the specified length. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

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

• timeout (int) – The timeout parameter is expressed in seconds.

A tuple of two lists of page ranges as dictionaries with ‘start’ and ‘end’ keys. The first element are filled page ranges, the 2nd element is cleared page ranges.

tuple(list(dict(str, str), list(dict(str, str))

Returns the list of valid page ranges for a Page Blob or snapshot of a page blob.

• offset (int) – Start of byte range to use for getting valid page ranges. If no length is given, all bytes after the offset will be searched. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• length (int) – Number of bytes to use for getting valid page ranges. If length is given, offset must be provided. This range will return valid page ranges from the offset start up to the specified length. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• previous_snapshot_diff (str) – The snapshot diff parameter that contains an opaque DateTime value that specifies a previous blob snapshot to be compared against a more recent snapshot or the current blob.

• 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) – The timeout parameter is expressed in seconds.

A tuple of two lists of page ranges as dictionaries with ‘start’ and ‘end’ keys. The first element are filled page ranges, the 2nd element is cleared page ranges.

tuple(list(dict(str, str), list(dict(str, str))

Enables users to select/project on blob/or blob snapshot data by providing simple query expressions. This operations returns a BlobQueryReader, users need to use readall() or readinto() to get query data.

query_expression (str) – Required. a query statement.

• on_error (Callable[BlobQueryError]) – A function to be called on any processing errors returned by the service.

• blob_format (DelimitedTextDialect or DelimitedJsonDialect or QuickQueryDialect or str) – Optional. Defines the serialization of the data currently stored in the blob. The default is to treat the blob data as CSV data formatted in the default dialect. This can be overridden with a custom DelimitedTextDialect, or DelimitedJsonDialect or “ParquetDialect” (passed as a string or enum). These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string

• output_format (DelimitedTextDialect or DelimitedJsonDialect or list[ArrowDialect] or QuickQueryDialect or str) – Optional. Defines the output serialization for the data stream. By default the data will be returned as it is represented in the blob (Parquet formats default to DelimitedTextDialect). By providing an output format, the blob data will be reformatted according to that profile. This value can be a DelimitedTextDialect or a DelimitedJsonDialect or ArrowDialect. These dialects can be passed through their respective classes, the QuickQueryDialect enum or as a string

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

A streaming object (BlobQueryReader)

BlobQueryReader

Example:

errors = [] def on_error(error): errors.append(error) # upload the csv file blob_client = blob_service_client.get_blob_client(container_name, "csvfile") with open("./sample-blobs/quick_query.csv", "rb") as stream: blob_client.upload_blob(stream, overwrite=True) # select the second column of the csv file query_expression = "SELECT _2 from BlobStorage" input_format = DelimitedTextDialect(delimiter=',', quotechar='"', lineterminator='\n', escapechar="", has_header=False) output_format = DelimitedJsonDialect(delimiter='\n') reader = blob_client.query_blob(query_expression, on_error=on_error, blob_format=input_format, output_format=output_format) content = reader.readall() 

Resizes a page blob to the specified size.

If the specified value is less than the current size of the blob, then all pages above the specified value are cleared.

size (int) – Size used to resize blob. Maximum size for a page blob is up to 1 TB. The page blob size must be aligned to a 512-byte boundary.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict(str, Any)

The Seal operation seals the Append Blob to make it read-only.

New in version 12.4.0.

• appendpos_condition (int) – Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag, last modified, append offset, committed block count).

dict(str, Any)

Sets user-defined metadata for the blob as one or more name-value pairs.

metadata (dict(str, str)) – Dict containing name and value pairs. Each call to this operation replaces all existing metadata attached to the blob. To remove all metadata from the blob, call this operation with no metadata headers.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified)

Each call to this operation replaces all existing tags attached to the blob. To remove all tags from the blob, call this operation with no tags set.

New in version 12.4.0: This operation was introduced in API version ‘2019-12-12’.

tags (dict(str, str)) – Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

• version_id (str) – The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to add tags to.

• validate_content (bool) – If true, calculates an MD5 hash of the tags content. 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.

• if_tags_match_condition (str) – Specify a SQL where clause on blob tags to operate only on destination blob with a matching value. eg. "\"tagname\"='my tag'"

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified)

Dict[str, Any]

Sets system properties on the blob.

If one property is set for the content_settings, all properties will be overridden.

content_settings (ContentSettings) – ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.

• 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) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified)

Dict[str, Any]

The Set Immutability Policy operation sets the immutability policy on the blob.

New in version 12.10.0: This operation was introduced in API version ‘2020-10-02’.

immutability_policy (ImmutabilityPolicy) –

Specifies the immutability policy of a blob, blob snapshot or blob version.

New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

timeout (int) – The timeout parameter is expressed in seconds.

Key value pairs of blob tags.

Dict[str, str]

The Set Legal Hold operation sets a legal hold on the blob.

New in version 12.10.0: This operation was introduced in API version ‘2020-10-02’.

legal_hold (bool) – Specified if a legal hold should be set on the blob.

timeout (int) – The timeout parameter is expressed in seconds.

Key value pairs of blob tags.

Dict[str, Union[str, datetime, bool]]

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

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.

• 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) – The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually.

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

None

Sets the blob sequence number.

• sequence_number_action (str) – This property indicates how the service should modify the blob’s sequence number. See SequenceNumberAction for more information.

• sequence_number (str) – This property sets the blob’s sequence number. The sequence number is a user-controlled property that you can use to track requests and manage concurrency issues.

• 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) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict(str, Any)

This operation sets the tier on a block blob.

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

standard_blob_tier (str or StandardBlobTier) – Indicates the tier to be set on the blob. 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.

• rehydrate_priority (RehydratePriority) – Indicates the priority with which to rehydrate an archived blob

• 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’.

• 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) – The timeout parameter is expressed in seconds.

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

None

Creates a new block to be committed as part of a blob.

• block_id (str) – A string value that identifies the block. The string should be less than or equal to 64 bytes in size. For a given blob, the block_id must be the same size for each block.

• data – The blob data.

• length (int) – Size of the block.

• 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. Value can be a BlobLeaseClient object or the lease ID as a string.

• encoding (str) – Defaults to UTF-8.

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob property dict.

dict[str, Any]

Creates a new block to be committed as part of a blob where the contents are read from a URL.

• block_id (str) – A string value that identifies the block. The string should be less than or equal to 64 bytes in size. For a given blob, the block_id must be the same size for each block.

• source_url (str) – The URL.

• source_offset (int) – Start of byte range to use for the block. Must be set if source length is provided.

• source_length (int) – The size of the block in bytes.

• source_content_md5 (bytearray) – Specify the md5 calculated for the range of bytes that must be read from the copy source.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

• source_authorization (str) – Authenticate as a service principal using a client secret to access a source blob. Ensure “bearer ” is the prefix of the source_authorization string.

Blob property dict.

dict[str, Any]

Copies a blob asynchronously.

This operation returns a copy operation object that can be used to wait on the completion of the operation, as well as check status or abort the copy operation. The Blob service copies blobs on a best-effort basis.

The source blob for a copy operation may be a block blob, an append blob, or a page blob. If the destination blob already exists, it must be of the same blob type as the source blob. Any existing destination blob will be overwritten. The destination blob cannot be modified while a copy operation is in progress.

When copying from a page blob, the Blob service creates a destination page blob of the source blob’s length, initially containing all zeroes. Then the source page ranges are enumerated, and non-empty ranges are copied.

For a block blob or an append blob, the Blob service creates a committed blob of zero length before returning from this operation. When copying from a block blob, all committed blocks and their block IDs are copied. Uncommitted blocks are not copied. At the end of the copy operation, the destination blob will have the same committed block count as the source.

When copying from an append blob, all committed blocks are copied. At the end of the copy operation, the destination blob will have the same committed block count as the source.

For all blob types, you can call status() on the returned polling object to check the status of the copy operation, or wait() to block until the operation is complete. The final blob will be committed when the copy completes.

• source_url (str) –

  A URL of up to 2 KB in length that specifies a file or blob. The value should be URL-encoded as it would appear in a request URI. If the source is in another account, the source must either be public or must be authenticated via a shared access signature. If the source is public, no authentication is required. Examples: https://myaccount.blob.core.windows.net/mycontainer/myblob

  https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>

  https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

• metadata (dict(str, str)) – Name-value pairs associated with the blob as metadata. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file.

• incremental_copy (bool) – Copies the snapshot of the source page blob to a destination page blob. The snapshot is copied such that only the differential changes between the previously copied snapshot are transferred to the destination. The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual. Defaults to False.

• tags (dict(str, str)) –

  Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

  New in version 12.4.0.

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• legal_hold (bool) –

  Specified if a legal hold should be set on the blob.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• source_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 conditional header to copy the blob only if the source blob has been modified since the specified date/time.

• source_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 conditional header to copy the blob only if the source blob has not been modified since the specified date/time.

• source_etag (str) – The source 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.

• source_match_condition (MatchConditions) – The source match condition to use upon the etag.

• 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 conditional header to copy the blob only if the destination blob has been modified since the specified date/time. If the destination blob has not been modified, the Blob service returns status code 412 (Precondition Failed).

• 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 conditional header to copy the blob only if the destination blob has not been modified since the specified date/time. If the destination blob has been modified, the Blob service returns status code 412 (Precondition Failed).

• etag (str) – The destination 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 destination match condition to use upon the etag.

• destination_lease (BlobLeaseClient or str) – The lease ID specified for this header must match the lease ID of the destination blob. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed).

• source_lease (BlobLeaseClient or str) – Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob.

• timeout (int) – The timeout parameter is expressed in seconds.

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

• rehydrate_priority (RehydratePriority) – Indicates the priority with which to rehydrate an archived blob

• seal_destination_blob (bool) –

  Seal the destination append blob. This operation is only for append blob.

  New in version 12.4.0.

• requires_sync (bool) – Enforces that the service will not return a response until the copy is complete.

• source_authorization (str) – Authenticate as a service principal using a client secret to access a source blob. Ensure “bearer ” is the prefix of the source_authorization string. This option is only available when incremental_copy is set to False and requires_sync is set to True.

A dictionary of copy properties (etag, last_modified, copy_id, copy_status).

dict[str, Union[str, datetime]]

Example:

# Get the blob client with the source blob source_blob = "https://www.gutenberg.org/files/59466/59466-0.txt" copied_blob = blob_service_client.get_blob_client("copyblobcontainer", '59466-0.txt') # start copy and check copy status copy = copied_blob.start_copy_from_url(source_blob) props = copied_blob.get_blob_properties() print(props.copy.status) 

Restores soft-deleted blobs or snapshots.

Operation will only be successful if used within the specified number of days set in the delete retention policy.

timeout (int) – The timeout parameter is expressed in seconds.

None

Example:

# Undelete the blob before the retention policy expires blob_client.undelete_blob() 

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

• data – The blob data to upload.

• blob_type (BlobType) – The type of the blob. This can be either BlockBlob, PageBlob or AppendBlob. The default value is BlockBlob.

• length (int) – Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance.

• metadata (dict(str, str)) – Name-value pairs associated with the blob as metadata.

• tags (dict(str, str)) –

  Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

  New in version 12.4.0.

• 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 blob has an active lease. If specified, upload_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.

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

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version. Currently this parameter of upload_blob() API is for BlockBlob only.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• legal_hold (bool) –

  Specified if a legal hold should be set on the blob. Currently this parameter of upload_blob() API is for BlockBlob only.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

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

• timeout (int) – The timeout parameter is expressed in seconds. This method may make multiple calls to the Azure service and the timeout will apply to each call individually.

Blob-updated property dict (Etag and last modified)

dict[str, Any]

Example:

# Upload content to block blob with open(SOURCE_FILE, "rb") as data: blob_client.upload_blob(data, blob_type="BlockBlob") 

Creates a new Block Blob where the content of the blob is read from a given URL. The content of an existing blob is overwritten with the new blob.

source_url (str) –

A URL of up to 2 KB in length that specifies a file or blob. The value should be URL-encoded as it would appear in a request URI. If the source is in another account, the source must either be public or must be authenticated via a shared access signature. If the source is public, no authentication is required. Examples: https://myaccount.blob.core.windows.net/mycontainer/myblob

https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=<DateTime>

https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken

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

• include_source_blob_properties (bool) – Indicates if properties from the source blob should be copied. Defaults to True.

• tags (dict(str, str)) – Name-value pairs associated with the blob as tag. Tags are case-sensitive. The tag set may contain at most 10 tags. Tag keys must be between 1 and 128 characters, and tag values must be between 0 and 256 characters. Valid tag key and value characters include: lowercase and uppercase letters, digits (0-9), space (` `), plus (+), minus (-), period (.), solidus (/), colon (:), equals (=), underscore (_)

• source_content_md5 (bytearray) – Specify the md5 that is used to verify the integrity of the source bytes.

• source_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 source resource has been modified since the specified time.

• source_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 source resource has not been modified since the specified date/time.

• source_etag (str) – The source 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.

• source_match_condition (MatchConditions) – The source match condition to use upon the etag.

• 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) – The destination 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 destination match condition to use upon the etag.

• destination_lease (BlobLeaseClient or str) – The lease ID specified for this header must match the lease ID of the destination blob. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed).

• timeout (int) – The timeout parameter is expressed in seconds.

• content_settings (ContentSettings) – ContentSettings object used to set blob properties. Used to set content type, encoding, language, disposition, md5, and cache control.

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

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

• source_authorization (str) – Authenticate as a service principal using a client secret to access a source blob. Ensure “bearer ” is the prefix of the source_authorization string.

The Upload Pages operation writes a range of pages to a page blob.

• page (bytes) – Content of the page.

• offset (int) – Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• length (int) – Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

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

• validate_content (bool) – If true, calculates an MD5 hash of the page content. 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.

• if_sequence_number_lte (int) – If the blob’s sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_lt (int) – If the blob’s sequence number is less than the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_eq (int) – If the blob’s sequence number is equal to the specified value, the request proceeds; otherwise it fails.

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

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

• timeout (int) – The timeout parameter is expressed in seconds.

Blob-updated property dict (Etag and last modified).

dict(str, Any)

The Upload Pages operation writes a range of pages to a page blob where the contents are read from a URL.

• source_url (str) – The URL of the source data. It can point to any Azure Blob or File, that is either public or has a shared access signature attached.

• offset (int) – Start of byte range to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• length (int) – Number of bytes to use for writing to a section of the blob. Pages must be aligned with 512-byte boundaries, the start offset must be a modulus of 512 and the length must be a modulus of 512.

• source_offset (int) – This indicates the start of the range of bytes(inclusive) that has to be taken from the copy source. The service will read the same number of bytes as the destination range (length-offset).

• source_content_md5 (bytes) – If given, the service will calculate the MD5 hash of the block content and compare against this value.

• source_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 source resource has been modified since the specified time.

• source_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 source resource has not been modified since the specified date/time.

• source_etag (str) – The source 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.

• source_match_condition (MatchConditions) – The source match condition to use upon the etag.

• 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_sequence_number_lte (int) – If the blob’s sequence number is less than or equal to the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_lt (int) – If the blob’s sequence number is less than the specified value, the request proceeds; otherwise it fails.

• if_sequence_number_eq (int) – If the blob’s sequence number is equal to the specified value, the request proceeds; otherwise it fails.

• 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) – The destination 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 destination 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.

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

• timeout (int) – The timeout parameter is expressed in seconds.

• source_authorization (str) – Authenticate as a service principal using a client secret to access a source blob. Ensure “bearer ” is the prefix of the source_authorization string.

The version of the Storage API used for requests.

str

The location mode that the client is currently using.

By default this will be “primary”. Options include “primary” and “secondary”.

str

The full primary endpoint URL.

str

The hostname of the primary endpoint.

str

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.

str

ValueError –

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.

str or None

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().

Specifies the immutability policy mode to set on the blob. “Mutable” can only be returned by service, don’t set to “Mutable”.

Creates a new BlobLeaseClient.

This client provides lease operations on a BlobClient or ContainerClient.

• id (str) – The ID of the lease currently being maintained. This will be None if no lease has yet been acquired.

• etag (str) – The ETag of the lease currently being maintained. This will be None if no lease has yet been acquired or modified.

• last_modified (datetime) – The last modified timestamp of the lease currently being maintained. This will be None if no lease has yet been acquired or modified.

• client (BlobClient or ContainerClient) – The client of the blob or container to lease.

• lease_id (str) – A string representing the lease ID of an existing lease. This value does not need to be specified in order to acquire a new lease, or break one.

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.

lease_duration (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).

• 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) – The timeout parameter is expressed in seconds.

None

Break the lease, if the container or blob has an active lease.

Once a lease is broken, it cannot be renewed. Any authorized request can break the lease; the request is not required to specify a matching lease ID. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the container or blob. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired.

lease_break_period (int) – This is the proposed duration of seconds that the lease should continue before it is broken, between 0 and 60 seconds. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately.

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

• timeout (int) – The timeout parameter is expressed in seconds.

Approximate time remaining in the lease period, in seconds.

int

Change the lease ID of an active lease.

proposed_lease_id (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.

• 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) – The timeout parameter is expressed in seconds.

None

Release the lease.

The lease may be released if the client lease id specified matches that associated with the container or blob. Releasing the lease allows another client to immediately acquire the lease for the container or blob as soon as the release is complete.

• 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) – The timeout parameter is expressed in seconds.

None

Renews the lease.

The lease can be renewed if the lease ID specified in the lease client matches that associated with the container or blob. Note that the lease may be renewed even if it has expired as long as the container or blob has not been leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets.

• 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) – The timeout parameter is expressed in seconds.

None

An Iterable of Blob properties.

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

• name (str) – The prefix, or “directory name” of the blob.

• service_endpoint (str) – The service URL.

• prefix (str) – A blob name prefix being used to filter the list.

• marker (str) – The continuation token of the current page of results.

• results_per_page (int) – The maximum number of results retrieved per API call.

• next_marker (str) – The continuation token to retrieve the next page of results.

• location_mode (str) – The location mode being used to list results. The available options include “primary” and “secondary”.

• current_page (list(BlobProperties)) – The current page of listed results.

• container (str) – The container that the blobs are listed from.

• delimiter (str) – A delimiting character used for hierarchy listing.

• command (callable) – Function to retrieve the next page of items.

• prefix (str) – Filters the results to return only blobs whose names begin with the specified prefix.

• results_per_page (int) – The maximum number of blobs to retrieve per call.

• marker (str) – An opaque continuation token.

• delimiter (str) – Used to capture 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.

• location_mode – Specifies the location the request should be sent to. This mode only applies for RA-GRS accounts which allow secondary read access. Options include ‘primary’ or ‘secondary’.

Return an iterator of items.

args and kwargs will be passed to the PageIterator constructor directly, except page_iterator_class

Get an iterator of pages of objects, instead of an iterator of objects.

continuation_token (str) – An opaque continuation token. This value can be retrieved from the continuation_token field of a previous generator object. If specified, this generator will begin returning results from this point.

An iterator of pages (themselves iterator of objects)

Return the next item from the iterator. When exhausted, raise StopIteration

Blob Properties.

• name (str) – The name of the blob.

• container (str) – The container in which the blob resides.

• snapshot (str) – Datetime value that uniquely identifies the blob snapshot.

• blob_type (BlobType) – String indicating this blob’s type.

• metadata (dict) – Name-value pairs associated with the blob as metadata.

• last_modified (datetime) – A datetime object representing the last time the blob was modified.

• etag (str) – The ETag contains a value that you can use to perform operations conditionally.

• size (int) – The size of the content returned. If the entire blob was requested, the length of blob in bytes. If a subset of the blob was requested, the length of the returned subset.

• content_range (str) – Indicates the range of bytes returned in the event that the client requested a subset of the blob.

• append_blob_committed_block_count (int) – (For Append Blobs) Number of committed blocks in the blob.

• is_append_blob_sealed (bool) –

  Indicate if the append blob is sealed or not.

  New in version 12.4.0.

• page_blob_sequence_number (int) – (For Page Blobs) Sequence number for page blob used for coordinating concurrent writes.

• server_encrypted (bool) – Set to true if the blob is encrypted on the server.

• copy (CopyProperties) – Stores all the copy properties for the blob.

• content_settings (ContentSettings) – Stores all the content settings for the blob.

• lease (LeaseProperties) – Stores all the lease information for the blob.

• blob_tier (StandardBlobTier) – Indicates the access tier of the blob. 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.

• rehydrate_priority (str) – Indicates the priority with which to rehydrate an archived blob

• blob_tier_change_time (datetime) – Indicates when the access tier was last changed.

• blob_tier_inferred (bool) – Indicates whether the access tier was inferred by the service. If false, it indicates that the tier was set explicitly.

• deleted (bool) – Whether this blob was deleted.

• deleted_time (datetime) – A datetime object representing the time at which the blob was deleted.

• remaining_retention_days (int) – The number of days that the blob will be retained before being permanently deleted by the service.

• creation_time (datetime) – Indicates when the blob was created, in UTC.

• archive_status (str) – Archive status of blob.

• encryption_key_sha256 (str) – The SHA-256 hash of the provided encryption 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.

• request_server_encrypted (bool) – Whether this blob is encrypted.

• object_replication_source_properties (list(ObjectReplicationPolicy)) –

  Only present for blobs that have policy ids and rule ids applied to them.

  New in version 12.4.0.

• object_replication_destination_policy (str) –

  Represents the Object Replication Policy Id that created this blob.

  New in version 12.4.0.

• last_accessed_on (datetime) –

  Indicates when the last Read/Write operation was performed on a Blob.

  New in version 12.6.0.

• tag_count (int) –

  Tags count on this blob.

  New in version 12.4.0.

• str) tags (dict(str,) –

  Key value pair of tags on this blob.

  New in version 12.4.0.

• has_versions_only (bool) –

  A true value indicates the root blob is deleted

  New in version 12.10.0.

• immutability_policy (ImmutabilityPolicy) –

  Specifies the immutability policy of a blob, blob snapshot or blob version.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

• has_legal_hold (bool) –

  Specified if a legal hold should be set on the blob. Currently this parameter of upload_blob() API is for BlockBlob only.

  New in version 12.10.0: This was introduced in API version ‘2020-10-02’.

The error happened during quick query operation.

• error (str) – The name of the error.

• is_fatal (bool) – If true, this error prevents further query processing. More result data may be returned, but there is no guarantee that all of the original data will be processed. If false, this error does not prevent further query processing.

• description (str) – A description of the error.

• position (int) – The blob offset at which the error occurred.

A streaming object to read query results.

• name (str) – The name of the blob being quered.

• container (str) – The name of the container where the blob is.

• response_headers (dict) – The response_headers of the quick query request.

• record_delimiter (bytes) – The delimiter used to separate lines, or records with the data. The records method will return these lines via a generator.

Return all query results.

This operation is blocking until all data is downloaded. If encoding has been configured - this will be used to decode individual records are they are received.

Union[bytes, str]

Download the query result to a stream.

stream – The stream to download to. This can be an open file-handle, or any writable stream.

None

Returns a record generator for the query result.

Records will be returned line by line. If encoding has been configured - this will be used to decode individual records are they are received.

Iterable[Union[bytes, str]]

BlobSasPermissions class to be used with the generate_blob_sas() function.

• read (bool) – Read the content, properties, metadata and block list. Use the blob as the source of a copy operation.

• add (bool) – Add a block to an append blob.

• create (bool) – Write a new blob, snapshot a blob, or copy a blob to a new blob.

• write (bool) – Create or write content, properties, metadata, or block list. Snapshot or lease the blob. Resize the blob (page blob only). Use the blob as the destination of a copy operation within the same account.

• delete (bool) – Delete the blob.

• delete_previous_version (bool) – Delete the previous blob version for the versioning enabled storage account.

• tag (bool) – Set or get tags on the blob.

set_immutability_policy (bool) – To enable operations related to set/delete immutability policy. To get immutability policy, you just need read permission.

Create a BlobSasPermissions from a string.

To specify read, add, create, write, or delete permissions you need only to include the first letter of the word in the string. E.g. For read and write permissions, you would provide a string “rw”.

permission (str) – The string which dictates the read, add, create, write, or delete permissions.

A BlobSasPermissions object

BlobSasPermissions

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.

For more optional configuration, please click here.

• account_url (str) – The URL to the blob storage account. Any other entities included in the URL path (e.g. container or blob) will be discarded. This URL can be optionally authenticated with a SAS token.

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

• api_version (str) –

  The Storage API version to use for requests. Default value is ‘2019-07-07’. 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 4*1024*1024, 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 64*1024*1024, 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 4*1024*1024+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 4*1024*1024, 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 32*1024*1024, or 32MB.

• max_chunk_get_size (int) – The maximum chunk size used for downloading a blob. Defaults to 4*1024*1024, or 4MB.

Example:

from azure.storage.blob import BlobServiceClient blob_service_client = BlobServiceClient(account_url=self.url, credential=self.shared_access_key) 

# Get a token credential for authentication from azure.identity import ClientSecretCredential token_credential = ClientSecretCredential( self.active_directory_tenant_id, self.active_directory_application_id, self.active_directory_application_secret ) # Instantiate a BlobServiceClient using a token credential from azure.storage.blob import BlobServiceClient blob_service_client = BlobServiceClient(account_url=self.oauth_url, credential=token_credential) 

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

Creates a new container under the specified account.

If the container with the same name already exists, a ResourceExistsError will be raised. This method returns a client with which to interact with the newly created container.

• name (str) – The name of the container to create.

• metadata (dict(str, str)) – A dict with name-value pairs to associate with the container as metadata. Example: {‘Category’:’test’}

• public_access (str or PublicAccess) – Possible values include: ‘container’, ‘blob’.

• 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) – The timeout parameter is expressed in seconds.

ContainerClient

Example:

try: new_container = blob_service_client.create_container("containerfromblobservice") properties = new_container.get_container_properties() except ResourceExistsError: print("Container already exists.") 

Marks the specified container for deletion.

The container and any blobs contained within it are later deleted during garbage collection. If the container is not found, a ResourceNotFoundError will be raised.

• container (str or ContainerProperties) – The container to delete. This can either be the name of the container, or an instance of ContainerProperties.

• lease – 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) – The timeout parameter is expressed in seconds.

None

Example:

# Delete container if it exists try: blob_service_client.delete_container("containerfromblobservice") except ResourceNotFoundError: print("Container already deleted.") 

The Filter Blobs operation enables callers to list blobs across all containers whose tags match a given search expression. Filter blobs searches across all containers within a storage account but can be scoped within the expression to a single container.

filter_expression (str) – The expression to find blobs whose tags matches the specified condition. eg. “”yourtagname”=’firsttag’ and “yourtagname2”=’secondtag’” To specify a container, eg. “@container=’containerName’ and “Name”=’C’”

• results_per_page (int) – The max result per page when paginating.

• timeout (int) – The timeout parameter is expressed in seconds.

An iterable (auto-paging) response of BlobProperties.

ItemPaged[FilteredBlob]

Create BlobServiceClient from a Connection String.

• conn_str (str) – A connection string to an Azure Storage account.

• credential – 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 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.

A Blob service client.

BlobServiceClient

Example:

from azure.storage.blob import BlobServiceClient blob_service_client = BlobServiceClient.from_connection_string(self.connection_string) 

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

A dict of account information (SKU and account type).

dict(str, str)

Example:

account_info = blob_service_client.get_account_information() print('Using Storage SKU: {}'.format(account_info['sku_name'])) 

Get a client to interact with the specified blob.

The blob need not already exist.

• container (str or ContainerProperties) – The container that the blob is in. This can either be the name of the container, or an instance of ContainerProperties.

• blob (str or BlobProperties) – The blob with which to interact. This can either be the name of the blob, or an instance of BlobProperties.

• snapshot (str or dict(str, Any)) – The optional blob snapshot on which to operate. This can either be the ID of the snapshot, or a dictionary output returned by create_snapshot().

A BlobClient.

BlobClient

Example:

blob_client = blob_service_client.get_blob_client(container="containertest", blob="my_blob") try: stream = blob_client.download_blob() except ResourceNotFoundError: print("No blob found.") 

Get a client to interact with the specified container.

The container need not already exist.

container (str or ContainerProperties) – The container. This can either be the name of the container, or an instance of ContainerProperties.

A ContainerClient.

ContainerClient

Example:

# Get a client to interact with a specific container - though it may not yet exist container_client = blob_service_client.get_container_client("containertest") try: for blob in container_client.list_blobs(): print("Found blob: ", blob.name) except ResourceNotFoundError: print("Container not found.") 

Gets the properties of a storage account’s Blob service, including Azure Storage Analytics.

timeout (int) – The timeout parameter is expressed in seconds.

An object containing blob service properties such as analytics logging, hour/minute metrics, cors rules, etc.

Dict[str, Any]

Example:

properties = blob_service_client.get_service_properties() 

Retrieves statistics related to replication for the Blob service.

It is only available when read-access geo-redundant replication is enabled for the storage account.

With geo-redundant replication, Azure Storage maintains your data durable in two locations. In both locations, Azure Storage constantly maintains multiple healthy replicas of your data. The location where you read, create, update, or delete data is the primary storage account location. The primary location exists in the region you choose at the time you create an account via the Azure Management Azure classic portal, for example, North Central US. The location to which your data is replicated is the secondary location. The secondary location is automatically determined based on the location of the primary; it is in a second data center that resides in the same region as the primary location. Read-only access is available from the secondary location, if read-access geo-redundant replication is enabled for your storage account.

timeout (int) – The timeout parameter is expressed in seconds.

The blob service stats.

Dict[str, Any]

Example:

stats = blob_service_client.get_service_stats() 

Obtain a user delegation key for the purpose of signing SAS tokens. A token credential must be present on the service object for this request to succeed.

• key_start_time (datetime) – A DateTime value. Indicates when the key becomes valid.

• key_expiry_time (datetime) – A DateTime value. Indicates when the key stops being valid.

timeout (int) – The timeout parameter is expressed in seconds.

The user delegation key.

UserDelegationKey

Returns a generator to list the containers under the specified account.

The generator will lazily follow the continuation tokens returned by the service and stop when all containers have been returned.

• name_starts_with (str) – Filters the results to return only containers whose names begin with the specified prefix.

• include_metadata (bool) – Specifies that container metadata to be returned in the response. The default value is False.

• include_deleted (bool) – Specifies that deleted containers to be returned in the response. This is for container restore enabled account. The default value is False. .. versionadded:: 12.4.0

• results_per_page (int) – The maximum number of container names to retrieve per API call. If the request does not specify the server will return up to 5,000 items.

• timeout (int) – The timeout parameter is expressed in seconds.

An iterable (auto-paging) of ContainerProperties.

ItemPaged[ContainerProperties]

Example:

# List all containers all_containers = blob_service_client.list_containers(include_metadata=True) for container in all_containers: print(container['name'], container['metadata']) # Filter results with name prefix test_containers = blob_service_client.list_containers(name_starts_with='test-') for container in test_containers: print(container['name'], container['metadata']) 

Sets the properties of a storage account’s Blob service, including Azure Storage Analytics.

If an element (e.g. analytics_logging) is left as None, the existing settings on the service for that functionality are preserved.

• analytics_logging (BlobAnalyticsLogging) – Groups the Azure Analytics Logging settings.

• hour_metrics (Metrics) – The hour metrics settings provide a summary of request statistics grouped by API in hourly aggregates for blobs.

• minute_metrics (Metrics) – The minute metrics settings provide request statistics for each minute for blobs.

• cors (list[CorsRule]) – You can include up to five CorsRule elements in the list. If an empty list is specified, all CORS rules will be deleted, and CORS will be disabled for the service.

• target_version (str) – Indicates the default version to use for requests if an incoming request’s version is not specified.

• delete_retention_policy (RetentionPolicy) – The delete retention policy specifies whether to retain deleted blobs. It also specifies the number of days and versions of blob to keep.

• static_website (StaticWebsite) – Specifies whether the static website feature is enabled, and if yes, indicates the index document and 404 error document to use.

timeout (int) – The timeout parameter is expressed in seconds.

None

Example:

# Create service properties from azure.storage.blob import BlobAnalyticsLogging, Metrics, CorsRule, RetentionPolicy # Create logging settings logging = BlobAnalyticsLogging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5)) # Create metrics for requests statistics hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5)) minute_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5)) # Create CORS rules cors_rule = CorsRule(['www.xyz.com'], ['GET']) cors = [cors_rule] # Set the service properties blob_service_client.set_service_properties(logging, hour_metrics, minute_metrics, cors)