AzureBlob Class

Properties   Methods   Events   Config Settings   Errors  

The AzureBlob class provides an easy to use interface to Microsoft's Azure Blob Storage service.

Syntax

class cloudstorage.AzureBlob

Remarks

The AzureBlob class offers an easy-to-use API for the Microsoft Azure Blob Storage service. Capabilities include uploading and downloading blobs of all types, strong encryption support, container management, and more.

Authentication

Authentication is simple, set the account property to the name of the Azure Storage account to operate against, and set the access_key property to an Azure access key associated with that account.

Alternatively, this class supports authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type. Typically, the following fields should be set to the below values:

Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the authorize method should be called. If the authorization and authentication was successful, then the o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the o_auth_access_token will be expired. When a method that makes requests to the service provider is called or the authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new o_auth_access_token. If the authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the o_auth_grant_type property. To force the component to only check the access token when the authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the o_auth_grant_type property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the o_auth_authorization_code property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the o_auth_refresh_token property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

blob.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; blob.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; blob.OAuth.ClientId = CLIENT_ID; blob.OAuth.ClientSecret = CLIENT_SECRET; blob.OAuth.AuthorizationScope = "https://{ACCOUNT}.blob.core.windows.net/user_impersonation"; blob.OAuth.ServerAuthURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize"; blob.OAuth.ServerTokenURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token"; blob.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this o_auth_grant_type the class requires OAuthPasswordGrantUsername, o_auth_client_secret, and o_auth_server_token_url to be set. The o_auth_client_secret should be set to the password of the account instead of a typical secret. In some cases, the o_auth_client_id also needs to be set. When the authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the authorization property before attempting any operations. Setting the authorization property will cause the class to ignore the values set in the o_auth property.

Consult the Azure Blob Storage service's documentation for more information about using OAuth authentication.

Usage

Once authenticated, you can start interacting with the Azure Blob Storage service. The following list shows some of the methods used to accomplish common tasks:

• Container management: list_containers, get_container_info, create_container, delete_container, get_container_acl, set_container_acl
• Blob management: list_blobs, get_blob_info, update_blob_info, create_blob, copy_blob, get_blob, delete_blob, undelete_blob
• Block blob management: list_blocks, put_block, put_block_list
• Page blob management: list_page_ranges, put_pages, clear_pages, update_page_blob
• Append blob management: append_block

The class support much more than just the functionality described above; refer to the complete API, below, for more information.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

access_key Property

The Azure access key to use for authentication.

Syntax

def get_access_key() -> str: ...
def set_access_key(value: str) -> None: ...

access_key = property(get_access_key, set_access_key)

Default Value

""

Remarks

This property specifies the Azure access key that should be used for authentication. It must be set before attempting any operations which connect to the server.

Both primary and secondary access keys are valid.

Note: this property's value is ignored if the authorization property is populated.

access_policy_count Property

The number of records in the AccessPolicy arrays.

Syntax

def get_access_policy_count() -> int: ...
def set_access_policy_count(value: int) -> None: ...

