The copy operation to abort. This can be either an ID string, or aninstance of BlobProperties.

Specifies the duration of the lease, in seconds, or negative one(-1) for a lease that never expires. A non-infinite lease can bebetween 15 and 60 seconds. A lease duration cannot be changedusing renew or change. Default is -1 (infinite lease).

Proposed lease ID, in a GUID string format. The Blob Servicereturns 400 (Invalid request) if the proposed lease ID is notin the correct format.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

Content of the block. This can be bytes, text, an iterable or a file-like object.

Size of the block in bytes.

If true, calculates an MD5 hash of the block content. The storageservice checks the hash of the content that has arrivedwith the hash that was sent. This is primarily valuable for detectingbitflips 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 theblob.

Optional conditional header. The max length in bytes permitted forthe append blob. If the Append Block operation would cause the blobto exceed that limit or if the blob size is already greater than thevalue specified in this header, the request will fail withMaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

Defaults to UTF-8.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

The URL of the source data. It can point to any Azure Blob or File, that is either public or has ashared access signature attached.

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

This indicates the end of the range of bytes that has to be taken from the copy source.

If given, the service will calculate the MD5 hash of the block content and compare against this value.

Optional conditional header. The max length in bytes permitted forthe append blob. If the Append Block operation would cause the blobto exceed that limit or if the blob size is already greater than thevalue specified in this header, the request will fail withMaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

The destination ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The destination match condition to use upon the etag.

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.

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

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

The source ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The source match condition to use upon the etag.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " isthe prefix of the source_authorization string.

Required when source is Azure Storage Files and usingTokenCredential for authentication.This is ignored for other forms of authentication.Specifies the intent for all requests when usingTokenCredential authentication. Possible values are:

backup - Specifies requests are intended for backup/admin type operations, meaning that all file/directoryACLs are bypassed and full permissions are granted. User must also have required RBAC permission.

Start of byte range to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Number of bytes to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

If the blob's sequence number is less than or equal tothe specified value, the request proceeds; otherwise it fails.

If the blob's sequence number is less than the specifiedvalue, the request proceeds; otherwise it fails.

If the blob's sequence number is equal to the specifiedvalue, the request proceeds; otherwise it fails.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

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

List of Blockblobs.

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

Name-value pairs associated with the blob as metadata.

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.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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 true, calculates an MD5 hash of the page content. The storageservice checks the hash of the content that has arrivedwith the hash that was sent. This is primarily valuable for detectingbitflips 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 theblob.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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

New in version 12.4.0.

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.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

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

Name-value pairs associated with the blob as metadata.

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.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

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.

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

Name-value pairs associated with the blob as metadata.

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

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.

Only for Page blobs. The sequence number is a user-controlled value that you can use totrack requests. The value of the sequence number must be between 0and 2^63 - 1.The default value is 0.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

Name-value pairs associated with the blob as metadata.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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

New in version 12.4.0.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

Required if the blob has associated snapshots. Values include:

• "only": Deletes only the blobs snapshots.

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

The version id parameter is an opaque DateTimevalue 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'.

Required if the blob has an active lease. If specified, delete_blob onlysucceeds if the blob's lease is active and matches this ID. Value can be aBlobLeaseClient object or the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to check if it exists.

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

Start of byte range to use for downloading a section of the blob.Must be set if length is provided.

Number of bytes to read from the stream. This is optional, butshould be supplied for optimal performance.

The version id parameter is an opaque DateTimevalue 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 true, calculates an MD5 hash for each chunk of the blob. The storageservice checks the hash of the content that has arrived with the hashthat was sent. This is primarily valuable for detecting bitflips onthe wire if using http instead of https, as https (the default), willalready validate. Note that this MD5 hash is not stored with theblob. Also note that if enabled, the memory-efficient upload algorithmwill not be used because computing the MD5 hash requires bufferingentire blocks, and doing so defeats the purpose of the memory-efficient algorithm.

Required if the blob has an active lease. If specified, download_blob onlysucceeds if the blob's lease is active and matches this ID. Value can be aBlobLeaseClient object or the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

Maximum number of parallel connections to use when transferring the blob in chunks.This option does not affect the underlying connection pool, and mayrequire a separate configuration of the connection pool.

Encoding to decode the downloaded bytes. Default is None, i.e. no decoding.

A callback to track the progress of a long running download. The signature isfunction(current: int, total: int) where current is the number of bytes transferredso far, and total is the total size of the download.

