This article shows how to delete containers with theAzure Storage client library for Python. If you've enabledcontainer soft delete, you can restore deleted containers.

To learn about deleting a blob container using asynchronous APIs, seeDelete a container asynchronously.

Prerequisites

• Azure subscription -create one for free
• Azure storage account -create a storage account
• Python 3.8+

Set up your environment

If you don't have an existing project, this section shows you how to set up a project to work with the Azure Blob Storage client library for Python. For more details, seeGet started with Azure Blob Storage and Python.

To work with the code examples in this article, follow these steps to set up your project.

Install packages

Install the following packages usingpip install:

pip install azure-storage-blob azure-identity

Add import statements

Add the followingimport statements:

from azure.identity import DefaultAzureCredentialfrom azure.storage.blob import BlobServiceClient

Authorization

The authorization mechanism must have the necessary permissions to delete or restore a container. For authorization with Microsoft Entra ID (recommended), you need Azure RBAC built-in roleStorage Blob Data Contributor or higher. To learn more, see the authorization guidance forDelete Container (REST API) andRestore Container (REST API).

Create a client object

To connect an app to Blob Storage, create an instance ofBlobServiceClient. The following example shows how to create a client object usingDefaultAzureCredential for authorization:

# TODO: Replace <storage-account-name> with your actual storage account nameaccount_url = "https://<storage-account-name>.blob.core.windows.net"credential = DefaultAzureCredential()# Create the BlobServiceClient objectblob_service_client = BlobServiceClient(account_url, credential=credential)

You can also create client objects for specificcontainers orblobs, either directly or from theBlobServiceClient object. To learn more about creating and managing client objects, seeCreate and manage client objects that interact with data resources.

Delete a container

To delete a container in Python, use the following method from theBlobServiceClient class:

• BlobServiceClient.delete_container

You can also delete a container using the following method from theContainerClient class:

• ContainerClient.delete_container

After you delete a container, you can't create a container with the same name forat least 30 seconds. Attempting to create a container with the same name will fail with HTTP error code409 (Conflict). Any other operations on the container or the blobs it contains will fail with HTTP error code404 (Not Found).

The following example uses aBlobServiceClient object to delete the specified container:

def delete_container(self, blob_service_client: BlobServiceClient, container_name):    container_client = blob_service_client.get_container_client(container=container_name)    container_client.delete_container()

The following example shows how to delete all containers that start with a specified prefix:

def delete_container_prefix(self, blob_service_client: BlobServiceClient):    container_list = list(blob_service_client.list_containers(name_starts_with="test-"))    assert len(container_list) >= 1    for container in container_list:        # Find containers with the specified prefix and delete        container_client = blob_service_client.get_container_client(container=container.name)        container_client.delete_container()

Restore a deleted container

When container soft delete is enabled for a storage account, a deleted container and its contents may be recovered within a specified retention period. To learn more about container soft delete, seeEnable and manage soft delete for containers. You can restore a soft-deleted container by calling the following method of theBlobServiceClient class:

• BlobServiceClient.undelete_container

The following example finds a deleted container, gets the version of that deleted container, and then passes the version into theundelete_container method to restore the container.

def restore_deleted_container(self, blob_service_client: BlobServiceClient, container_name):    container_list = list(        blob_service_client.list_containers(include_deleted=True))    assert len(container_list) >= 1    for container in container_list:        # Find the deleted container and restore it        if container.deleted and container.name == container_name:            restored_container_client = blob_service_client.undelete_container(                deleted_container_name=container.name, deleted_container_version=container.version)

Delete a container asynchronously

The Azure Blob Storage client library for Python supports deleting a blob container asynchronously. To learn more about project setup requirements, seeAsynchronous programming.

Follow these steps to delete a container using asynchronous APIs:

1. Add the following import statements:

   import asynciofrom azure.identity.aio import DefaultAzureCredentialfrom azure.storage.blob.aio import BlobServiceClient

2. Add code to run the program usingasyncio.run. This function runs the passed coroutine,main() in our example, and manages theasyncio event loop. Coroutines are declared with the async/await syntax. In this example, themain() coroutine first creates the top levelBlobServiceClient usingasync with, then calls the method that deletes the container. Note that only the top level client needs to useasync with, as other clients created from it share the same connection pool.

   async def main():    sample = ContainerSamples()    # TODO: Replace <storage-account-name> with your actual storage account name    account_url = "https://<storage-account-name>.blob.core.windows.net"    credential = DefaultAzureCredential()    async with BlobServiceClient(account_url, credential=credential) as blob_service_client:        await sample.delete_container(blob_service_client, "sample-container")if __name__ == '__main__':    asyncio.run(main())

3. Add code to delete the container. The code is the same as the synchronous example, except that the method is declared with theasync keyword and theawait keyword is used when calling thedelete_container method.

   async def delete_container(self, blob_service_client: BlobServiceClient, container_name):    container_client = blob_service_client.get_container_client(container=container_name)    await container_client.delete_container()

With this basic setup in place, you can implement other examples in this article as coroutines using async/await syntax.

Resources

To learn more about deleting a container using the Azure Blob Storage client library for Python, see the following resources.

Code samples

• Viewsynchronous orasynchronous code samples from this article (GitHub)

REST API operations

The Azure SDK for Python contains libraries that build on top of the Azure REST API, allowing you to interact with REST API operations through familiar Python paradigms. The client library methods for deleting or restoring a container use the following REST API operations:

• Delete Container (REST API)
• Restore Container (REST API)

Client library resources

• Client library reference documentation
• Client library source code
• Package (PyPi)

See also

• Soft delete for containers
• Enable and manage soft delete for containers

Related content

• This article is part of the Blob Storage developer guide for Python. To learn more, see the full list of developer guide articles atBuild your Python app.