BlockBlobService Class
Block blobs let you upload large blobs efficiently. Block blobs are comprised of blocks, each of which is identified by a block ID. You create or modify a block blob by writing a set of blocks and committing them by their block IDs. Each block can be a different size, up to a maximum of 100 MB, and a block blob can include up to 50,000 blocks. The maximum size of a block blob is therefore approximately 4.75 TB (100 MB X 50,000 blocks). If you are writing a block blob that is no more than 64 MB in size, you can upload it in its entirety with a single write operation; see create_blob_from_bytes.
:type ~azure.storage.common.TokenCredential
- Inheritance
-
BlockBlobService
Constructor
BlockBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, connection_string=None, socket_timeout=None, token_credential=None)Parameters
| Name | Description |
|---|---|
|
account_name
|
The storage account name. This is used to authenticate requests signed with an account key and to construct the storage endpoint. It is required unless a connection string is given, or if a custom domain is used with anonymous authentication. default value: None
|
|
account_key
|
The storage account key. This is used for shared key authentication. If neither account key or sas token is specified, anonymous access will be used. default value: None
|
|
sas_token
|
A shared access signature token to use to authenticate requests instead of the account key. If account key and sas token are both specified, account key will be used to sign. If neither are specified, anonymous access will be used. default value: None
|
|
is_emulated
|
Whether to use the emulator. Defaults to False. If specified, will override all other parameters besides connection string and request session. default value: False
|
|
protocol
|
The protocol to use for requests. Defaults to https. default value: https
|
|
endpoint_suffix
|
The host base component of the url, minus the account name. Defaults to Azure (core.windows.net). Override this to use the China cloud (core.chinacloudapi.cn). default value: core.windows.net
|
|
custom_domain
|
The custom domain to use. This can be set in the Azure Portal. For example, 'www.mydomain.com'. default value: None
|
|
request_session
|
<xref:requests.Session>
The session object to use for http requests. default value: None
|
|
connection_string
|
If specified, this will override all other parameters besides request session. See http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/ for the connection string format. default value: None
|
|
socket_timeout
|
If specified, this will override the default socket timeout. The timeout specified is in seconds. See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value. default value: None
|
|
token_credential
|
A token credential used to authenticate HTTPS requests. The token value should be updated before its expiration. default value: None
|
Variables
| Name | Description |
|---|---|
|
MAX_SINGLE_PUT_SIZE
|
The largest size upload supported in a single put call. This is used by the create_blob_from_* methods if the content length is known and is less than this value. |
|
MAX_BLOCK_SIZE
|
The size of the blocks put by create_blob_from_* methods if the content length is unknown or is larger than MAX_SINGLE_PUT_SIZE. Smaller blocks may be put. The maximum block size the service supports is 100MB. |
|
MIN_LARGE_BLOCK_UPLOAD_THRESHOLD
|
The minimum block size at which the the memory-optimized, block upload algorithm is considered. This algorithm is only applicable to the create_blob_from_file and create_blob_from_stream methods and will prevent the full buffering of blocks. In addition to the block size, ContentMD5 validation and Encryption must be disabled as these options require the blocks to be buffered. |
Methods
| abort_copy_blob |
Aborts a pending copy_blob operation, and leaves a destination blob with zero length and full metadata. |
| acquire_blob_lease |
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 ID. |
| acquire_container_lease |
Requests a new lease. If the container does not have an active lease, the Blob service creates a lease on the container and returns a new lease ID. |
| batch_delete_blobs |
Sends a batch of multiple blob delete requests. The blob delete method deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots. For more information, see https://docs.microsoft.com/rest/api/storageservices/delete-blob |
| batch_set_standard_blob_tier |
Sends a batch of multiple set block blob tiers requests. This API is only supported for block blobs on standard storage accounts. |
| break_blob_lease |
Breaks the lease, if the 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 blob. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. A lease that has been broken can also be released, in which case another client may immediately acquire the lease on the blob. |
| break_container_lease |
Break the lease, if the container 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. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. |
| change_blob_lease |
Changes the lease ID of an active lease. A change must include the current lease ID and a new lease ID. |
| change_container_lease |
Change the lease ID of an active lease. A change must include the current lease ID and a new lease ID. |
| copy_blob |
Copies a blob. This operation returns a copy operation properties object. The copy operation may be configured to either be an asynchronous, best-effort operation, or a synchronous operation. The source must be a block blob if requires_sync is true. Any existing destination blob will be overwritten. The destination blob cannot be modified while a copy operation is in progress. 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. You can call get_blob_properties on the destination blob to check the status of the copy operation. The final blob will be committed when the copy completes. Name of the destination container. The container must exist. :param str blob_name: Name of the destination blob. If the destination blob exists, it will be overwritten. Otherwise, it will be created. :param str copy_source: A URL of up to 2 KB in length that specifies an Azure 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= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :param metadata: 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. :type metadata: dict(str, str) :param datetime source_if_modified_since: 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. :param datetime source_if_unmodified_since: 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. :param ETag source_if_match: An ETag value, or the wildcard character (). Specify this conditional header to copy the source blob only if its ETag matches the value specified. If the ETag values do not match, the Blob service returns status code 412 (Precondition Failed). This header cannot be specified if the source is an Azure File. :param ETag source_if_none_match: An ETag value, or the wildcard character (). Specify this conditional header to copy the blob only if its ETag does not match the value specified. If the values are identical, the Blob service returns status code 412 (Precondition Failed). This header cannot be specified if the source is an Azure File. :param datetime destination_if_modified_since: 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). :param datetime destination_if_unmodified_since: 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). :param ETag destination_if_match: An ETag value, or the wildcard character (). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value matches the ETag value for an existing destination blob. If the ETag for the destination blob does not match the ETag specified for If-Match, the Blob service returns status code 412 (Precondition Failed). :param ETag destination_if_none_match: An ETag value, or the wildcard character (). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value does not match the ETag value for the destination blob. Specify the wildcard character (*) to perform the operation only if the destination blob does not exist. If the specified condition isn't met, the Blob service returns status code 412 (Precondition Failed). :param str destination_lease_id: 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). :param str source_lease_id: Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob. :param int timeout: The timeout parameter is expressed in seconds. :param bool requires_sync: Enforces that the service will not return a response until the copy is complete. :param StandardBlobTier standard_blob_tier: 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. :param RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :return: Copy operation properties such as status, source, and ID. :rtype: CopyProperties |
| create_blob_from_bytes |
Creates a new blob from an array of bytes, or updates the content of an existing blob, with automatic chunking and progress notifications. |
| create_blob_from_path |
Creates a new blob from a file path, or updates the content of an existing blob, with automatic chunking and progress notifications. |
| create_blob_from_stream |
Creates a new blob from a file/stream, or updates the content of an existing blob, with automatic chunking and progress notifications. |
| create_blob_from_text |
Creates a new blob from str/unicode, or updates the content of an existing blob, with automatic chunking and progress notifications. |
| create_container |
Creates a new container under the specified account. If the container with the same name already exists, the operation fails if fail_on_exist is True. |
| delete_blob |
Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection. Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation. If a delete retention policy is enabled for the service, then this operation soft deletes the blob or snapshot and retains the blob or snapshot for specified number of days. After specified number of days, blob's data is removed from the service during garbage collection. Soft deleted blob or snapshot is accessible through List Blobs API specifying include=Include.Deleted option. Soft-deleted blob or snapshot can be restored using Undelete API. |
| delete_container |
Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection. |
| exists |
Returns a boolean indicating whether the container exists (if blob_name is None), or otherwise a boolean indicating whether the blob exists. |
| extract_date_and_request_id | |
| generate_account_shared_access_signature |
Generates a shared access signature for the blob service. Use the returned signature with the sas_token parameter of any BlobService. |
| generate_blob_shared_access_signature |
Generates a shared access signature for the blob or one of its snapshots. Use the returned signature with the sas_token parameter of any BlobService. |
| generate_container_shared_access_signature |
Generates a shared access signature for the container. Use the returned signature with the sas_token parameter of any BlobService. |
| get_blob_account_information |
Gets information related to the storage account. The information can also be retrieved if the user has a SAS to a container or blob. |
| get_blob_metadata |
Returns all user-defined metadata for the specified blob or snapshot. |
| get_blob_properties |
Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. Returns Blob with BlobProperties and a metadata dict. |
| get_blob_service_properties |
Gets the properties of a storage account's Blob service, including Azure Storage Analytics. |
| get_blob_service_stats |
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. |
| get_blob_to_bytes |
Downloads a blob as an array of bytes, with automatic chunking and progress notifications. Returns an instance of Blob with properties, metadata, and content. |
| get_blob_to_path |
Downloads a blob to a file path, with automatic chunking and progress notifications. Returns an instance of Blob with properties and metadata. |
| get_blob_to_stream |
Downloads a blob to a stream, with automatic chunking and progress notifications. Returns an instance of Blob with properties and metadata. |
| get_blob_to_text |
Downloads a blob as unicode text, with automatic chunking and progress notifications. Returns an instance of Blob with properties, metadata, and content. |
| get_block_list |
Retrieves the list of blocks that have been uploaded as part of a block blob. There are two block lists maintained for a blob: Committed Block List: The list of blocks that have been successfully committed to a given blob with Put Block List. Uncommitted Block List: The list of blocks that have been uploaded for a blob using Put Block, but that have not yet been committed. These blocks are stored in Azure in association with a blob, but do not yet form part of the blob. |
| get_container_acl |
Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly. |
| get_container_metadata |
Returns all user-defined metadata for the specified container. |
| get_container_properties |
Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs. |
| get_user_delegation_key |
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. |
| list_blob_names |
Returns a generator to list the blob names under the specified container. The generator will lazily follow the continuation tokens returned by the service and stop when all blobs have been returned or num_results is reached. If num_results is specified and the account has more than that number of blobs, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired. |
| list_blobs |
Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service and stop when all blobs have been returned or num_results is reached. If num_results is specified and the account has more than that number of blobs, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired. |
| list_containers |
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 or num_results is reached. If num_results is specified and the account has more than that number of containers, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired. |
| make_blob_url |
Creates the url to access a blob. |
| make_container_url |
Creates the url to access a container. |
| put_block |
Creates a new block to be committed as part of a blob. |
| put_block_from_url |
Creates a new block to be committed as part of a blob. |
| put_block_list |
Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation. You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to. |
| release_blob_lease |
Releases the lease. The lease may be released if the lease ID specified on the request matches that associated with the blob. Releasing the lease allows another client to immediately acquire the lease for the blob as soon as the release is complete. |
| release_container_lease |
Release the lease. The lease may be released if the lease_id specified matches that associated with the container. Releasing the lease allows another client to immediately acquire the lease for the container as soon as the release is complete. |
| renew_blob_lease |
Renews the lease. The lease can be renewed if the lease ID specified on the request matches that associated with the blob. Note that the lease may be renewed even if it has expired as long as the blob has not been modified or leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets. |
| renew_container_lease |
Renews the lease. The lease can be renewed if the lease ID specified matches that associated with the container. Note that the lease may be renewed even if it has expired as long as the container has not been leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets. |
| set_blob_metadata |
Sets user-defined metadata for the specified blob as one or more name-value pairs. |
| set_blob_properties |
Sets system properties on the blob. If one property is set for the content_settings, all properties will be overriden. |
| set_blob_service_properties |
Sets the properties of a storage account's Blob service, including Azure Storage Analytics. If an element (ex Logging) is left as None, the existing settings on the service for that functionality are preserved. |
| set_container_acl |
Sets the permissions for the specified container or stored access policies that may be used with Shared Access Signatures. The permissions indicate whether blobs in a container may be accessed publicly. |
| set_container_metadata |
Sets one or more user-defined name-value pairs for the specified container. Each call to this operation replaces all existing metadata attached to the container. To remove all metadata from the container, call this operation with no metadata dict. |
| set_proxy |
Sets the proxy server host and port for the HTTP CONNECT Tunnelling. |
| set_standard_blob_tier |
Sets the block blob tiers on the blob. This API is only supported for block blobs on standard storage accounts. :param RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob |
| snapshot_blob |
Creates a read-only snapshot of a blob. |
| undelete_blob |
The undelete Blob operation restores the contents and metadata of soft deleted blob or snapshot. Attempting to undelete a blob or snapshot that is not soft deleted will succeed without any changes. |
abort_copy_blob
Aborts a pending copy_blob operation, and leaves a destination blob with zero length and full metadata.
abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of destination container. |
|
blob_name
Required
|
Name of destination blob. |
|
copy_id
Required
|
Copy identifier provided in the copy.id of the original copy_blob operation. |
|
lease_id
|
Required if the destination blob has an active infinite lease. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
acquire_blob_lease
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 ID.
acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
lease_duration
|
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). default value: -1
|
|
proposed_lease_id
|
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. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
str |
acquire_container_lease
Requests a new lease. If the container does not have an active lease, the Blob service creates a lease on the container and returns a new lease ID.
acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_duration
|
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). default value: -1
|
|
proposed_lease_id
|
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. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
str |
batch_delete_blobs
Sends a batch of multiple blob delete requests.
The blob delete method deletes the specified blob or snapshot. Note that deleting a blob also deletes all its snapshots. For more information, see https://docs.microsoft.com/rest/api/storageservices/delete-blob
batch_delete_blobs(batch_delete_sub_requests, timeout=None)Parameters
| Name | Description |
|---|---|
|
batch_delete_sub_requests
Required
|
The blob delete requests to send as a batch. |
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
parsed batch delete HTTP response |
batch_set_standard_blob_tier
Sends a batch of multiple set block blob tiers requests. This API is only supported for block blobs on standard storage accounts.
batch_set_standard_blob_tier(batch_set_blob_tier_sub_requests, timeout=None)Parameters
| Name | Description |
|---|---|
|
batch_set_blob_tier_sub_requests
Required
|
The set block blob tier requests to send as a batch. |
|
timeout
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
parsed batch set tier HTTP response which indicates if each sub-request is successful. |
break_blob_lease
Breaks the lease, if the 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 blob. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired.
A lease that has been broken can also be released, in which case another client may immediately acquire the lease on the blob.
break_blob_lease(container_name, blob_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
lease_break_period
|
For a break operation, 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. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
int |
break_container_lease
Break the lease, if the container 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. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired.
break_container_lease(container_name, lease_break_period=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_break_period
|
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. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
int |
change_blob_lease
Changes the lease ID of an active lease. A change must include the current lease ID and a new lease ID.
change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
lease_id
Required
|
Required if the blob has an active lease. |
|
proposed_lease_id
Required
|
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
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
change_container_lease
Change the lease ID of an active lease. A change must include the current lease ID and a new lease ID.
change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
Required
|
Lease ID for active lease. |
|
proposed_lease_id
Required
|
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
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
copy_blob
Copies a blob. This operation returns a copy operation properties object. The copy operation may be configured to either be an asynchronous, best-effort operation, or a synchronous operation.
The source must be a block blob if requires_sync is true. Any existing destination blob will be overwritten. The destination blob cannot be modified while a copy operation is in progress.
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.
You can call get_blob_properties on the destination blob to check the status of the copy operation. The final blob will be committed when the copy completes.
Name of the destination container. The container must exist. :param str blob_name: Name of the destination blob. If the destination blob exists, it will be overwritten. Otherwise, it will be created. :param str copy_source: A URL of up to 2 KB in length that specifies an Azure 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= https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken :param metadata: 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. :type metadata: dict(str, str) :param datetime source_if_modified_since: 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. :param datetime source_if_unmodified_since: 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. :param ETag source_if_match: An ETag value, or the wildcard character (). Specify this conditional header to copy the source blob only if its ETag matches the value specified. If the ETag values do not match, the Blob service returns status code 412 (Precondition Failed). This header cannot be specified if the source is an Azure File. :param ETag source_if_none_match: An ETag value, or the wildcard character (). Specify this conditional header to copy the blob only if its ETag does not match the value specified. If the values are identical, the Blob service returns status code 412 (Precondition Failed). This header cannot be specified if the source is an Azure File. :param datetime destination_if_modified_since: 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). :param datetime destination_if_unmodified_since: 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). :param ETag destination_if_match: An ETag value, or the wildcard character (). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value matches the ETag value for an existing destination blob. If the ETag for the destination blob does not match the ETag specified for If-Match, the Blob service returns status code 412 (Precondition Failed). :param ETag destination_if_none_match: An ETag value, or the wildcard character (). Specify an ETag value for this conditional header to copy the blob only if the specified ETag value does not match the ETag value for the destination blob. Specify the wildcard character (*) to perform the operation only if the destination blob does not exist. If the specified condition isn't met, the Blob service returns status code 412 (Precondition Failed). :param str destination_lease_id: 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). :param str source_lease_id: Specify this to perform the Copy Blob operation only if the lease ID given matches the active lease ID of the source blob. :param int timeout: The timeout parameter is expressed in seconds. :param bool requires_sync: Enforces that the service will not return a response until the copy is complete. :param StandardBlobTier standard_blob_tier: 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. :param RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob :return: Copy operation properties such as status, source, and ID. :rtype: CopyProperties
copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, timeout=None, requires_sync=None, standard_blob_tier=None, rehydrate_priority=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
|
|
blob_name
Required
|
|
|
copy_source
Required
|
|
|
metadata
|
default value: None
|
|
source_if_modified_since
|
default value: None
|
|
source_if_unmodified_since
|
default value: None
|
|
source_if_match
|
default value: None
|
|
source_if_none_match
|
default value: None
|
|
destination_if_modified_since
|
default value: None
|
|
destination_if_unmodified_since
|
default value: None
|
|
destination_if_match
|
default value: None
|
|
destination_if_none_match
|
default value: None
|
|
destination_lease_id
|
default value: None
|
|
source_lease_id
|
default value: None
|
|
timeout
|
default value: None
|
|
requires_sync
|
default value: None
|
|
standard_blob_tier
|
default value: None
|
|
rehydrate_priority
|
default value: None
|
create_blob_from_bytes
Creates a new blob from an array of bytes, or updates the content of an existing blob, with automatic chunking and progress notifications.
create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob to create or update. |
|
blob
Required
|
Content of blob as an array of bytes. |
|
index
|
Start index in the array of bytes. default value: 0
|
|
count
|
Number of bytes to upload. Set to None or negative value to upload all bytes starting from index. default value: None
|
|
content_settings
|
ContentSettings object used to set blob properties. default value: None
|
|
metadata
|
Name-value pairs associated with the blob as metadata. default value: None
|
|
validate_content
|
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. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob, or None if the total size is unknown. default value: None
|
|
max_connections
|
Maximum number of parallel connections to use when the blob size exceeds 64MB. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
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. default value: None
|
|
standard_blob_tier
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the Block Blob |
create_blob_from_path
Creates a new blob from a file path, or updates the content of an existing blob, with automatic chunking and progress notifications.
create_blob_from_path(container_name, blob_name, file_path, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob to create or update. |
|
file_path
Required
|
Path of the file to upload as the blob content. |
|
content_settings
|
ContentSettings object used to set blob properties. default value: None
|
|
metadata
|
Name-value pairs associated with the blob as metadata. default value: None
|
|
validate_content
|
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. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob, or None if the total size is unknown. default value: None
|
|
max_connections
|
Maximum number of parallel connections to use when the blob size exceeds 64MB. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
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. default value: None
|
|
standard_blob_tier
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the Block Blob |
create_blob_from_stream
Creates a new blob from a file/stream, or updates the content of an existing blob, with automatic chunking and progress notifications.
create_blob_from_stream(container_name, blob_name, stream, count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, use_byte_buffer=False, standard_blob_tier=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob to create or update. |
|
stream
Required
|
Opened file/stream to upload as the blob content. |
|
count
|
Number of bytes to read from the stream. This is optional, but should be supplied for optimal performance. default value: None
|
|
content_settings
|
ContentSettings object used to set blob properties. default value: None
|
|
metadata
|
Name-value pairs associated with the blob as metadata. default value: None
|
|
validate_content
|
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. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob, or None if the total size is unknown. default value: None
|
|
max_connections
|
Maximum number of parallel connections to use when the blob size exceeds 64MB. Note that parallel upload requires the stream to be seekable. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
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. default value: None
|
|
use_byte_buffer
|
If True, this will force usage of the original full block buffering upload path. By default, this value is False and will employ a memory-efficient, streaming upload algorithm under the following conditions: The provided stream is seekable, 'require_encryption' is False, and MAX_BLOCK_SIZE >= MIN_LARGE_BLOCK_UPLOAD_THRESHOLD. One should consider the drawbacks of using this approach. In order to achieve memory-efficiency, a IOBase stream or file-like object is segmented into logical blocks using a SubStream wrapper. In order to read the correct data, each SubStream must acquire a lock so that it can safely seek to the right position on the shared, underlying stream. If max_connections > 1, the concurrency will result in a considerable amount of seeking on the underlying stream. For the most common inputs such as a file-like stream object, seeking is an inexpensive operation and this is not much of a concern. However, for other variants of streams this may not be the case. The trade-off for memory-efficiency must be weighed against the cost of seeking with your input stream. The SubStream class will attempt to buffer up to 4 MB internally to reduce the amount of seek and read calls to the underlying stream. This is particularly beneficial when uploading larger blocks. default value: False
|
|
standard_blob_tier
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the Block Blob |
create_blob_from_text
Creates a new blob from str/unicode, or updates the content of an existing blob, with automatic chunking and progress notifications.
create_blob_from_text(container_name, blob_name, text, encoding='utf-8', content_settings=None, metadata=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob to create or update. |
|
text
Required
|
Text to upload to the blob. |
|
encoding
|
Python encoding to use to convert the text to bytes. default value: utf-8
|
|
content_settings
|
ContentSettings object used to set blob properties. default value: None
|
|
metadata
|
Name-value pairs associated with the blob as metadata. default value: None
|
|
validate_content
|
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. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob, or None if the total size is unknown. default value: None
|
|
max_connections
|
Maximum number of parallel connections to use when the blob size exceeds 64MB. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
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. default value: None
|
|
standard_blob_tier
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the Block Blob |
create_container
Creates a new container under the specified account. If the container with the same name already exists, the operation fails if fail_on_exist is True.
create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container to create. The container name may only contain lowercase letters, numbers, and hyphens, and must begin with a letter or a number. Each hyphen must be preceded and followed by a non-hyphen character. The name must also be between 3 and 63 characters long. |
|
metadata
|
A dict with name_value pairs to associate with the container as metadata. Example:{'Category':'test'} default value: None
|
|
public_access
|
Possible values include: container, blob. default value: None
|
|
fail_on_exist
|
Specify whether to throw an exception when the container exists. default value: False
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
True if container is created, False if container already exists. |
delete_blob
Marks the specified blob or snapshot for deletion. The blob is later deleted during garbage collection.
Note that in order to delete a blob, you must delete all of its snapshots. You can delete both at the same time with the Delete Blob operation.
If a delete retention policy is enabled for the service, then this operation soft deletes the blob or snapshot and retains the blob or snapshot for specified number of days. After specified number of days, blob's data is removed from the service during garbage collection. Soft deleted blob or snapshot is accessible through List Blobs API specifying include=Include.Deleted option. Soft-deleted blob or snapshot can be restored using Undelete API.
delete_blob(container_name, blob_name, snapshot=None, lease_id=None, delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to delete. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
delete_snapshots
|
Required if the blob has associated snapshots. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
delete_container
Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection.
delete_container(container_name, fail_not_exist=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container to delete. |
|
fail_not_exist
|
Specify whether to throw an exception when the container doesn't exist. default value: False
|
|
lease_id
|
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. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
True if container is deleted, False container doesn't exist. |
exists
Returns a boolean indicating whether the container exists (if blob_name is None), or otherwise a boolean indicating whether the blob exists.
exists(container_name, blob_name=None, snapshot=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of a container. |
|
blob_name
|
Name of a blob. If None, the container will be checked for existence. default value: None
|
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the snapshot. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
A boolean indicating whether the resource exists. |
extract_date_and_request_id
static extract_date_and_request_id(retry_context)Parameters
| Name | Description |
|---|---|
|
retry_context
Required
|
|
generate_account_shared_access_signature
Generates a shared access signature for the blob service. Use the returned signature with the sas_token parameter of any BlobService.
generate_account_shared_access_signature(resource_types, permission, expiry, start=None, ip=None, protocol=None)Parameters
| Name | Description |
|---|---|
|
resource_types
Required
|
<xref:ResourceTypes>
Specifies the resource types that are accessible with the account SAS. |
|
permission
Required
|
<xref:AccountPermissions>
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
Required
|
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
|
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. default value: None
|
|
ip
|
Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses. default value: None
|
|
protocol
|
Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Shared Access Signature (sas) token. |
generate_blob_shared_access_signature
Generates a shared access signature for the blob or one of its snapshots. Use the returned signature with the sas_token parameter of any BlobService.
generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container. |
|
blob_name
Required
|
Name of blob. |
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to grant permission. default value: None
|
|
permission
|
The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Permissions must be ordered read, write, delete, list. 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. default value: None
|
|
expiry
|
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. default value: None
|
|
start
|
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. default value: None
|
|
id
|
A unique value up to 64 characters in length that correlates to a stored access policy. To create a stored access policy, use set_container_acl. default value: None
|
|
ip
|
Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses. default value: None
|
|
protocol
|
Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values. default value: None
|
|
cache_control
|
Response header value for Cache-Control when resource is accessed using this shared access signature. default value: None
|
|
content_disposition
|
Response header value for Content-Disposition when resource is accessed using this shared access signature. default value: None
|
|
content_encoding
|
Response header value for Content-Encoding when resource is accessed using this shared access signature. default value: None
|
|
content_language
|
Response header value for Content-Language when resource is accessed using this shared access signature. default value: None
|
|
content_type
|
Response header value for Content-Type when resource is accessed using this shared access signature. default value: None
|
|
user_delegation_key
|
Instead of an account key, the user could pass in a user delegation key. A user delegation key can be obtained from the service by authenticating with an AAD identity; this can be accomplished by calling get_user_delegation_key. When present, the SAS is signed with the user delegation key instead. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Shared Access Signature (sas) token. |
generate_container_shared_access_signature
Generates a shared access signature for the container. Use the returned signature with the sas_token parameter of any BlobService.
generate_container_shared_access_signature(container_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None, user_delegation_key=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container. |
|
permission
|
The permissions associated with the shared access signature. The user is restricted to operations allowed by the permissions. Permissions must be ordered read, write, delete, list. 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. default value: None
|
|
expiry
|
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. default value: None
|
|
start
|
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. default value: None
|
|
id
|
A unique value up to 64 characters in length that correlates to a stored access policy. To create a stored access policy, use set_blob_service_properties. default value: None
|
|
ip
|
Specifies an IP address or a range of IP addresses from which to accept requests. If the IP address from which the request originates does not match the IP address or address range specified on the SAS token, the request is not authenticated. For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS restricts the request to those IP addresses. default value: None
|
|
protocol
|
Specifies the protocol permitted for a request made. The default value is https,http. See Protocol for possible values. default value: None
|
|
cache_control
|
Response header value for Cache-Control when resource is accessed using this shared access signature. default value: None
|
|
content_disposition
|
Response header value for Content-Disposition when resource is accessed using this shared access signature. default value: None
|
|
content_encoding
|
Response header value for Content-Encoding when resource is accessed using this shared access signature. default value: None
|
|
content_language
|
Response header value for Content-Language when resource is accessed using this shared access signature. default value: None
|
|
content_type
|
Response header value for Content-Type when resource is accessed using this shared access signature. default value: None
|
|
user_delegation_key
|
Instead of an account key, the user could pass in a user delegation key. A user delegation key can be obtained from the service by authenticating with an AAD identity; this can be accomplished by calling get_user_delegation_key. When present, the SAS is signed with the user delegation key instead. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Shared Access Signature (sas) token. |
get_blob_account_information
Gets information related to the storage account. The information can also be retrieved if the user has a SAS to a container or blob.
get_blob_account_information(container_name=None, blob_name=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
|
Name of existing container. Optional, unless using a SAS token to a specific container or blob, in which case it's required. default value: None
|
|
blob_name
|
Name of existing blob. Optional, unless using a SAS token to a specific blob, in which case it's required. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
The AccountInformation. |
get_blob_metadata
Returns all user-defined metadata for the specified blob or snapshot.
get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
snapshot
|
The snapshot parameter is an opaque value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
A dictionary representing the blob metadata name, value pairs. |
get_blob_properties
Returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. Returns Blob with BlobProperties and a metadata dict.
get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
a blob object including properties and metadata. |
get_blob_service_properties
Gets the properties of a storage account's Blob service, including Azure Storage Analytics.
get_blob_service_properties(timeout=None)Parameters
| Name | Description |
|---|---|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
The blob ServiceProperties with an attached target_version property. |
get_blob_service_stats
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.
get_blob_service_stats(timeout=None)Parameters
| Name | Description |
|---|---|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
The blob service stats. |
get_blob_to_bytes
Downloads a blob as an array of bytes, with automatic chunking and progress notifications. Returns an instance of Blob with properties, metadata, and content.
get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
start_range
|
Start of byte range to use for downloading a section of the blob. If no end_range is given, all bytes after the start_range will be downloaded. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
end_range
|
End of byte range to use for downloading a section of the blob. If end_range is given, start_range must be provided. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
validate_content
|
If set to true, validates an MD5 hash for each retrieved portion of the blob. 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 the service will only return transactional MD5s for chunks 4MB or less so the first get request will be of size self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be thrown. As computing the MD5 takes processing time and more requests will need to be done due to the reduced chunk size there may be some increase in latency. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob if known. default value: None
|
|
max_connections
|
If set to 2 or greater, an initial get will be done for the first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, the method returns at this point. If it is not, it will download the remaining data parallel using the number of threads equal to max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request will be done. This is not generally recommended but available if very few threads should be used, network requests are very expensive, or a non-seekable stream prevents parallel download. This may also be useful if many blobs are expected to be empty as an extra request is required for empty blobs if max_connections is greater than 1. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Blob with properties and metadata. If max_connections is greater than 1, the content_md5 (if set on the blob) will not be returned. If you require this value, either use get_blob_properties or set max_connections to 1. |
get_blob_to_path
Downloads a blob to a file path, with automatic chunking and progress notifications. Returns an instance of Blob with properties and metadata.
get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
file_path
Required
|
Path of file to write out to. |
|
open_mode
|
Mode to use when opening the file. Note that specifying append only open_mode prevents parallel download. So, max_connections must be set to 1 if this open_mode is used. default value: wb
|
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
start_range
|
Start of byte range to use for downloading a section of the blob. If no end_range is given, all bytes after the start_range will be downloaded. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
end_range
|
End of byte range to use for downloading a section of the blob. If end_range is given, start_range must be provided. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
validate_content
|
If set to true, validates an MD5 hash for each retrieved portion of the blob. 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 the service will only return transactional MD5s for chunks 4MB or less so the first get request will be of size self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be thrown. As computing the MD5 takes processing time and more requests will need to be done due to the reduced chunk size there may be some increase in latency. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob if known. default value: None
|
|
max_connections
|
If set to 2 or greater, an initial get will be done for the first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, the method returns at this point. If it is not, it will download the remaining data parallel using the number of threads equal to max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request will be done. This is not generally recommended but available if very few threads should be used, network requests are very expensive, or a non-seekable stream prevents parallel download. This may also be useful if many blobs are expected to be empty as an extra request is required for empty blobs if max_connections is greater than 1. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Blob with properties and metadata. If max_connections is greater than 1, the content_md5 (if set on the blob) will not be returned. If you require this value, either use get_blob_properties or set max_connections to 1. |
get_blob_to_stream
Downloads a blob to a stream, with automatic chunking and progress notifications. Returns an instance of Blob with properties and metadata.
get_blob_to_stream(container_name, blob_name, stream, snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
stream
Required
|
Opened stream to write to. |
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
start_range
|
Start of byte range to use for downloading a section of the blob. If no end_range is given, all bytes after the start_range will be downloaded. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
end_range
|
End of byte range to use for downloading a section of the blob. If end_range is given, start_range must be provided. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
validate_content
|
If set to true, validates an MD5 hash for each retrieved portion of the blob. 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 the service will only return transactional MD5s for chunks 4MB or less so the first get request will be of size self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be thrown. As computing the MD5 takes processing time and more requests will need to be done due to the reduced chunk size there may be some increase in latency. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob if known. default value: None
|
|
max_connections
|
If set to 2 or greater, an initial get will be done for the first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, the method returns at this point. If it is not, it will download the remaining data parallel using the number of threads equal to max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request will be done. This is not generally recommended but available if very few threads should be used, network requests are very expensive, or a non-seekable stream prevents parallel download. This may also be useful if many blobs are expected to be empty as an extra request is required for empty blobs if max_connections is greater than 1. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Blob with properties and metadata. If max_connections is greater than 1, the content_md5 (if set on the blob) will not be returned. If you require this value, either use get_blob_properties or set max_connections to 1. |
get_blob_to_text
Downloads a blob as unicode text, with automatic chunking and progress notifications. Returns an instance of Blob with properties, metadata, and content.
get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
encoding
|
Python encoding to use when decoding the blob data. default value: utf-8
|
|
snapshot
|
The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. default value: None
|
|
start_range
|
Start of byte range to use for downloading a section of the blob. If no end_range is given, all bytes after the start_range will be downloaded. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
end_range
|
End of byte range to use for downloading a section of the blob. If end_range is given, start_range must be provided. The start_range and end_range params are inclusive. Ex: start_range=0, end_range=511 will download first 512 bytes of blob. default value: None
|
|
validate_content
|
If set to true, validates an MD5 hash for each retrieved portion of the blob. 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 the service will only return transactional MD5s for chunks 4MB or less so the first get request will be of size self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be thrown. As computing the MD5 takes processing time and more requests will need to be done due to the reduced chunk size there may be some increase in latency. default value: False
|
|
progress_callback
|
<xref:func>(<xref:current>, <xref:total>)
Callback for progress with signature function(current, total) where current is the number of bytes transfered so far, and total is the size of the blob if known. default value: None
|
|
max_connections
|
If set to 2 or greater, an initial get will be done for the first self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, the method returns at this point. If it is not, it will download the remaining data parallel using the number of threads equal to max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. If set to 1, a single large get request will be done. This is not generally recommended but available if very few threads should be used, network requests are very expensive, or a non-seekable stream prevents parallel download. This may also be useful if many blobs are expected to be empty as an extra request is required for empty blobs if max_connections is greater than 1. default value: 2
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
Decrypts 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. default value: None
|
|
timeout
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
A Blob with properties and metadata. If max_connections is greater than 1, the content_md5 (if set on the blob) will not be returned. If you require this value, either use get_blob_properties or set max_connections to 1. |
get_block_list
Retrieves the list of blocks that have been uploaded as part of a block blob. There are two block lists maintained for a blob:
Committed Block List: The list of blocks that have been successfully committed to a given blob with Put Block List.
Uncommitted Block List: The list of blocks that have been uploaded for a blob using Put Block, but that have not yet been committed. These blocks are stored in Azure in association with a blob, but do not yet form part of the blob.
get_block_list(container_name, blob_name, snapshot=None, block_list_type=None, lease_id=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
snapshot
|
Datetime to determine the time to retrieve the blocks. default value: None
|
|
block_list_type
|
Specifies whether to return the list of committed blocks, the list of uncommitted blocks, or both lists together. Valid values are: committed, uncommitted, or all. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
list committed and/or uncommitted blocks for Block Blob |
get_container_acl
Gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.
get_container_acl(container_name, lease_id=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
|
If specified, get_container_acl only succeeds if the container's lease is active and matches this ID. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
A dictionary of access policies associated with the container. dict of str to AccessPolicy and a public_access property if public access is turned on |
get_container_metadata
Returns all user-defined metadata for the specified container.
get_container_metadata(container_name, lease_id=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
|
If specified, get_container_metadata only succeeds if the container's lease is active and matches this ID. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
A dictionary representing the container metadata name, value pairs. |
get_container_properties
Returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs.
get_container_properties(container_name, lease_id=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
|
If specified, get_container_properties only succeeds if the container's lease is active and matches this ID. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
properties for the specified container within a container object. |
get_user_delegation_key
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.
get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)Parameters
| Name | Description |
|---|---|
|
key_start_time
Required
|
A DateTime value. Indicates when the key becomes valid. |
|
key_expiry_time
Required
|
A DateTime value. Indicates when the key stops being valid. |
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
The user delegation key. |
list_blob_names
Returns a generator to list the blob names under the specified container. The generator will lazily follow the continuation tokens returned by the service and stop when all blobs have been returned or num_results is reached.
If num_results is specified and the account has more than that number of blobs, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.
list_blob_names(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
prefix
|
Filters the results to return only blobs whose names begin with the specified prefix. default value: None
|
|
num_results
|
Specifies the maximum number of blobs to return, including all <xref:azure.storage.blob.blockblobservice.BlobPrefix> elements. If the request does not specify num_results or specifies a value greater than 5,000, the server will return up to 5,000 items. Setting num_results to a value less than or equal to zero results in error response code 400 (Bad Request). default value: None
|
|
include
|
Specifies one or more additional datasets to include in the response. default value: None
|
|
delimiter
|
When the request includes this parameter, the operation returns a BlobPrefix element in the result list that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. default value: None
|
|
marker
|
An opaque continuation token. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
list_blobs
Returns a generator to list the blobs under the specified container. The generator will lazily follow the continuation tokens returned by the service and stop when all blobs have been returned or num_results is reached.
If num_results is specified and the account has more than that number of blobs, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.
list_blobs(container_name, prefix=None, num_results=None, include=None, delimiter=None, marker=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
prefix
|
Filters the results to return only blobs whose names begin with the specified prefix. default value: None
|
|
num_results
|
Specifies the maximum number of blobs to return, including all <xref:azure.storage.blob.blockblobservice.BlobPrefix> elements. If the request does not specify num_results or specifies a value greater than 5,000, the server will return up to 5,000 items. Setting num_results to a value less than or equal to zero results in error response code 400 (Bad Request). default value: None
|
|
include
|
Specifies one or more additional datasets to include in the response. default value: None
|
|
delimiter
|
When the request includes this parameter, the operation returns a BlobPrefix element in the result list that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string. default value: None
|
|
marker
|
An opaque continuation token. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
list_containers
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 or num_results is reached.
If num_results is specified and the account has more than that number of containers, the generator will have a populated next_marker field once it finishes. This marker can be used to create a new generator if more results are desired.
list_containers(prefix=None, num_results=None, include_metadata=False, marker=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
prefix
|
Filters the results to return only containers whose names begin with the specified prefix. default value: None
|
|
num_results
|
Specifies the maximum number of containers to return. A single list request may return up to 1000 contianers and potentially a continuation token which should be followed to get additional resutls. default value: None
|
|
include_metadata
|
Specifies that container metadata be returned in the response. default value: False
|
|
marker
|
An opaque continuation token. This value can be retrieved from the next_marker field of a previous generator object if num_results was specified and that generator has finished enumerating results. If specified, this generator will begin returning results from the point where the previous generator stopped. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
make_blob_url
Creates the url to access a blob.
make_blob_url(container_name, blob_name, protocol=None, sas_token=None, snapshot=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container. |
|
blob_name
Required
|
Name of blob. |
|
protocol
|
Protocol to use: 'http' or 'https'. If not specified, uses the protocol specified when BaseBlobService was initialized. default value: None
|
|
sas_token
|
Shared access signature token created with generate_shared_access_signature. default value: None
|
|
snapshot
|
An string value that uniquely identifies the snapshot. The value of this query parameter indicates the snapshot version. default value: None
|
Returns
| Type | Description |
|---|---|
|
blob access URL. |
make_container_url
Creates the url to access a container.
make_container_url(container_name, protocol=None, sas_token=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of container. |
|
protocol
|
Protocol to use: 'http' or 'https'. If not specified, uses the protocol specified when BaseBlobService was initialized. default value: None
|
|
sas_token
|
Shared access signature token created with generate_shared_access_signature. default value: None
|
Returns
| Type | Description |
|---|---|
|
container access URL. |
put_block
Creates a new block to be committed as part of a blob.
put_block(container_name, blob_name, block, block_id, validate_content=False, lease_id=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob. |
|
block
Required
|
Content of the block. |
|
block_id
Required
|
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. |
|
validate_content
|
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. default value: False
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
put_block_from_url
Creates a new block to be committed as part of a blob.
put_block_from_url(container_name, blob_name, copy_source_url, block_id, source_range_start=None, source_range_end=None, source_content_md5=None, lease_id=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob. |
|
copy_source_url
Required
|
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_range_start
|
This indicates the start of the range of bytes(inclusive) that has to be taken from the copy source. default value: None
|
|
source_range_end
|
This indicates the end of the range of bytes(inclusive) that has to be taken from the copy source. default value: None
|
|
block_id
Required
|
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_content_md5
|
If given, the service will calculate the MD5 hash of the block content and compare against this value. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
put_block_list
Writes a blob by specifying the list of block IDs that make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior Put Block operation.
You can call Put Block List to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. You can do this by specifying whether to commit a block from the committed block list or from the uncommitted block list, or to commit the most recently uploaded version of the block, whichever list it may belong to.
put_block_list(container_name, blob_name, block_list, content_settings=None, metadata=None, validate_content=False, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
block_list
Required
|
list(BlobBlock)
A list of <xref:azure.storeage.blob.models.BlobBlock> containing the block ids and block state. |
|
content_settings
|
ContentSettings object used to set properties on the blob. default value: None
|
|
metadata
|
Name-value pairs associated with the blob as metadata. default value: None
|
|
validate_content
|
If true, calculates an MD5 hash of the block list content. The storage service checks the hash of the block list 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 check is associated with the block list content, and not with the content of the blob itself. default value: False
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
|
standard_blob_tier
|
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. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the updated Block Blob |
release_blob_lease
Releases the lease. The lease may be released if the lease ID specified on the request matches that associated with the blob. Releasing the lease allows another client to immediately acquire the lease for the blob as soon as the release is complete.
release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
lease_id
Required
|
Lease ID for active lease. |
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
release_container_lease
Release the lease. The lease may be released if the lease_id specified matches that associated with the container. Releasing the lease allows another client to immediately acquire the lease for the container as soon as the release is complete.
release_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
Required
|
Lease ID for active lease. |
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
renew_blob_lease
Renews the lease. The lease can be renewed if the lease ID specified on the request matches that associated with the blob. Note that the lease may be renewed even if it has expired as long as the blob has not been modified or leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets.
renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
lease_id
Required
|
Lease ID for active lease. |
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
str |
renew_container_lease
Renews the lease. The lease can be renewed if the lease ID specified matches that associated with the container. Note that the lease may be renewed even if it has expired as long as the container has not been leased again since the expiration of that lease. When you renew a lease, the lease duration clock resets.
renew_container_lease(container_name, lease_id, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
lease_id
Required
|
Lease ID for active lease. |
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
str |
set_blob_metadata
Sets user-defined metadata for the specified blob as one or more name-value pairs.
set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
metadata
|
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. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the updated Blob |
set_blob_properties
Sets system properties on the blob. If one property is set for the content_settings, all properties will be overriden.
set_blob_properties(container_name, blob_name, content_settings=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
content_settings
|
ContentSettings object used to set blob properties. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the updated Blob |
set_blob_service_properties
Sets the properties of a storage account's Blob service, including Azure Storage Analytics. If an element (ex Logging) is left as None, the existing settings on the service for that functionality are preserved.
set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)Parameters
| Name | Description |
|---|---|
|
logging
|
Groups the Azure Analytics Logging settings. default value: None
|
|
hour_metrics
|
The hour metrics settings provide a summary of request statistics grouped by API in hourly aggregates for blobs. default value: None
|
|
minute_metrics
|
The minute metrics settings provide request statistics for each minute for blobs. default value: None
|
|
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. default value: None
|
|
target_version
|
Indicates the default version to use for requests if an incoming request's version is not specified. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
|
delete_retention_policy
|
The delete retention policy specifies whether to retain deleted blobs. It also specifies the number of days and versions of blob to keep. default value: None
|
|
static_website
|
Specifies whether the static website feature is enabled, and if yes, indicates the index document and 404 error document to use. default value: None
|
set_container_acl
Sets the permissions for the specified container or stored access policies that may be used with Shared Access Signatures. The permissions indicate whether blobs in a container may be accessed publicly.
set_container_acl(container_name, signed_identifiers=None, public_access=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
signed_identifiers
|
dict(str, AccessPolicy)
A dictionary of access policies to associate with the container. The dictionary may contain up to 5 elements. An empty dictionary will clear the access policies set on the service. default value: None
|
|
public_access
|
Possible values include: container, blob. default value: None
|
|
lease_id
|
If specified, set_container_acl only succeeds if the container's lease is active and matches this ID. default value: None
|
|
if_modified_since
|
A datetime value. Azure expects the date value passed in to be UTC. If timezone is included, any non-UTC datetimes will be converted to UTC. If a date is passed in without timezone info, it is assumed to be UTC. Specify this header to perform the operation only if the resource has been modified since the specified date/time. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the updated Container |
set_container_metadata
Sets one or more user-defined name-value pairs for the specified container. Each call to this operation replaces all existing metadata attached to the container. To remove all metadata from the container, call this operation with no metadata dict.
set_container_metadata(container_name, metadata=None, lease_id=None, if_modified_since=None, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
metadata
|
A dict containing name-value pairs to associate with the container as metadata. Example: {'category':'test'} default value: None
|
|
lease_id
|
If specified, set_container_metadata only succeeds if the container's lease is active and matches this ID. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
ETag and last modified properties for the updated Container |
set_proxy
Sets the proxy server host and port for the HTTP CONNECT Tunnelling.
set_proxy(host, port, user=None, password=None)Parameters
| Name | Description |
|---|---|
|
host
Required
|
Address of the proxy. Ex: '192.168.0.100' |
|
port
Required
|
Port of the proxy. Ex: 6000 |
|
user
|
User for proxy authorization. default value: None
|
|
password
|
Password for proxy authorization. default value: None
|
set_standard_blob_tier
Sets the block blob tiers on the blob. This API is only supported for block blobs on standard storage accounts.
:param RehydratePriority rehydrate_priority: Indicates the priority with which to rehydrate an archived blob
set_standard_blob_tier(container_name, blob_name, standard_blob_tier, timeout=None, rehydrate_priority=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of blob to update. |
|
standard_blob_tier
Required
|
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. |
|
timeout
|
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. default value: None
|
|
rehydrate_priority
|
default value: None
|
snapshot_blob
Creates a read-only snapshot of a blob.
snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, cpk=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
metadata
|
Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the base blob metadata to the snapshot. If one or more name-value pairs are specified, the snapshot is created with the specified metadata, and metadata is not copied from the base blob. default value: None
|
|
if_modified_since
|
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. default value: None
|
|
if_unmodified_since
|
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. default value: None
|
|
if_match
|
An ETag value, or the wildcard character (*). Specify this header to perform the operation only if the resource's ETag matches the value specified. default value: None
|
|
if_none_match
|
An ETag value, or the wildcard character (). Specify this header to perform the operation only if the resource's ETag does not match the value specified. Specify the wildcard character () to perform the operation only if the resource does not exist, and fail the operation if it does exist. default value: None
|
|
lease_id
|
Required if the blob has an active lease. default value: None
|
|
cpk
|
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. default value: None
|
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Returns
| Type | Description |
|---|---|
|
snapshot properties |
undelete_blob
The undelete Blob operation restores the contents and metadata of soft deleted blob or snapshot. Attempting to undelete a blob or snapshot that is not soft deleted will succeed without any changes.
undelete_blob(container_name, blob_name, timeout=None)Parameters
| Name | Description |
|---|---|
|
container_name
Required
|
Name of existing container. |
|
blob_name
Required
|
Name of existing blob. |
|
timeout
|
The timeout parameter is expressed in seconds. default value: None
|
Attributes
protocol
request_session
socket_timeout
MAX_BLOCK_SIZE
MAX_BLOCK_SIZE = 4194304MAX_CHUNK_GET_SIZE
MAX_CHUNK_GET_SIZE = 4194304MAX_SINGLE_GET_SIZE
MAX_SINGLE_GET_SIZE = 33554432MAX_SINGLE_PUT_SIZE
MAX_SINGLE_PUT_SIZE = 67108864MIN_LARGE_BLOCK_UPLOAD_THRESHOLD
MIN_LARGE_BLOCK_UPLOAD_THRESHOLD = 4194305
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for