access_policy_count = property(get_access_policy_count, set_access_policy_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• access_policy_expiry_time
• access_policy_id
• access_policy_permissions
• access_policy_start_time

The array indices start at 0 and end at access_policy_count - 1.

access_policy_expiry_time Property

The expiry time of the access policy.

Syntax

def get_access_policy_expiry_time(access_policy_index: int) -> str: ...
def set_access_policy_expiry_time(access_policy_index: int, value: str) -> None: ...

Default Value

""

Remarks

The expiry time of the access policy.

This property specifies the UTC expiry time of the access policy, formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include an expiry time.

The access_policy_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_policy_count property.

access_policy_id Property

The unique Id of the access policy.

Syntax

def get_access_policy_id(access_policy_index: int) -> str: ...
def set_access_policy_id(access_policy_index: int, value: str) -> None: ...

Default Value

""

Remarks

The unique Id of the access policy.

This property specifies the unique Id of the access policy, which may be up to 64 characters in length.

The access_policy_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_policy_count property.

access_policy_permissions Property

The permissions that the access policy grants.

Syntax

def get_access_policy_permissions(access_policy_index: int) -> str: ...
def set_access_policy_permissions(access_policy_index: int, value: str) -> None: ...

Default Value

""

Remarks

The permissions that the access policy grants.

This property specifies the permissions that the access policy grants, in the form of an abbreviated permissions list formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include any permissions.

The access_policy_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_policy_count property.

access_policy_start_time Property

The start time of the access policy.

Syntax

def get_access_policy_start_time(access_policy_index: int) -> str: ...
def set_access_policy_start_time(access_policy_index: int, value: str) -> None: ...

Default Value

""

Remarks

The start time of the access policy.

This property specifies the UTC start time of the access policy, formatted according to this page in Azure's documentation.

This property can be empty if the access policy doesn't include a start time.

The access_policy_index parameter specifies the index of the item in the array. The size of the array is controlled by the access_policy_count property.

account Property

The Azure storage account name.

Syntax

def get_account() -> str: ...
def set_account(value: str) -> None: ...

account = property(get_account, set_account)

Default Value

""

Remarks

This property specifies the name of the Azure storage account to operate against. It must be set before attempting any operations which connect to the server.

authorization Property

OAuth 2.0 Authorization Token.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties, using the OAuth class or a separate process. If using the OAuth* properties, then the authorization property will not be used.

Bearer ACCESS_TOKEN

Note: if both this property and access_key are populated, this property takes precedence, and the class will use OAuth authentication instead of shared key authentication. The account property must be set in either case.

blob_data Property

The data that was downloaded, or that should be uploaded.

Syntax

def get_blob_data() -> bytes: ...
def set_blob_data(value: bytes) -> None: ...

blob_data = property(get_blob_data, set_blob_data)

Default Value

""

Remarks

This property is populated with blob data after calling get_blob if local_file is not set.

This property can also be set before calling append_block, create_blob (for block blobs), put_block, or put_pages; its data will be uploaded if local_file is not set.

blob_delimiter Property

The delimiter string to use when listing blobs.

Syntax

def get_blob_delimiter() -> str: ...
def set_blob_delimiter(value: str) -> None: ...

blob_delimiter = property(get_blob_delimiter, set_blob_delimiter)

Default Value

""

Remarks

If this property is non-empty when list_blobs is called, any blobs whose names contain the same string between the specified prefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual blobs themselves.

The on_prefix_list event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings

Blob Namespace Traversal

By using the blob_delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With blob_delimiter set to /, we can set prefix to successively "deeper" values before calling list_blobs for the following effect:

blob_marker Property

A marker indicating what page of blobs to return next.

Syntax

def get_blob_marker() -> str: ...
def set_blob_marker(value: str) -> None: ...

blob_marker = property(get_blob_marker, set_blob_marker)

Default Value

""

Remarks

This property will be populated when list_blobs is called if the results are paged and there are more pages. To list all blobs, continue to call list_blobs until this property returns empty string.

Refer to list_blobs for more information.

blob_count Property

The number of records in the Blob arrays.

Syntax

def get_blob_count() -> int: ...
def set_blob_count(value: int) -> None: ...

blob_count = property(get_blob_count, set_blob_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• blob_container
• blob_content_disposition
• blob_content_encoding
• blob_content_length
• blob_content_md5
• blob_content_type
• blob_created_time
• blob_e_tag
• blob_is_leased
• blob_is_lease_infinite
• blob_lease_state
• blob_modified_time
• blob_name
• blob_sequence_num
• blob_snapshot
• blob_soft_deleted
• blob_type

The array indices start at 0 and end at blob_count - 1.

blob_container Property

The container that the blob resides in.

Syntax

def get_blob_container(blob_index: int) -> str: ...

Default Value

""

Remarks

The container that the blob resides in.

This property reflects the name of the container that the blob resides in.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_content_disposition Property

The blob's content disposition.

Syntax

def get_blob_content_disposition(blob_index: int) -> str: ...
def set_blob_content_disposition(blob_index: int, value: str) -> None: ...

Default Value

""

Remarks

The blob's content disposition.

This property specifies the blob's content disposition.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

blob_content_encoding Property

The blob's content encoding.

Syntax

def get_blob_content_encoding(blob_index: int) -> str: ...
def set_blob_content_encoding(blob_index: int, value: str) -> None: ...

Default Value

""

Remarks

The blob's content encoding.

This property specifies the blob's content encoding. Always empty for uncommitted block blobs.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

blob_content_length Property

The size of the blob.

Syntax

def get_blob_content_length(blob_index: int) -> int: ...

Default Value

0

Remarks

The size of the blob.

For block blobs and append blobs, this property reflects the size of the blob's (committed) data, in bytes. For page blobs, this property reflects the blob's capacity in bytes.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_content_md5 Property

An MD5 hash of the blob's content.

Syntax

def get_blob_content_md5(blob_index: int) -> str: ...
def set_blob_content_md5(blob_index: int, value: str) -> None: ...

Default Value

""

Remarks

An MD5 hash of the blob's content.

This property specifies an MD5 hash of the blob's content. Always empty for uncommitted block blobs.

Note that the server generally won't calculate this value automatically.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

blob_content_type Property

The blob's content type.

Syntax

def get_blob_content_type(blob_index: int) -> str: ...
def set_blob_content_type(blob_index: int, value: str) -> None: ...

Default Value

""

Remarks

The blob's content type.

This property specifies the blob's content type. Always empty for uncommitted block blobs.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

blob_created_time Property

The creation time of the blob.

Syntax

def get_blob_created_time(blob_index: int) -> str: ...

Default Value

""

Remarks

The creation time of the blob.

This property reflects the creation time of the blob, formatted according to RFC 1123.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_e_tag Property

The ETag of the blob.

Syntax

def get_blob_e_tag(blob_index: int) -> str: ...

Default Value

""

Remarks

The ETag of the blob.

This property reflects the ETag of the blob. Always empty for uncommitted block blobs.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_is_leased Property

Whether the blob is current leased.

Syntax

def get_blob_is_leased(blob_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the blob is current leased.

This property indicates whether the blob is currently leased.

This property is always False if blob_soft_deleted is True and/or blob_snapshot is non-empty.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_is_lease_infinite Property

Whether the blob's lease duration is infinite.

Syntax

def get_blob_is_lease_infinite(blob_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the blob's lease duration is infinite.

This property indicates whether the blob's lease duration is fixed (False) or infinite (True).

This property is always False when blob_is_leased is False.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_lease_state Property

The lease state of the blob.

Syntax

def get_blob_lease_state(blob_index: int) -> int: ...

Default Value

0

Remarks

The lease state of the blob.

This property reflects the lease state of the blob. Possible values are:

This property is always ablsAvailable (0) when blob_is_leased is False.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_modified_time Property

The last modified time of the blob.

Syntax

def get_blob_modified_time(blob_index: int) -> str: ...

Default Value

""

Remarks

The last modified time of the blob.

This property reflects the last modified time of the blob, formatted according to RFC 1123. Always empty for uncommitted block blobs.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_name Property

The name of the blob.

Syntax

def get_blob_name(blob_index: int) -> str: ...
def set_blob_name(blob_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the blob.

This property specifies the name of the blob.

Note: Blobs cannot be renamed; this property is only writable so that applications can add new items to the Blob* properties for use with update_blob_info (which looks up items in said properties by blob name).

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

blob_sequence_num Property

The sequence number of the page blob.

Syntax

def get_blob_sequence_num(blob_index: int) -> int: ...

Default Value

0

Remarks

The sequence number of the page blob.

This property reflects the sequence number of the page blob; it is always -1 for block blobs and append blobs.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_snapshot Property

The blob snapshot identifier.

Syntax

def get_blob_snapshot(blob_index: int) -> str: ...

Default Value

""

Remarks

The blob snapshot identifier.

If the current item represents a blob snapshot, this property will be populated with the opaque DateTime value that identifies the snapshot. If the current items represents a base blob, this property will be empty.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_soft_deleted Property

Whether the blob has been soft-deleted.

Syntax

def get_blob_soft_deleted(blob_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the blob has been soft-deleted.

This property indicates whether the blob (or snapshot, if blob_snapshot is non-empty) has been soft-deleted.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

blob_type Property

The blob's type.

Syntax

def get_blob_type(blob_index: int) -> int: ...

Default Value

0

Remarks

The blob's type.

This property reflects the blob's type. Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

The blob_index parameter specifies the index of the item in the array. The size of the array is controlled by the blob_count property.

This property is read-only.

block_count Property

The number of records in the Block arrays.

Syntax

def get_block_count() -> int: ...
def set_block_count(value: int) -> None: ...

block_count = property(get_block_count, set_block_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• block_id
• block_size
• block_type

The array indices start at 0 and end at block_count - 1.

block_id Property

The Id of the block.

Syntax

def get_block_id(block_index: int) -> str: ...
def set_block_id(block_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the block.

This property specifies the Id of the block.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

The block_index parameter specifies the index of the item in the array. The size of the array is controlled by the block_count property.

block_size Property

The size of the block.

Syntax

def get_block_size(block_index: int) -> int: ...

Default Value

-1

Remarks

The size of the block.

This property reflects the size of the block, in bytes.

This property is only populated by calls to list_blocks, and will be -1 in all other cases.

The block_index parameter specifies the index of the item in the array. The size of the array is controlled by the block_count property.

This property is read-only.

block_type Property

The type of block.

Syntax

def get_block_type(block_index: int) -> int: ...
def set_block_type(block_index: int, value: int) -> None: ...

Default Value

0

Remarks

The type of block.

When populated by list_blocks, this property reflects the block's type (one of the first two values listed below). When used during a put_block_list operation, this property specifies which block list the server should search for the block Id specified by block_id.

Possible values are:

The block_index parameter specifies the index of the item in the array. The size of the array is controlled by the block_count property.

container Property

Selects a container.

Syntax

def get_container() -> str: ...
def set_container(value: str) -> None: ...

container = property(get_container, set_container)

Default Value

""

Remarks

This property selects a container, by name, for the class to operate against. It must be set before attempting most operations.

Container Name Rules

Container names must adhere to the following rules:

• Must be 3 to 63 characters long.
• Must start with a letter or number; and may only contain letters, numbers, and hyphens.
• All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to container.)
• All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).

container_marker Property

A marker indicating what page of containers to return next.

Syntax

def get_container_marker() -> str: ...
def set_container_marker(value: str) -> None: ...

container_marker = property(get_container_marker, set_container_marker)

Default Value

""

Remarks

This property will be populated when list_containers is called if the results are paged and there are more pages. To list all containers, continue to call list_containers until this property returns empty string.

Refer to list_containers for more information.

container_count Property

The number of records in the Container arrays.

Syntax

def get_container_count() -> int: ...

container_count = property(get_container_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• container_e_tag
• container_has_immutability_policy
• container_has_legal_hold
• container_is_leased
• container_is_lease_infinite
• container_lease_state
• container_modified_time
• container_name
• container_public_access

The array indices start at 0 and end at container_count - 1.

This property is read-only.

container_e_tag Property

The ETag of the container.

Syntax

def get_container_e_tag(container_index: int) -> str: ...

Default Value

""

Remarks

The ETag of the container.

This property reflects the container's ETag.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_has_immutability_policy Property

Whether an immutability policy is set on the container.

Syntax

def get_container_has_immutability_policy(container_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether an immutability policy is set on the container.

This property indicates whether there is an immutability policy set on the container.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_has_legal_hold Property

Whether there are any legal holds on the container.

Syntax

def get_container_has_legal_hold(container_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether there are any legal holds on the container.

This property indicates whether there are any legal holds on the container.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_is_leased Property

Whether the container is currently leased.

Syntax

def get_container_is_leased(container_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the container is currently leased.

This property indicates whether the container is currently leased.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_is_lease_infinite Property

Whether the container's lease duration is infinite.

Syntax

def get_container_is_lease_infinite(container_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the container's lease duration is infinite.

This property indicates whether the container's lease duration is fixed (False) or infinite (True).

This property is always False when container_is_leased is False.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_lease_state Property

The lease state of the container.

Syntax

def get_container_lease_state(container_index: int) -> int: ...

Default Value

0

Remarks

The lease state of the container.

This property reflects the lease state of the container. Possible values are:

This property is always aclsAvailable (0) when container_is_leased is False.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_modified_time Property

The last modified time of the container.

Syntax

def get_container_modified_time(container_index: int) -> str: ...

Default Value

""

Remarks

The last modified time of the container.

This property reflects the last modified time of the container, formatted according to RFC 1123.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_name Property

The name of the container.

Syntax

def get_container_name(container_index: int) -> str: ...

Default Value

""

Remarks

The name of the container.

This property reflects the name of the container.

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

container_public_access Property

The container's public access level.

Syntax

def get_container_public_access(container_index: int) -> int: ...

Default Value

0

Remarks

The container's public access level.

This property reflects the container's public access level. Possible values are:

The container_index parameter specifies the index of the item in the array. The size of the array is controlled by the container_count property.

This property is read-only.

encryption_algorithm Property

The encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

encryption_password Property

The encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

lease_id Property

The lease Id to include when making requests.

Syntax

def get_lease_id() -> str: ...
def set_lease_id(value: str) -> None: ...

lease_id = property(get_lease_id, set_lease_id)

Default Value

""

Remarks

This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.

For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For create_blob and copy_blob, note that this property must be empty if the target blob does not yet exist.

For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.

Finally, note that this property is used in a specific manner by the lease method; refer to its documentation for more information.

local_file Property

The location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling append_block, create_blob (for block blobs), put_block, or put_pages; and as the destination file when calling get_blob.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

metadata_count Property

The number of records in the Metadata arrays.

Syntax

def get_metadata_count() -> int: ...
def set_metadata_count(value: int) -> None: ...

metadata_count = property(get_metadata_count, set_metadata_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• metadata_name
• metadata_value

The array indices start at 0 and end at metadata_count - 1.

metadata_name Property

The name of the metadata item.

Syntax

def get_metadata_name(metadata_index: int) -> str: ...
def set_metadata_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. Note that metadata item names are case-preserving, but not case-sensitive.

Note that the class will automatically prepend x-ms-meta- to this value when submitting metadata items to the server; and will automatically strip that prefix from this value when retrieving them from the server.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value Property

The value of the metadata item.

Syntax

def get_metadata_value(metadata_index: int) -> str: ...
def set_metadata_value(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

o_auth_client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

o_auth_grant_type Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

o_auth_refresh_token Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_return_url Property

The URL where the user (browser) returns after authenticating.

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

The URL of the token server used to obtain the access token.

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

o_auth_web_auth_url Property

The URL to which the user should be re-directed for authorization.

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only.

other_headers Property

This property includes other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Whether to overwrite the local file, or remote blob.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

When calling download_file, this property determines if local_file should be overwritten if it already exists.

When calling create_blob or copy_blob, this property determines if the remote blob should be overwritten if it already exists.

page_range_count Property

The number of records in the PageRange arrays.

Syntax

def get_page_range_count() -> int: ...

page_range_count = property(get_page_range_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• page_range_first
• page_range_last

The array indices start at 0 and end at page_range_count - 1.

This property is read-only.

page_range_first Property

The first byte of the range.

Syntax

def get_page_range_first(page_range_index: int) -> int: ...

Default Value

0

Remarks

The first byte of the range.

This property specifies the first byte (inclusive) of the byte range.

The page_range_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_range_count property.

This property is read-only.

page_range_last Property

The last byte of the range.

Syntax

def get_page_range_last(page_range_index: int) -> int: ...

Default Value

0

Remarks

The last byte of the range.

This property specifies the last byte (inclusive) of the byte range.

The page_range_index parameter specifies the index of the item in the array. The size of the array is controlled by the page_range_count property.

This property is read-only.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

prefix Property

A prefix used to restrict the results returned when listing blobs or containers.

Syntax

def get_prefix() -> str: ...
def set_prefix(value: str) -> None: ...

prefix = property(get_prefix, set_prefix)

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by list_blobs or list_containers to only the items whose names begin with the given value.

Blob Namespace Traversal

By using the blob_delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With blob_delimiter set to /, we can set prefix to successively "deeper" values before calling list_blobs for the following effect:

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

range Property

The range of bytes to request.

Syntax

def get_range() -> str: ...
def set_range(value: str) -> None: ...

range = property(get_range, set_range)

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a get_blob or list_page_ranges request is being constructed, a header like x-ms-range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the start_byte property is greater than zero when get_blob is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by start_byte bytes when sending the x-ms-range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

snapshot Property

The blob snapshot to make requests against.

Syntax

def get_snapshot() -> str: ...
def set_snapshot(value: str) -> None: ...

snapshot = property(get_snapshot, set_snapshot)

Default Value

""

Remarks

This property can be set to the opaque DateTime value used to identify a particular blob snapshot before calling the following methods in order to make requests against the specified blob snapshot instead of the base blob:

• copy_blob (to copy from a blob snapshot)
• delete_blob
• get_blob
• get_blob_info
• get_link (to build a link for a specific blob snapshot)
• list_page_ranges
• send_custom_request

Refer to the documentation of the methods listed above for more information.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_byte Property

The byte offset from which to resume the upload or download.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

This property specifies the byte offset from which to resume a block blob upload using create_blob, or a download of any blob type using get_blob. Refer to those methods' documentation for more information about resuming uploads and downloads.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

use_ssl Property

Whether to use SSL/TLS when connecting.

Syntax

def get_use_ssl() -> bool: ...
def set_use_ssl(value: bool) -> None: ...

use_ssl = property(get_use_ssl, set_use_ssl)

Default Value

TRUE

Remarks

This property specifies whether the class should use SSL/TLS when connecting.

abort_copy Method

Aborts a copy operation.

Syntax

def abort_copy(dest_blob: str, copy_id: str) -> None: ...

Remarks

This method aborts the copy operation identified by the given CopyId for the destination blob DestBlob in the container currently selected by container.

Note that the destination blob will still exist after aborting a copy operation, but it will be empty.

add_block Method

Adds a block to the Blocks properties.

Syntax

def add_block(id: str, block_list_type: int) -> None: ...

Remarks

This method adds a block to the Block* properties. Id specifies the block's Id, and BlockListType specifies where the server should search for this block.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Valid values for BlockListType are:

add_metadata Method

Adds a metadata item to the Metadata properties.

Syntax

def add_metadata(name: str, value: str) -> None: ...

Remarks

This method adds a metadata item to the metadata properties. Name specifies the name of the item, and Value specifies the value of the item.

Note that the class will automatically prepend x-ms-meta- to metadata item names (as necessary) when they are submitted to the server. Also note that while metadata item names are case-preserving, they are not case-sensitive.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

append_block Method

Appends a block of data to an append blob.

Syntax

def append_block(append_blob: str) -> None: ...

Remarks

This method appends a block of data to the specified AppendBlob in the container currently selected by container. The block of data is immediately available as part of the append blob, which must already exist.

Up to 4MB (4194304 bytes) of data may be appended in a single block, and up to 50000 blocks may be appended to a single append blob.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the o_auth_client_profile property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the OAuth* properties.

For more information, see the introduction section.

calc_authorization Method

Calculates the Authorization header based on provided credentials.

Syntax

def calc_authorization() -> None: ...

Remarks

This method calculates the authorization value using the values provided in auth_scheme, user and password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as get or post.

This method may be useful in cases where the authorization value needs to be calculated prior to sending a request.

clear_pages Method

Clears a range of pages in a page blob.

Syntax

def clear_pages(page_blob: str, byte_offset: int, page_count: int) -> None: ...

Remarks

This method clears PageCount pages, from ByteOffset onwards, for the specified PageBlob in the container currently selected by container.

ByteOffset must be a multiple of 512; i.e. ByteOffset % 512 == 0. PageCount must be a number between 1 and the number of pages in the page blob following ByteOffset (inclusive).

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy_blob Method

Copies a blob.

Syntax

def copy_blob(src_blob: str, dest_blob: str, dest_container: str) -> str: ...

Remarks

This method copies the specified SrcBlob (in the container currently selected by container) to the specified DestBlob in DestContainer. If this method finishes successfully, it will either return an asynchronous copy Id, or an empty string (if the copy has finished already).

If snapshot is non-empty, the specified snapshot of SrcBlob will be used as the copy source. In this case, DestBlob may be the same blob as SrcBlob to "promote" the snapshot, copying its contents back to the base blob.

If DestContainer is empty, the current value of container is used instead. If DestContainer in non-empty, the value will automatically be lowercased when preparing the request.

If DestBlob already exists, and is the same type of blob as SrcBlob, then it will be overwritten if overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If DestBlob already exists and has an active infinite-duration lease, its lease Id must be specified using lease_id, or the request will fail. (If it exists and has an active fixed-duration lease, the request will always fail.)

If the SendMetadataOnCopy configuration setting is enabled when this method is called, all items in the Metadata* properties will be sent in the copy request and applied to DestBlob. Otherwise, the server will copy the metadata items from SrcBlob to DestBlob.

If the request succeeds, this method will always populate the CopyId and CopyStatus configuration settings (and clear CopyProgress and CopyStatusDesc).

Asynchronous Copy Notes

As mentioned, this method will return a copy operation Id if the copy operation was started asynchronously. In this case, use the get_blob_info method to poll the DestBlob blob's information, which will cause the CopyStatus, CopyStatusDesc, and CopyProgress configuration settings to be refreshed.

A copy operation whose CopyStatus is still pending may also be aborted by passing the copy operation Id returned by this method (or later retrieved from CopyId) to the abort_copy method. // Copy a blob to another location within the same container. string copyResult = azureblob.CopyBlob("important.zip", "secrets.zip", ""); // If the returned value *isn't* empty string, then we'll monitor the status of the // asynchronous copy operation by polling once every 2 seconds using GetBlobInfo(). if (!string.IsNullOrEmpty(copyResult)) { do { azureblob.GetBlobInfo("secrets.zip"); Console.WriteLine("Copy progress: " + azureblob.Config("CopyProgress")); } while (azureblob.Config("CopyStatus") == "pending"); }

create_blob Method

Creates a new blob of the specified type.

Syntax

def create_blob(blob: str, blob_type: int, page_blob_size: int) -> None: ...

Remarks

This method creates a new blob named Blob in the container currently selected by container. BlobType specifies what type of blob should be created; valid values are: Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

PageBlobSize is only used when BlobType is abtPageBlob (1); it is ignored otherwise.

If the specified blob already exists, and is the same type of blob as BlobType specifies, then it will be overwritten if overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If the specified blob already exists and has an active lease, its lease Id must be specified using lease_id, or the request will fail.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata* properties will be sent along with the creation request.

Creating Block Blobs

Block blobs can be created either with or without data initially. In either case, after the block blob is created, its contents can be managed by uploading blocks with put_block and then committing a new block list using put_block_list.

If upload data is present when this method is called to create a block blob, it will be uploaded in one of two ways. If the amount of data provided is less than or equal to the limit specified by the SimpleUploadLimit configuration setting (268435456 bytes (256MB), by default), it will be uploaded directly in the create blob request.

If more than SimpleUploadLimit bytes of data are provided, the class will first create the new block blob, and then upload the data by splitting it up into blocks (sized according to the FragmentSize configuration setting), uploading them individually, and then committing a new block list. To accomplish this, the class automatically makes calls to put_block and put_block_list internally, tracks the blocks as they are uploaded using the Block* properties, and tracks how much data has been uploaded using the start_byte property. The on_fragment_complete event will fire after each block is uploaded.

If, during a block-based upload, any individual put_block request (or the put_block_list request) fails, the upload can be resumed be calling this method again with the same parameters, so long as the Block* and start_byte properties still hold the same information as they did when the upload was interrupted.

When a block-based upload completes successfully, start_byte is reset to 0, but the Block* properties remains populated. This allows applications to easily inspect the Ids of the uploaded blocks, which the class generates automatically in the following GUID format: dddddddd-dddd-dddd-dddd-dddddddddddd (where each d is a single hex digit).

Creating Page Blobs

Unlike block blobs, no data can be uploaded when creating a page blob. However, the page blob's size (i.e., capacity) must be specified using PageBlobSize. A page blob's size must be a 512-byte-aligned; i.e. PageBlobSize % 512 == 0.

Once a page blob has been created, its contents can be manipulated using the put_pages and clear_pages methods.

Creating Append Blobs

Append blobs must also be created without uploading any data initially. After a page blob has been created, data can be appended to it using the append_block method.

create_container Method

Creates a new container.

Syntax

def create_container() -> None: ...

Remarks

This method creates a new container using the name specified by the container property;

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata* properties will be sent along with the creation request.

Container Name Rules

Container names must adhere to the following rules:

• Must be 3 to 63 characters long.
• Must start with a letter or number; and may only contain letters, numbers, and hyphens.
• All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to container.)
• All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).

create_snapshot Method

Creates a new snapshot of a blob.

Syntax

def create_snapshot(blob: str) -> str: ...

Remarks

This method creates a new snapshot of the specified Blob in the container currently selected by container, and returns the opaque DateTime value used to identify the newly-created snapshot.

If the SendMetadataOnSnapshot configuration setting is enabled when this method is called, all items in the Metadata* properties will be sent in the request and applied to newly-created snapshot. Otherwise, the server will copy the metadata items from Blob to the snapshot.

If the specified blob has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

delete_blob Method

Deletes a blob.

Syntax

def delete_blob(blob: str, delete_action: int) -> None: ...

Remarks

This method deletes the specified Blob in the container currently selected by container. DeleteAction specifies how the delete operation should be handled; possible values are:

Alternatively, if snapshot is non-empty, the specified snapshot of Blob is deleted, and DeleteAction is ignored.

If the current Azure Storage account, specified by account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete blobs (and snapshots). Soft-deleted blobs and snapshots can be listed by enabling the IncludeSoftDeleted configuration setting before calling list_blobs, and can be undeleted at any point before their retention period expires by calling undelete_blob.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

delete_container Method

Deletes a container.

Syntax

def delete_container() -> None: ...

Remarks

This method deletes the container currently selected by container. Note that, according to the Azure documentation, when a container is deleted its name cannot be reused for at least 30 seconds.

If the specified container has an active lease, its lease Id must be specified using lease_id, or the request will fail.

get_blob Method

Downloads a blob.

Syntax

def get_blob(blob: str) -> None: ...

Remarks

This methods downloads the specified Blob in the container currently selected by container. If snapshot is non-empty, the specified snapshot of Blob is downloaded instead. The range property can be used to download a specific range of bytes from the blob.

If the specified blob has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

If local_file is set, the blob data will be saved to the specified location; otherwise, the blob data will be held by resource_data.

To download and decrypt an encrypted blob, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading a blob looks like this: azureblob.LocalFile = "../MyData.zip"; azureblob.GetBlob(azureblob.Blobs[0].Name);

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; azureblob.LocalFile = downloadFile; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded file azureblob.StartByte = new FileInfo(downloadFile).Length; azureblob.GetBlob(azureblob.Blobs[0].Name);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. azureblob.LocalFile = "../MyData.zip"; azureblob.EncryptionPassword = "password"; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded temp file azureblob.StartByte = new FileInfo(azureblob.Config("DownloadTempFile")).Length; azureblob.GetBlob(azureblob.Blobs[0].Name);

get_blob_info Method

Gets a blob's information and metadata.

Syntax

def get_blob_info(blob: str) -> None: ...

Remarks

This method gets information and metadata for the specified Blob in the container currently selected by container. If snapshot is non-empty, information and metadata for the specified snapshot of Blob is retrieved instead.

Calling this method will fire the on_blob_list and on_metadata_list events, and will re-populate the Blob* and Metadata* properties.

If the specified blob has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

get_container_acl Method

Gets the stored access policies and public access level for a container.

Syntax

def get_container_acl() -> int: ...

Remarks

This method retrieves the stored access policies and the public access level for the container currently selected by container. The stored access policies are used to populate the AccessPolicy* properties, and the public access level is returned directly. Possible values are:

If the specified container has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

get_container_info Method

Gets a container's information and metadata.

Syntax

def get_container_info() -> None: ...

Remarks

This method gets information and metadata for the container currently selected by container.

Calling this method will fire the on_container_list and on_metadata_list events, and will re-populate the Container* and Metadata* properties.

If the specified container has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

get_link Method

Creates a link that provides access to a container, blob, or snapshot.

Syntax

def get_link(blob: str, permissions: str, start_time: str, expiry_time: str) -> str: ...

Remarks

This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific container, blob, or snapshot. The following table indicates which inputs must be provided to produce a link of the desired type:

Permissions specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format this value.

StartTime and ExpiryTime specify the UTC start and end times of the SAS's validity interval. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format these values.

StartTime may be empty, in which case the server will assume that the link is valid immediately. Permissions and ExpiryTime must both be non-empty, unless an si query parameter that references a stored access policy (which has corresponding non-empty values) is present in the QueryParam* properties.

If any of the query parameters listed below are present in the QueryParam* properties when this method is called, they will be included when creating the SAS. All other application-specified query parameters are ignored.

• Response headers: rscc, rscd, rsce, rscl, rsct
• IP address (single or range): sip
• Allowed HTTP protocol(s): spr
• Stored access policy ("signed identifier"): si

For more information about SAS links, refer to Azure's Create a Service SAS article.

get_user_delegation_key Method

Requests a new user delegation key.

Syntax

def get_user_delegation_key(start_time: str, expiry_time: str) -> None: ...

Remarks

This method requests a new user delegation key and populates UserDelegationKey with the returned information.

NOTE: This method is not currently implemented; it is reserved for future use.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

lease Method

Creates or manages a lease on a blob or container.

Syntax

def lease(blob: str, lease_action: int, new_lease_id: str, duration: int) -> None: ...

Remarks

This method creates or manages a lease on the container currently selected by container (if Blob is empty), or on the specified Blob in that container.

LeaseAction specifies what action should occur. Possible values, and their effects, are:

• Acquire (0): Requests a new lease.
  • If no active lease currently exists, a new one is created and lease_id is populated with the new lease's Id. If a non-empty value is passed for NewLeaseId, it is used; otherwise the server generates an Id.
  • If an active lease currently exists, its Id must be passed for NewLeaseId.
  • In either case, Duration is used to specify the length of time that the lease is valid for (see below).
• Renew (1): Renews the lease specified by lease_id.
  • Leases can only be renewed while active or expired (and in the latter case, only if a different lease has not been acquired in the meantime).
  • Renewing an active lease will reset its expiration clock.
• Change (2): Changes the Id of the active lease specified by lease_id to the one specified by NewLeaseId.
  • If this action is successful, the class will automatically set lease_id to the value passed for NewLeaseId.
• Release (3): Releases the lease specified by lease_id.
  • If this action is successful, the class will automatically clear lease_id.
• Break (4): Breaks the current lease, either immediately or after a certain period of time (the "break period") according to the value passed for Duration.
  • The lease's Id is not required to break the lease.
  • If Duration is -1, fixed-length leases are broken after their remaining time elapses, and infinite-length leases are broken immediately.
  • Otherwise, Duration specified how many seconds (see below) the lease should continue before being broken. (For fixed-length leases, the lesser of this value and the lease's remaining time is used.)
  • If this action is successful, the LeaseBreakPeriod configuration setting is populated to indicate how long the lease's break period is.

If NewLeaseId is non-empty, if must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The value passed for Duration is only used in the cases listed below; it is ignored otherwise.

• When LeaseAction is Acquire (0): Valid values for Duration are -1 (infinite), or a number of seconds between 15 and 60 (inclusive).
• When LeaseAction is Break (4): Valid values for Duration are -1 (unspecified), or a number of seconds between 0 and 60 (inclusive). 0 indicates the lease should be broken immediately, regardless of whether it is fixed- or infinite-length.

For more information about how leases work, refer to Azure's Lease Blob and Lease Container API documentation.

list_blobs Method

Lists the blobs in a container.

Syntax

def list_blobs() -> None: ...

Remarks

This method lists the blobs in the container currently selected by container.

Before calling this method, the prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The following properties and configuration settings can also be used to further tune the results returned; refer to their documentation for more information:

• blob_delimiter
• IncludeSnapshots
• IncludeSoftDeleted
• IncludeUncommittedBlobs
• ListWithMetadata

Calling this method will fire the on_blob_list event once for each blob, and will also populate the Blob* properties. It may also fire the on_prefix_list and on_metadata_list events, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties and configuration settings discussed above are set.

If there are still more blobs available to list when this method returns, the blob_marker property will be populated. Continue to call this method until blob_marker is empty to accumulate all pages of results in the Blob* properties.

Blob Namespace Traversal

By using the blob_delimiter and prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

• MyCompany
• MyCompany/Department1
• MyCompany/Department2
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With blob_delimiter set to /, we can set prefix to successively "deeper" values before calling list_blobs for the following effect:

list_blocks Method

Lists the blocks associated with a block blob.

Syntax

def list_blocks(block_blob: str, block_list_type: int) -> None: ...

Remarks

This method lists the blocks associated with the specified BlockBlob in the container currently selected by container. BlockListType indicates which block list(s) the server should return results from; possible values are:

Alternatively, if snapshot is non-empty, the committed blocks for the specified snapshot of BlockBlob are listed instead (and BlockListType is ignored).

Calling this method will fire the on_block_list event once for each block, and will also repopulate the Block* properties.

list_containers Method

Lists the containers in the blob storage account.

Syntax

def list_containers() -> None: ...

Remarks

This method lists the containers in the Azure blob storage account specified by the account property.

Before calling this method, the prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The ListWithMetadata configuration setting can also be used to further tune the results returned.

Calling this method will fire the on_container_list event once for each container, and will also populate the Container* properties. It may also fire the on_metadata_list event, depending on how the ListWithMetadata setting is configured.

If there are still more containers available to list when this method returns, the container_marker property will be populated. Continue to call this method until container_marker is empty to accumulate all pages of results in the Container* properties.

list_page_ranges Method

Lists the page ranges of a page blob.

Syntax

def list_page_ranges(page_blob: str) -> None: ...

Remarks

This method lists the allocated page ranges of the specified PageBlob in the container currently selected by container. If snapshot is non-empty, the allocated page ranges for the specified snapshot of PageBlob are listed instead.

The range property can be used to restrict the results to only the page ranges within the specified range.

Calling this method will repopulate the PageRange* properties. Every page in a page blob is exactly 512 bytes in length; thus, the size of every range returned by this method will always be a multiple of 512.

Normally, ranges of pages that are not currently allocated (either because no data has been written to them, or because they've been cleared with clear_pages) will not be returned by this method. However, setting the PreviousSnapshot configuration setting to a non-empty value will cause the server to return a list of all pages that differ between that snapshot and the base PageBlob (or the later snapshot of PageBlob specified by snapshot); refer to PreviousSnapshot for more information.

If the specified blob has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

put_block Method

Uploads a new block of data to a block blob.

Syntax

def put_block(block_blob: str, block_id: str) -> str: ...

Remarks

This method uploads a new block of data with the given BlockId to the specified BlockBlob in the container currently selected by container. The block of data is uploaded in an uncommitted state; it will not be available as part of the block blob until it is committed in a put_block_list operation.

The Base64-encoded Id of the block is returned (if the EncodeBlockIds configuration setting is disabled, the same value as passed for BlockId is returned; see below for more information).

If the specified BlockBlob does not yet exist, it is created in an uncommitted state. If an uncommitted block with the specified BlockId is already associated with the specified BlockBlob, it is replaced.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Up to 100MB (104857600 bytes) of data may be uploaded in a single block, and up to 100000 uncommitted blocks may be associated with a block blob at any time.

If the block is successfully uploaded, the class will automatically call add_block to add an item to the Block* properties. This behavior can be changed using the AutoAddBlocks configuration setting.

If BlockBlob already exists and has an active lease, its lease Id must be specified using lease_id, or the request will fail.

put_block_list Method

Commits a list of data blocks to a block blob.

Syntax

def put_block_list(block_blob: str, block_list: str) -> None: ...

Remarks

This method commits the blocks of data specified by the Block* properties to the specified BlockBlob in the container currently selected by container. Up to 50000 blocks may be committed to a single block blob at any time.

The BlockList parameter can optionally be passed a non-empty list of blocks to commit in order to repopulate the Block* properties before building the request. This allows applications to build an entire block list and then commit it in a single call, rather than manipulating the Block* properties directly, or calling add_block.

The value supplied should contain a comma-separated list of strings like {BlockListType}:{BlockId}, where {BlockListType} is either C, U, or L to specify whether the server should search for a block with the associated Id in BlockBlob's committed block list, uncommitted block list, or both (uncommitted; then committed, if necessary). If necessary, the BlockListStringSeparator configuration setting can be used to change the separator string used when parsing the value.

If BlockList is empty, the current items in the Block* properties will remain unchanged.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

Note: By default, the class will automatically retrieve and re-submit the BlockBlob's current properties and metadata (if it exists) when this method is called, since Azure would clear them otherwise.

However, if one or more x-ms-blob-* headers are present in other_headers when this method is called, the class will send them rather than re-submitting any of the retrieved blob properties. Similarly, if the SendMetadataOnPutBlockList configuration setting is enabled, the class will send the metadata items currently present in the Metadata* properties instead of those retrieved from the server.

put_pages Method

Uploads a range of pages to a page blob.

Syntax

def put_pages(page_blob: str, write_offset: int) -> None: ...

Remarks

This method uploads a range of pages to the specified PageBlob in the container currently selected by container, starting at the byte offset specified by WriteOffset. The uploaded data is immediately available as part of the page blob, which must already exist.

The upload data's size, in bytes, must be a multiple of 512 no larger than 4MB (4194304 bytes). The value passed for WriteOffset must also be a multiple of 512; WriteOffset % == 0.

Note that writing a page full of zeros will not actually clear said page, so it will still incur data storage charges. It is recommended that applications avoid writing pages that only contain zeros, or clear such pages using the clear_pages method.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

send_custom_request Method

Sends a custom request to the Azure Blob Storage service.

Syntax

def send_custom_request(http_method: str, blob: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the Azure Blob Storage service.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The Blob and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, using the following:
   • use_ssl
   • account (must be non-empty)
   • container (if non-empty)
   • Blob (if non-empty)
   • snapshot (if both it and Blob are non-empty)
   • QueryParam*
2. Adds request headers from:
   • APIVersion
   • lease_id (if non-empty)
   • IfMatch (if non-empty)
   • other_headers
3. Authenticates the request using authorization (if non-empty), or access_key (in which case the request is signed).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file, or blob_data (using the same logic as get_blob).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

set_container_acl Method

Sets the stored access policies and public access level for a container.

Syntax

def set_container_acl(public_access: int) -> None: ...

Remarks

This method sets the stored access policies and the public access level for the container currently specified by container. The items in the AccessPolicy* properties determine the new set of stored access policies, and PublicAccess determines the new public access level. Possible values are:

Note that it is not possible to do a partial update of stored access policies. That is, all stored access policies currently associated with the container will be replaced with the stored access policies sent in the request. To prevent data loss, applications should call get_container_acl to retrieve the container's current stored access polices, and then add/modify/remove them as desired, before using this method.

If the specified container has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified.

undelete_blob Method

Undeletes a soft-deleted blob.

Syntax

def undelete_blob(blob: str) -> None: ...

Remarks

This method undeletes the specified soft-deleted Blob in the container currently selected by container. If any soft-deleted snapshots are associated with the specified blob, they are also undeleted (note that this also works if the blob itself is has not been soft-deleted).

Refer to delete_blob for more information about soft-deleting blobs.

update_blob_info Method

Updates a blob's information.

Syntax

def update_blob_info(blob: str) -> None: ...

Remarks

This method updates the information of the specified Blob in the container currently selected by container.

There must be an item in the Blob* properties whose blob_name property matches the specified Blob name (and whose blob_snapshot property is empty) before this method is called.

When this method is called, the values of the following propertys on the aforementioned item are sent to the server (note that the last two are indexed configuration settings):

• blob_content_disposition
• blob_content_encoding
• blob_content_md5
• blob_content_type
• BlobCacheControl[i]
• BlobContentLanguage[i]

Note that it is not possible to do a partial update of a blob's information. That is, all of the blob's current values for the aforementioned propertys will be replaced with the values sent in the request. To prevent data loss, applications should call get_blob_info to retrieve the blob's current information, and then modify it as desired, before using this method.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

update_metadata Method

Sets the metadata for a blob or container.

Syntax

def update_metadata(blob: str) -> None: ...

Remarks

This method sets the metadata for the container currently selected by container (if Blob is empty), or for the specified Blob in that container, to the items currently held by the Metadata* properties.

Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the blob or container will be replaced with the metadata sent in the request. To prevent data loss, applications should call get_blob_info or get_container_info to retrieve the blob or container's current metadata, and then modify it as desired, before using this method.

When setting the metadata of a container that has an active lease, a lease Id may optionally be specified using lease_id; the request will only succeed if the correct lease Id is specified. When setting the metadata of a blob that has an active lease, its lease Id must be specified using lease_id, or the request will fail.

update_page_blob Method

Updates a page blob's size and/or sequence number.

Syntax

def update_page_blob(page_blob: str, new_size: int, sequence_num_action: int, new_sequence_num: int) -> None: ...

Remarks

This method updates the size and/or sequence number of the specified PageBlob in the container currently selected by container.

NewSize must either be -1 (to keep the page blob's current size), or a multiple of 512; i.e. NewSize % 512 == 0. If NewSize is less than the page blob's current size, all pages above the specified value are cleared.

SequenceNumAction determines how the page blob's sequence number should be changed; possible values are:

In cases where NewSequenceNum is used, it must be a value in the range 0 to 2^63 - 1, inclusive.

If the specified blob has an active lease, its lease Id must be specified using lease_id, or the request will fail.

on_blob_list Event

Fires once for each blob returned when listing blobs.

Syntax

class AzureBlobBlobListEventParams(object):
  @property
  def name() -> str: ...

  @property
  def container() -> str: ...

  @property
  def blob_type() -> int: ...

  @property
  def snapshot() -> str: ...

  @property
  def content_length() -> int: ...

  @property
  def content_type() -> str: ...

  @property
  def created_time() -> str: ...

  @property
  def modified_time() -> str: ...

  @property
  def e_tag() -> str: ...

  @property
  def soft_deleted() -> bool: ...

  @property
  def is_leased() -> bool: ...

  @property
  def lease_state() -> int: ...

# In class AzureBlob:
@property
def on_blob_list() -> Callable[[AzureBlobBlobListEventParams], None]: ...
@on_blob_list.setter
def on_blob_list(event_hook: Callable[[AzureBlobBlobListEventParams], None]) -> None: ...

Remarks

This event fires once for each blob returned when list_blobs or get_blob_info is called.

Name is the name of the blob.

Container is the name of the blob's container.

BlobType is the blob's type. Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

Snapshot is the snapshot identifier, if the current item represents a blob snapshot; empty otherwise.

ContentLength is the size of the blob's committed data in bytes, for block blobs and append blobs. For page blobs, its the capacity in bytes.

ContentType is the blob's content type. Always empty for uncommitted block blobs.

CreatedTime and ModifiedTime reflect the creation and last modified times of the blob, formatted according to RFC 1123. The latter is always empty for uncommitted block blobs.

ETag is the blob's ETag. Always empty for uncommitted block blobs.

SoftDeleted indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.

IsLeased indicates whether the blob is currently leased. Always False if SoftDeleted is True and/or Snapshot is non-empty.

LeaseState reflects the lease state of the blob. Possible values are:

on_block_list Event

Fires once for each block returned when listing blocks.

Syntax

class AzureBlobBlockListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def block_type() -> int: ...

  @property
  def size() -> int: ...

# In class AzureBlob:
@property
def on_block_list() -> Callable[[AzureBlobBlockListEventParams], None]: ...
@on_block_list.setter
def on_block_list(event_hook: Callable[[AzureBlobBlockListEventParams], None]) -> None: ...

Remarks

This event fires once for each block returned when list_blocks is called.

Id is the Id of the block.

BlockType reflects the block's type; possible values are:

• abktCommitted (0)
• abktUncommitted (1)

Size reflects the size of the block, in bytes.

on_container_list Event

Fires once for each container returned when listing containers.

Syntax

class AzureBlobContainerListEventParams(object):
  @property
  def name() -> str: ...

  @property
  def modified_time() -> str: ...

  @property
  def e_tag() -> str: ...

  @property
  def is_leased() -> bool: ...

  @property
  def lease_state() -> int: ...

# In class AzureBlob:
@property
def on_container_list() -> Callable[[AzureBlobContainerListEventParams], None]: ...
@on_container_list.setter
def on_container_list(event_hook: Callable[[AzureBlobContainerListEventParams], None]) -> None: ...

Remarks

This event fires once for each container returned when list_containers or get_container_info is called.

Name is the name of the container.

ModifiedTime reflects the last modified time of the container, formatted according to RFC 1123.

ETag is the container's ETag.

IsLeased indicates whether the container is currently leased.

LeaseState reflects the lease state of the container. Possible values are:

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class AzureBlobEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AzureBlob:
@property
def on_end_transfer() -> Callable[[AzureBlobEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[AzureBlobEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class AzureBlobErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AzureBlob:
@property
def on_error() -> Callable[[AzureBlobErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AzureBlobErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_fragment_complete Event

Fires after each block in an automatic block-based upload is complete.

Syntax

class AzureBlobFragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

  @property
  def fragment_count() -> int: ...

  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class AzureBlob:
@property
def on_fragment_complete() -> Callable[[AzureBlobFragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[AzureBlobFragmentCompleteEventParams], None]) -> None: ...

Remarks

When create_blob is used to create a new block blob, and more than SimpleUploadLimit bytes of upload data is provided, the class will automatically split the upload data up into blocks to perform the upload. During the overall upload process, this event will fire after each block is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current block that has completed. This value starts at 1.

FragmentCount is the total number of blocks that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

Refer to create_blob for more information.

on_header Event

This event is fired every time a header line comes in.

Syntax

class AzureBlobHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class AzureBlob:
@property
def on_header() -> Callable[[AzureBlobHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[AzureBlobHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

This event fires once for each log message.

Syntax

class AzureBlobLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class AzureBlob:
@property
def on_log() -> Callable[[AzureBlobLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AzureBlobLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_metadata_list Event

Fires once for each metadata item returned when listing metadata.

Syntax

class AzureBlobMetadataListEventParams(object):
  @property
  def container() -> str: ...

  @property
  def blob() -> str: ...

  @property
  def snapshot() -> str: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class AzureBlob:
@property
def on_metadata_list() -> Callable[[AzureBlobMetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[AzureBlobMetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when get_blob_info or get_container_info is called. If the ListWithMetadata configuration setting is enabled, it also fires as metadata for each individual blob or container is returned when list_blobs or list_containers is called.

Container is the name of the container that the blob is in (if Blob is non-empty), or that the metadata item is associated with (if Blob is empty).

Blob, if non-empty, is the name of the blob that the metadata item is associated with.

Snapshot, if non-empty, is the opaque DateTime value that identifiers the blob snapshot that the metadata item is associated with.

Name is the name of the metadata item, without the x-ms-meta- prefix.

Value the metadata item's value.

on_prefix_list Event

Fires once for each common prefix returned when listing blobs.

Syntax

class AzureBlobPrefixListEventParams(object):
  @property
  def prefix() -> str: ...

# In class AzureBlob:
@property
def on_prefix_list() -> Callable[[AzureBlobPrefixListEventParams], None]: ...
@on_prefix_list.setter
def on_prefix_list(event_hook: Callable[[AzureBlobPrefixListEventParams], None]) -> None: ...

Remarks

This event fires once for each common prefix returned when list_blobs is called when blob_delimiter is non-empty. Refer to blob_delimiter for more information.

Prefix is the common prefix.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

class AzureBlobProgressEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def total_bytes() -> int: ...

  @property
  def percent_done() -> int: ...

# In class AzureBlob:
@property
def on_progress() -> Callable[[AzureBlobProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[AzureBlobProgressEventParams], None]) -> None: ...

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class AzureBlobSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AzureBlob:
@property
def on_ssl_server_authentication() -> Callable[[AzureBlobSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AzureBlobSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class AzureBlobSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AzureBlob:
@property
def on_ssl_status() -> Callable[[AzureBlobSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AzureBlobSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class AzureBlobStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class AzureBlob:
@property
def on_start_transfer() -> Callable[[AzureBlobStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[AzureBlobStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

This event is fired while a document transfers (delivers document).

Syntax

class AzureBlobTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class AzureBlob:
@property
def on_transfer() -> Callable[[AzureBlobTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[AzureBlobTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

AzureBlob Config Settings

AzureBlob Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----