Sets the server-side timeout for the operation in seconds. For more details seehttps://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.This value is not tracked or validated on the client. To configure client-side network timesoutsseehere. This method may make multiple calls to the service andthe timeout will apply to each call individually.multiple calls to the Azure service and the timeout will apply toeach call individually.

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to check if it exists.

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

The full endpoint URL to the Blob, including SAS token and snapshot if used. This could beeither the primary endpoint, or the secondary endpoint depending on the currentlocation_mode.

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

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

The optional blob snapshot on which to operate. This can be the snapshot ID stringor the response returned fromcreate_snapshot. If specified, this will overridethe snapshot in the url.

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

The audience to use when requesting tokens for Azure Active Directoryauthentication. Only has an effect when credential is of type TokenCredential. The value could behttps://storage.azure.com/ (default) orhttps://<account>.blob.core.windows.net.

A connection string to an Azure Storage account.

The container name for the blob.

The name of the blob with which to interact.

The optional blob snapshot on which to operate. This can be the snapshot ID stringor the response returned fromcreate_snapshot.

The credentials with which to authenticate. This is optional if theaccount URL already has a SAS token, or the connection string already has sharedaccess key values. The value can be a SAS token string,an instance of a AzureSasCredential or AzureNamedKeyCredential from azure.core.credentials,an account shared access key, or an instance of a TokenCredentials class from azure.identity.Credentials provided here will take precedence over those in the connection string.If using an instance of AzureNamedKeyCredential, "name" should be the storage account name, and "key"should be the storage account key.

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

The audience to use when requesting tokens for Azure Active Directoryauthentication. Only has an effect when credential is of type TokenCredential. The value could behttps://storage.azure.com/ (default) orhttps://<account>.blob.core.windows.net.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

The version id parameter is an opaque DateTimevalue 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'.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

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

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to add tags to.

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

Specifies whether to return the list of committedblocks, the list of uncommitted blocks, or both lists together.Possible values include: 'committed', 'uncommitted', 'all'

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

New in version 12.4.0.

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

Specifies the URL of a previous snapshot of the managed disk.The response will only contain pages that were changed between the target blob andits previous snapshot.

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 offsetmust be a modulus of 512 and the length must be a modulus of512.

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 tothe specified length.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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

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 offsetmust be a modulus of 512 and the length must be a modulus of512.

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 tothe specified length.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

The snapshot diff parameter that contains an opaque DateTime value thatspecifies a previous blob snapshot to be comparedagainst a more recent snapshot or the current blob.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

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 offsetmust be a modulus of 512 and the length must be a modulus of512.

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 tothe specified length.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

A snapshot value that specifies that the response will contain only pages that were changedbetween target blob and previous snapshot. Changed pages include both updated and clearedpages. The target blob may be a snapshot, as long as the snapshot specified byprevious_snapshotis the older of the two.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

The maximum number of page ranges to retrieve per API call.

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

Required. a query statement. For more details seehttps://learn.microsoft.com/azure/storage/blobs/query-acceleration-sql-reference.

A function to be called on any processing errors returned by the service.

Optional. Defines the serialization of the data currently stored in the blob. The default is totreat the blob data as CSV data formatted in the default dialect. This can be overridden witha 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

Optional. Defines the output serialization for the data stream. By default the data will be returnedas 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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

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

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.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

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

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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

Dict containing name and value pairs. Each call to this operationreplaces all existing metadata attached to the blob. To remove allmetadata from the blob, call this operation with no metadata headers.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

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

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to add tags to.

If true, calculates an MD5 hash of the tags content. The storageservice checks the hash of the content that has arrivedwith the hash that was sent. This is primarily valuable for detectingbitflips 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 theblob.

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

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

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to check if it exists.

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

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

The version id parameter is an opaque DateTimevalue that, when present, specifies the version of the blob to check if it exists.

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

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

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.

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

This property indicates how the service should modify the blob's sequencenumber. SeeSequenceNumberAction for more information.

This property sets the blob's sequence number. The sequence number is auser-controlled property that you can use to track requests and manageconcurrency issues.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

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

Indicates the priority with which to rehydrate an archived blob

The version id parameter is an opaque DateTimevalue 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'.

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.

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

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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.

The blob data.

Size of the block.

