Package: azure-storage-blob
Azure Storage Blobs client library for PythonAzure Blob storage is Microsoft's object storage solution for the cloud. Blob storage is optimized for storing massive amounts of unstructured data, such as text or binary data.Blob storage is ideal for:Serving images or documents directly to a browserStoring files for distributed accessStreaming video and audioStoring data for backup and restore, disaster recovery, and archivingStoring data for analysis by an on-premises or Azure-hosted serviceSource code|Package (PyPI)|Package (Conda)|API reference documentation|Product documentation|SamplesGetting startedPrerequisitesPython 3.7 or later is required to use this package. For more details, please read our page onAzure SDK for Python version support policy.You must have anAzure subscriptionand anAzure storage accountto use this package.Install the packageInstall the Azure Storage Blobs client library for Python withpip:pipinstallazure-storage-blobCreate a storage accountIf you wish to create a new storage account, you can use theAzure Portal,Azure PowerShell,
orAzure CLI:# Create a new resource group to hold the storage account -# if using an existing resource group, skip this stepazgroupcreate--namemy-resource-group--locationwestus2# Create the storage accountazstorageaccountcreate-nmy-storage-account-name-gmy-resource-groupCreate the clientThe Azure Storage Blobs client library for Python allows you to interact with three types of resources: the storage
account itself, blob storage containers, and blobs. Interaction with these resources starts with an instance of aclient. To create a client object, you will need the storage account's blob service account URL and a
credential that allows you to access the storage account:fromazure.storage.blobimportBlobServiceClientservice=BlobServiceClient(account_url="https://<my-storage-account-name>.blob.core.windows.net/",credential=credential)Looking up the account URLYou can find the storage account's blob service URL using theAzure Portal,Azure PowerShell,
orAzure CLI:# Get the blob service account url for the storage accountazstorageaccountshow-nmy-storage-account-name-gmy-resource-group--query"primaryEndpoints.blob"Types of credentialsThecredentialparameter may be provided in a number of different forms, depending on the type ofauthorizationyou wish to use:To use anAzure Active Directory (AAD) token credential,
provide an instance of the desired credential type obtained from theazure-identitylibrary.
For example,DefaultAzureCredentialcan be used to authenticate the client.This requires some initial setup:Install azure-identityRegister a new AAD applicationand give permissions to access Azure StorageGrant accessto Azure Blob data with RBAC in the Azure PortalSet the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRETUse the returned token credential to authenticate the client:fromazure.identityimportDefaultAzureCredentialfromazure.storage.blobimportBlobServiceClienttoken_credential=DefaultAzureCredential()blob_service_client=BlobServiceClient(account_url="https://<my_account_name>.blob.core.windows.net",credential=token_credential)To use ashared access signature (SAS) token,
provide the token as a string. If your account URL includes the SAS token, omit the credential parameter.
You can generate a SAS token from the Azure Portal under "Shared access signature" or use one of thegenerate_sas()functions to create a sas token for the storage account, container, or blob:fromdatetimeimportdatetime,timedeltafromazure.storage.blobimportBlobServiceClient,generate_account_sas,ResourceTypes,AccountSasPermissionssas_token=generate_account_sas(account_name="<storage-account-name>",account_key="<account-access-key>",resource_types=ResourceTypes(service=True),permission=AccountSasPermissions(read=True),expiry=datetime.utcnow()+timedelta(hours=1))blob_service_client=BlobServiceClient(account_url="https://<my_account_name>.blob.core.windows.net",credential=sas_token)To use a storage accountshared key(aka account key or access key), provide the key as a string. This can be found in the Azure Portal under the "Access Keys"
section or by running the following Azure CLI command:az storage account keys list -g MyResourceGroup -n MyStorageAccountUse the key as the credential parameter to authenticate the client:fromazure.storage.blobimportBlobServiceClientservice=BlobServiceClient(account_url="https://<my_account_name>.blob.core.windows.net",credential="<account_access_key>")If you are usingcustomized url(which means the url is not in this format<my_account_name>.blob.core.windows.net),
please instantiate the client using the credential below:fromazure.storage.blobimportBlobServiceClientservice=BlobServiceClient(account_url="https://<my_account_name>.blob.core.windows.net",credential={"account_name":"<your_account_name>","account_key":"<account_access_key>"})To useanonymous public read access,
simply omit the credential parameter.Creating the client from a connection stringDepending on your use case and authorization method, you may prefer to initialize a client instance with a storage
connection string instead of providing the account URL and credential separately. To do this, pass the storage
connection string to the client'sfrom_connection_stringclass method:fromazure.storage.blobimportBlobServiceClientconnection_string="DefaultEndpointsProtocol=https;AccountName=xxxx;AccountKey=xxxx;EndpointSuffix=core.windows.net"service=BlobServiceClient.from_connection_string(conn_str=connection_string)The connection string to your storage account can be found in the Azure Portal under the "Access Keys" section or by running the following CLI command:azstorageaccountshow-connection-string-gMyResourceGroup-nMyStorageAccountKey conceptsThe following components make up the Azure Blob Service:The storage account itselfA container within the storage accountA blob within a containerThe Azure Storage Blobs client library for Python allows you to interact with each of these components through the
use of a dedicated client object.ClientsFour different clients are provided to interact with the various components of the Blob Service:BlobServiceClient-
this client represents interaction with the Azure storage account itself, and allows you to acquire preconfigured
client instances to access the containers and blobs within. It provides operations to retrieve and configure the
account properties as well as list, create, and delete containers within the account. To perform operations on a
specific container or blob, retrieve a client using theget_container_clientorget_blob_clientmethods.ContainerClient-
this client represents interaction with a specific container (which need not exist yet), and allows you to acquire
preconfigured client instances to access the blobs within. It provides operations to create, delete, or configure a
container and includes operations to list, upload, and delete the blobs within it. To perform operations on a
specific blob within the container, retrieve a client using theget_blob_clientmethod.BlobClient-
this client represents interaction with a specific blob (which need not exist yet). It provides operations to
upload, download, delete, and create snapshots of a blob, as well as specific operations per blob type.BlobLeaseClient-
this client represents lease interactions with aContainerClientorBlobClient. It provides operations to
acquire, renew, release, change, and break a lease on a specified resource.Async ClientsThis library includes a complete async API supported on Python 3.5+. To use it, you must
first install an async transport, such asaiohttp.
Seeazure-core documentationfor more information.Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define asyncclosemethods.Blob TypesOnce you've initialized a Client, you can choose from the different types of blobs:Block blobsstore text and binary data, up to approximately 4.75 TiB. Block blobs are made up of blocks of data that can be
managed individuallyAppend blobsare made up of blocks like block blobs, but are optimized for append operations. Append blobs are ideal for scenarios
such as logging data from virtual machinesPage blobsstore random access files up to 8 TiB in size. Page blobs store virtual hard drive (VHD) files and serve as disks for
Azure virtual machinesExamplesThe following sections provide several code snippets covering some of the most common Storage Blob tasks, including:Create a containerUploading a blobDownloading a blobEnumerating blobsNote that a container must be created before to upload or download a blob.Create a containerCreate a container from where you can upload or download blobs.fromazure.storage.blobimportContainerClientcontainer_client=ContainerClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer")container_client.create_container()Use the async client to upload a blobfromazure.storage.blob.aioimportContainerClientcontainer_client=ContainerClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer")awaitcontainer_client.create_container()Uploading a blobUpload a blob to your containerfromazure.storage.blobimportBlobClientblob=BlobClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer",blob_name="my_blob")withopen("./SampleSource.txt","rb")asdata:blob.upload_blob(data)Use the async client to upload a blobfromazure.storage.blob.aioimportBlobClientblob=BlobClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer",blob_name="my_blob")withopen("./SampleSource.txt","rb")asdata:awaitblob.upload_blob(data)Downloading a blobDownload a blob from your containerfromazure.storage.blobimportBlobClientblob=BlobClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer",blob_name="my_blob")withopen("./BlockDestination.txt","wb")asmy_blob:blob_data=blob.download_blob()blob_data.readinto(my_blob)Download a blob asynchronouslyfromazure.storage.blob.aioimportBlobClientblob=BlobClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer",blob_name="my_blob")withopen("./BlockDestination.txt","wb")asmy_blob:stream=awaitblob.download_blob()data=awaitstream.readall()my_blob.write(data)Enumerating blobsList the blobs in your containerfromazure.storage.blobimportContainerClientcontainer=ContainerClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer")blob_list=container.list_blobs()forblobinblob_list:print(blob.name+'\n')List the blobs asynchronouslyfromazure.storage.blob.aioimportContainerClientcontainer=ContainerClient.from_connection_string(conn_str="<connection_string>",container_name="mycontainer")blob_list=[]asyncforblobincontainer.list_blobs():blob_list.append(blob)print(blob_list)Optional ConfigurationOptional keyword arguments that can be passed in at the client and per-operation level.Retry Policy configurationUse the following keyword arguments when instantiating a client to configure the retry policy:retry_total(int): Total number of retries to allow. Takes precedence over other counts.
Pass inretry_total=0if you do not want to retry on requests. Defaults to 10.retry_connect(int): How many connection-related errors to retry on. Defaults to 3.retry_read(int): How many times to retry on read errors. Defaults to 3.retry_status(int): How many times to retry on bad status codes. Defaults to 3.retry_to_secondary(bool): Whether the request should be retried to secondary, if able.
This should only be enabled of RA-GRS accounts are used and potentially stale data can be handled.
Defaults toFalse.Encryption configurationUse the following keyword arguments when instantiating a client to configure encryption:require_encryption(bool): If set to True, will enforce that objects are encrypted and decrypt them.encryption_version(str): Specifies the version of encryption to use. Current options are'2.0'or'1.0'and
the default value is'1.0'. Version 1.0 is deprecated, and it ishighly recommendedto use version 2.0.key_encryption_key(object): The user-provided key-encryption-key. The instance must implement the following methods:wrap_key(key)--wraps the specified key using an algorithm of the user's choice.get_key_wrap_algorithm()--returns the algorithm used to wrap the specified symmetric key.get_kid()--returns a string key id for this key-encryption-key.key_resolver_function(callable): The user-provided key resolver. Uses the kid string to return a key-encryption-key
implementing the interface defined above.Other client / per-operation configurationOther optional configuration keyword arguments that can be specified on the client or per-operation.Client keyword arguments:connection_timeout(int): The number of seconds the client will wait to establish a connection to the server.
Defaults to 20 seconds.read_timeout(int): The number of seconds the client will wait, between consecutive read operations, for a
response from the server. This is a socket level timeout and is not affected by overall data size. Client-side read
timeouts will be automatically retried. Defaults to 60 seconds.transport(Any): User-provided transport to send the HTTP request.Per-operation keyword arguments:raw_response_hook(callable): The given callback uses the response returned from the service.raw_request_hook(callable): The given callback uses the request before being sent to service.client_request_id(str): Optional user specified identification of the request.user_agent(str): Appends the custom value to the user-agent header to be sent with the request.logging_enable(bool): Enables logging at the DEBUG level. Defaults to False. Can also be passed in at
the client level to enable it for all requests.logging_body(bool): Enables logging the request and response body. Defaults to False. Can also be passed in at
the client level to enable it for all requests.headers(dict): Pass in custom headers as key, value pairs. E.g.headers={'CustomValue': value}TroubleshootingGeneralStorage Blob clients raise exceptions defined inAzure Core.This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use theerror_codeattribute, i.e,exception.error_code.LoggingThis library uses the standardlogginglibrary for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with thelogging_enableargument:importsysimportloggingfromazure.storage.blobimportBlobServiceClient# Create a logger for the 'azure.storage.blob' SDKlogger=logging.getLogger('azure.storage.blob')logger.setLevel(logging.DEBUG)# Configure a console outputhandler=logging.StreamHandler(stream=sys.stdout)logger.addHandler(handler)# This client will log detailed information about its HTTP sessions, at DEBUG levelservice_client=BlobServiceClient.from_connection_string("your_connection_string",logging_enable=True)Similarly,logging_enablecan enable detailed logging for a single operation,
even when it isn't enabled for the client:service_client.get_service_stats(logging_enable=True)Next stepsMore sample codeGet started with ourBlob samples.Several Storage Blobs Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Storage Blobs:blob_samples_container_access_policy.py(async version) - Examples to set Access policies:Set up Access Policy for containerblob_samples_hello_world.py(async version) - Examples for common Storage Blob tasks:Set up a containerCreate a block, page, or append blobUpload blobsDownload blobsDelete blobsblob_samples_authentication.py(async version) - Examples for authenticating and creating the client:From a connection stringFrom a shared access keyFrom a shared access signature tokenFrom active directoryblob_samples_service.py(async version) - Examples for interacting with the blob service:Get account informationGet and set service propertiesGet service statisticsCreate, list, and delete containersGet the Blob or Container clientblob_samples_containers.py(async version) - Examples for interacting with containers:Create a container and delete containersSet metadata on containersGet container propertiesAcquire a lease on containerSet an access policy on a containerUpload, list, delete blobs in containerGet the blob client to interact with a specific blobblob_samples_common.py(async version) - Examples common to all types of blobs:Create a snapshotDelete a blob snapshotSoft delete a blobUndelete a blobAcquire a lease on a blobCopy a blob from a URLblob_samples_directory_interface.py- Examples for interfacing with Blob storage as if it were a directory on a filesystem:Copy (upload or download) a single file or directoryList files or directories at a single level or recursivelyDelete a single file or recursively delete a directoryAdditional documentationFor more extensive documentation on Azure Blob storage, see theAzure Blob storage documentationon docs.microsoft.com.ContributingThis project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visithttps://cla.microsoft.com.When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.This project has adopted theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQor contactopencode@microsoft.comwith any additional questions or comments.