AzureBlobConnector

class pfore_cloud_utilities.AzureBlobConnector(account_url, azure_tenant_id=None, spn_client_id=None, spn_client_secret=None)

Singleton class to interact with an Azure Blob Storage container.

The classes handle connection, reads and writes inside the container.

Connection is created using either a Managed Identity or an SPN.

Upon instantiation, if azure_tenant_id, spn_client_id and spn_client_secret are all set to None, the client will assume Managed Identity as an authentication method.

Parameters:

• account_url (str) – Storage Account url, required

• azure_tenant_id (Optional[str]) – Azure tenant ID

• spn_client_id (Optional[str]) – Service Principal client ID

• spn_client_secret (Optional[str]) – Service Principal client secret

Raises:

ValueError – If one of the arguments for SPN-based auth is missing

download()

AzureBlobConnector.download(container_name, path)

Downloads content from blob storage.

Parameters:

• container_name (str) – Name of the blob container

• path (str) – Blob path to read

Return type:

bytes

Returns:

Blob content in bytes

list_blobs_in_directory()

AzureBlobConnector.list_blobs_in_directory(container_name, path)

Lists blobs in a subdirectory for a given path in the blob storage.

Parameters:

• container_name (str) – Name of the blob container

• path (str) – Path to subdirectory

Return type:

List[str]

Returns:

List of blobs names, where a blob’s name is the relative path of the blob inside the container

upload()

AzureBlobConnector.upload(contents, container_name, path)

Uploads content in bytes to a blob container.

Parameters:

• contents (Union[bytes, str, Iterable[AnyStr], IO[AnyStr]]) – Contents to upload, in bytes

• container_name (str) – Name of the blob container, if it doesn’t exist it will be created as long as permission scope allows it

• path (str) – Blob path to write to

Return type:

None