If true, calculates an MD5 hash for each chunk of the blob. The storageservice checks the hash of the content that has arrived with the hashthat was sent. This is primarily valuable for detecting bitflips onthe wire if using http instead of https, as https (the default), willalready validate. Note that this MD5 hash is not stored with theblob. Also note that if enabled, the memory-efficient upload algorithmwill not be used because computing the MD5 hash requires bufferingentire blocks, and doing so defeats the purpose of the memory-efficient algorithm.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

Defaults to UTF-8.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

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.

The URL.

Start of byte range to use for the block.Must be set if source length is provided.

The size of the block in bytes.

Specify the md5 calculated for the range ofbytes that must be read from the copy source.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " isthe prefix of the source_authorization string.

Required when source is Azure Storage Files and usingTokenCredential for authentication.This is ignored for other forms of authentication.Specifies the intent for all requests when usingTokenCredential authentication. Possible values are:

backup - Specifies requests are intended for backup/admin type operations, meaning that all file/directoryACLs are bypassed and full permissions are granted. User must also have required RBAC permission.

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 publicor must be authenticated via a shared access signature. If the sourceis 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

Name-value pairs associated with the blob as metadata. If no name-valuepairs are specified, the operation will copy the metadata from thesource blob or file to the destination blob. If one or more name-valuepairs are specified, the destination blob is created with the specifiedmetadata, and metadata is not copied from the source blob or file.

Copies the snapshot of the source page blob to a destination page blob.The snapshot is copied such that only the differential changes betweenthe previously copied snapshot are transferred to the destination.The copied snapshots are complete copies of the original snapshot andcan be read or copied from as usual. Defaults to False.

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

The (case-sensitive) literal "COPY" can instead be passed to copy tags from the source blob.This option is only available whenincremental_copy=False andrequires_sync=True.

New in version 12.4.0.

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

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

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 sourceblob has been modified since the specified date/time.

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 blobhas not been modified since the specified date/time.

The source ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The source match condition to use upon the etag.

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 onlyif the destination blob has been modified since the specified date/time.If the destination blob has not been modified, the Blob service returnsstatus code 412 (Precondition Failed).

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 onlyif the destination blob has not been modified since the specifieddate/time. If the destination blob has been modified, the Blob servicereturns status code 412 (Precondition Failed).

The destination ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The destination match condition to use upon the etag.

The lease ID specified for this header must match the lease ID of thedestination blob. If the request does not include the lease ID or it is notvalid, the operation fails with status code 412 (Precondition Failed).

Specify this to perform the Copy Blob operation only ifthe lease ID given matches the active lease ID of the source blob.

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

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

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.

Indicates the priority with which to rehydrate an archived blob

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

New in version 12.4.0.

Enforces that the service will not return a response until the copy is complete.

Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " isthe prefix of the source_authorization string. This option is only available whenincremental_copy isset to False andrequires_sync is set to True.

New in version 12.9.0.

Required when source is Azure Storage Files and usingTokenCredential for authentication.This is ignored for other forms of authentication.Specifies the intent for all requests when usingTokenCredential authentication. Possible values are:

backup - Specifies requests are intended for backup/admin type operations, meaning that all file/directoryACLs are bypassed and full permissions are granted. User must also have required RBAC permission.

A predefined encryption scope used to encrypt the data on the sync copied blob. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.10.0.

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

The blob data to upload.

The type of the blob. This can beeither BlockBlob, PageBlob or AppendBlob. The default value is BlockBlob.

Number of bytes to read from the stream. This is optional, butshould be supplied for optimal performance.

Name-value pairs associated with the blob as metadata.

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.

Whether the blob to be uploaded should overwrite the current data.If True, upload_blob will overwrite the existing data. If set to False, theoperation will fail with ResourceExistsError. The exception to the above is with Appendblob types: if set to False and the data already exists, an error will not be raisedand the data will be appended to the existing blob. If set overwrite=True, then the existingappend blob will be deleted, and a new one created. Defaults to False.

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

If true, calculates an MD5 hash for each chunk of the blob. The storageservice checks the hash of the content that has arrived with the hashthat was sent. This is primarily valuable for detecting bitflips onthe wire if using http instead of https, as https (the default), willalready validate. Note that this MD5 hash is not stored with theblob. Also note that if enabled, the memory-efficient upload algorithmwill not be used because computing the MD5 hash requires bufferingentire blocks, and doing so defeats the purpose of the memory-efficient algorithm.

