Skip to content

Latest commit

 

History

History
106 lines (63 loc) · 7.06 KB

storage-blob-container-delete-python.md

File metadata and controls

106 lines (63 loc) · 7.06 KB
Raw
title titleSuffix description services author ms.service ms.topic ms.date ms.author ms.devlang ms.custom
Delete and restore a blob container with Python
Azure Storage
Learn how to delete and restore a blob container in your Azure Storage account using the Python client library.
storage
pauljewellmsft
azure-blob-storage
how-to
12/20/2023
pauljewell
python
devx-track-python, devguide-python

Delete and restore a blob container with Python

[!INCLUDE storage-dev-guide-selector-delete-container]

This article shows how to delete containers with the Azure Storage client library for Python. If you've enabled container soft delete, you can restore deleted containers.

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

Prerequisites

  • This article assumes you already have a project set up to work with the Azure Blob Storage client library for Python. To learn about setting up your project, including package installation, adding import statements, and creating an authorized client object, see Get started with Azure Blob Storage and Python.
  • The authorization mechanism must have permissions to delete a blob container, or to restore a soft-deleted container. To learn more, see the authorization guidance for the following REST API operations:

Delete a container

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

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

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

The following example uses a BlobServiceClient object to delete the specified container:

:::code language="python" source="~/azure-storage-snippets/blobs/howto/python/blob-devguide-py/blob_devguide_delete_container.py" id="Snippet_delete_container":::

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

:::code language="python" source="~/azure-storage-snippets/blobs/howto/python/blob-devguide-py/blob_devguide_delete_container.py" id="Snippet_delete_container_prefix":::

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, see Enable and manage soft delete for containers. You can restore a soft-deleted container by calling the following method of the BlobServiceClient class:

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

:::code language="python" source="~/azure-storage-snippets/blobs/howto/python/blob-devguide-py/blob_devguide_delete_container.py" id="Snippet_restore_container":::

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, see Asynchronous programming.

Follow these steps to delete a container using asynchronous APIs:

  1. Add the following import statements:

    import asyncio

from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient

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

    :::code language="python" source="~/azure-storage-snippets/blobs/howto/python/blob-devguide-py/blob_devguide_delete_container_async.py" id="Snippet_create_client_async":::

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

    :::code language="python" source="~/azure-storage-snippets/blobs/howto/python/blob-devguide-py/blob_devguide_delete_container_async.py" id="Snippet_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.

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:

Code samples

[!INCLUDE storage-dev-guide-resources-python]

See also