使用 Python 删除和还原 Blob 容器

项目
10/15/2024

本文介绍了如何使用适用于 Python 的 Azure 存储客户端库删除容器。如果已启用容器软删除，则可以还原已删除的容器。

要了解如何使用异步 API 删除 blob 容器，请参阅异步删除容器。

先决条件

Azure 订阅 - 创建试用订阅。
Azure 存储帐户 - 创建存储帐户
Python 3.8+

设置你的环境

如果没有现有项目，请查看本部分，其中介绍如何设置项目来使用适用于 Python 的 Azure Blob 存储客户端库。有关更多详细信息，请参阅 Azure Blob 存储和 Python 入门。

要使用本文中的代码示例，请按照以下步骤设置项目。

安装包

使用 pip install 安装以下包：

pip install azure-storage-blob azure-identity

添加 import 语句

添加以下 import 语句：

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

授权

授权机制必须具有删除或还原容器所需的权限。若要使用 Microsoft Entra ID 进行授权（建议），需有 Azure RBAC 内置角色“存储 Blob 数据参与者”或更高级别的角色。有关详细信息，请参阅删除容器 (REST API) 和还原容器 (REST API) 的授权指南。

创建客户端对象

若要将应用连接到 Blob 存储，请创建 BlobServiceClient 的实例。以下示例演示如何使用 DefaultAzureCredential 创建客户端对象进行授权：

# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.chinacloudapi.cn"
credential = DefaultAzureCredential()

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=credential)

还可以为特定容器或 Blob 创建客户端对象，不管是直接创建还是通过 BlobServiceClient 对象创建。要详细了解如何创建和管理客户端对象，请参阅创建和管理与数据资源交互的客户端对象。

删除容器

若要在 Python 中删除容器，请使用 BlobServiceClient 类中的以下方法：

BlobServiceClient.delete_container

还可以使用 ContainerClient 类中的以下方法来删除容器：

ContainerClient.delete_container

删除容器后，至少在 30 秒内无法使用相同的名称创建容器。尝试使用相同的名称创建容器将会失败，并出现 HTTP 错误代码 409 (Conflict)。针对容器或其包含的 Blob 执行任何其他操作将会失败，并出现 HTTP 错误代码 404 (Not Found)。

下面的示例使用 BlobServiceClient 对象删除指定容器：

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()

以下示例演示如何删除以指定的前缀开头的所有容器：

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()

还原软删除的容器

为存储帐户启用容器软删除后，可以在指定的保持期内恢复删除的容器及其内容。若要详细了解容器软删除，请参阅启用和管理容器的软删除。可以通过调用 BlobServiceClient 类的以下方法来还原软删除的容器：

BlobServiceClient.undelete_container

以下示例查找已删除的容器，获取该已删除容器的版本，然后将该版本传递到 undelete_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)

异步删除容器

适用于 Python 的 Azure Blob 存储客户端库支持异步删除 blob 容器。要详细了解项目设置要求，请参阅异步编程。

按照以下步骤使用异步 API 删除容器：

添加以下 import 语句：

import asyncio

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

添加代码以使用asyncio.run运行程序。此函数运行传递的协同例程（我们示例中的main()），并管理asyncio事件循环。使用 async/await 语法声明协同例程。在此示例中，main() 协同例程先使用 async with 创建顶级 BlobServiceClient，然后调用删除容器的方法。请注意，只有顶级客户端需要使用async with，因为基于它创建的其他客户端会共享同一连接池。

async def main():
    sample = ContainerSamples()

    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.chinacloudapi.cn"
    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())

添加用于删除容器的代码。该代码与同步示例相同，除了该方法使用async关键字声明，await关键字在调用delete_container方法时使用。

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()

有了此基本设置，即可使用 async/await 语法将本文中的其他示例实现为协同例程。

资源

若要详细了解如何使用适用于 Python 的 Azure Blob 存储客户端库删除容器，请参阅以下资源。

代码示例

查看本文中的同步或异步代码示例 (GitHub)

REST API 操作

Azure SDK for Python 包含基于 Azure REST API 而生成的库，允许你通过熟悉的 Python 范例与 REST API 操作进行交互。用于删除或还原容器的客户端库方法使用以下 REST API 操作：

删除容器 (REST API)
还原容器 (REST API)

客户端库资源

请参阅

本文是 Python 版 Blob 存储开发人员指南的一部分。若要了解详细信息，请参阅生成 Python 应用中的开发人员指南文章的完整列表。

通过