Required if the blob has an active lease. If specified, upload_blob only succeeds if theblob's lease is active and matches this ID. Value can be a BlobLeaseClient objector the lease ID as a string.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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

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.

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

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

Optional conditional header. The max length in bytes permitted forthe append blob. If the Append Block operation would cause the blobto exceed that limit or if the blob size is already greater than thevalue specified in this header, the request will fail withMaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).

Maximum number of parallel connections to use when transferring the blob in chunks.This option does not affect the underlying connection pool, and mayrequire a separate configuration of the connection pool.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

Defaults to UTF-8.

A callback to track the progress of a long running upload. The signature isfunction(current: int, total: Optional[int]) where current is the number of bytes transferredso far, and total is the size of the blob or None if the size is unknown.

Sets the server-side timeout for the operation in seconds. For more details seehttps://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations.This value is not tracked or validated on the client. To configure client-side network timesoutsseehere. This method may make multiple calls to the service andthe timeout will apply to each call individually.

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.The source must either be public or must be authenticated via a sharedaccess signature as part of the url or using the source_authorization keyword.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

Name-value pairs associated with the blob as metadata.

Whether the blob to be uploaded should overwrite the current data.If True, upload_blob will overwrite the existing data. If set to False, theoperation will fail with ResourceExistsError.

Indicates if properties from the source blob should be copied. Defaults to True.

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

Specify the md5 that is used to verify the integrity of the source bytes.

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

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

The source ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The source match condition to use upon the etag.

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

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

The destination ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The destination match condition to use upon the etag.

The lease ID specified for this header must match the lease ID of thedestination blob. If the request does not include the lease ID or it is notvalid, the operation fails with status code 412 (Precondition Failed).

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

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

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

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.

Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " isthe prefix of the source_authorization string.

Required when source is Azure Storage Files and usingTokenCredential for authentication.This is ignored for other forms of authentication.Specifies the intent for all requests when usingTokenCredential authentication. Possible values are:

backup - Specifies requests are intended for backup/admin type operations, meaning that all file/directoryACLs are bypassed and full permissions are granted. User must also have required RBAC permission.

Content of the page.

Start of byte range to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Number of bytes to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

If true, calculates an MD5 hash of the page content. The storageservice checks the hash of the content that has arrivedwith the hash that was sent. This is primarily valuable for detectingbitflips 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 theblob.

If the blob's sequence number is less than or equal tothe specified value, the request proceeds; otherwise it fails.

If the blob's sequence number is less than the specifiedvalue, the request proceeds; otherwise it fails.

If the blob's sequence number is equal to the specifiedvalue, the request proceeds; otherwise it fails.

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

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

An ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The match condition to use upon the etag.

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.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

Defaults to UTF-8.

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

The URL of the source data. It can point to any Azure Blob or File, that is either public or has ashared access signature attached.

Start of byte range to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

Number of bytes to use for writing to a section of the blob.Pages must be aligned with 512-byte boundaries, the start offsetmust be a modulus of 512 and the length must be a modulus of512.

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

If given, the service will calculate the MD5 hash of the block content and compare against this value.

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

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

The source ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The source match condition to use upon the etag.

Required if the blob has an active lease. Value can be a BlobLeaseClient objector the lease ID as a string.

If the blob's sequence number is less than or equal tothe specified value, the request proceeds; otherwise it fails.

If the blob's sequence number is less than the specifiedvalue, the request proceeds; otherwise it fails.

If the blob's sequence number is equal to the specifiedvalue, the request proceeds; otherwise it fails.

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

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

The destination ETag value, or the wildcard character (*). Used to check if the resource has changed,and act according to the condition specified by thematch_condition parameter.

The destination match condition to use upon the etag.

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.

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.

A predefined encryption scope used to encrypt the data on the service. An encryptionscope can be created using the Management API and referenced here by name. If a defaultencryption scope has been defined at the container, this value will override it if thecontainer-level scope is configured to allow overrides. Otherwise an error will be raised.

New in version 12.2.0.

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

Authenticate as a service principal using a client secret to access a source blob. Ensure "bearer " isthe prefix of the source_authorization string.

Required when source is Azure Storage Files and usingTokenCredential for authentication.This is ignored for other forms of authentication.Specifies the intent for all requests when usingTokenCredential authentication. Possible values are:

backup - Specifies requests are intended for backup/admin type operations, meaning that all file/directoryACLs are bypassed and full permissions are granted. User must also have required RBAC permission.