使用 JavaScript 删除和还原 blob 容器
本文介绍了如何使用适用于 JavaScript 的 Azure 存储客户端库删除容器。 如果已启用容器软删除,则可以还原已删除的容器。
先决条件
- 本文中的示例假设你已经设置了一个项目来使用适用于 JavaScript 的 Azure Blob 存储客户端库。 若要了解如何设置项目(包括安装包、导入模块,以及创建授权客户端对象来使用数据资源),请参阅开始使用 Azure Blob 存储和 JavaScript。
- 授权机制必须具有删除 blob 容器或还原软删除容器的权限。 若要了解详细信息,请参阅以下 REST API 操作的授权指南:
删除容器
若要在 JavaScript 中删除容器,请创建 BlobServiceClient 或 ContainerClient,然后使用以下方法之一:
- BlobServiceClient.deleteContainer
- ContainerClient.delete
- ContainerClient.deleteIfExists
删除容器后,至少在 30 秒内无法使用相同的名称创建容器。 尝试使用相同的名称创建容器将会失败,并出现 HTTP 错误代码 409(冲突)。 针对容器或其包含的 Blob 执行任何其他操作将会失败,并出现 HTTP 错误代码 404(未找到)。
使用 BlobServiceClient 删除容器
以下示例删除指定的容器。 使用 BlobServiceClient 删除容器:
// delete container immediately on blobServiceClient
async function deleteContainerImmediately(blobServiceClient, containerName) {
const response = await blobServiceClient.deleteContainer(containerName);
if (!response.errorCode) {
console.log(`deleted ${containerItem.name} container`);
}
}
使用 ContainerClient 删除容器
以下示例演示如何使用 ContainerClient 删除以指定前缀开头的所有容器。
async function deleteContainersWithPrefix(blobServiceClient, blobNamePrefix){
const containerOptions = {
includeDeleted: false,
includeMetadata: false,
includeSystem: true,
prefix: blobNamePrefix
}
for await (const containerItem of blobServiceClient.listContainers(containerOptions)) {
const containerClient = blobServiceClient.getContainerClient(containerItem.name);
const response = await containerClient.delete();
if(!response.errorCode){
console.log(`deleted ${containerItem.name} container`);
}
}
}
还原软删除的容器
为存储帐户启用容器软删除后,容器及其内容被删除后可以在指定的保持期内恢复。 可以使用 BlobServiceClient 对象还原软删除的容器:
- BlobServiceClient.undeleteContainer
以下示例查找已删除的容器,获取该已删除容器的版本 ID,然后将该 ID 传递到 undeleteContainer 方法以还原该容器。
// Undelete specific container - last version
async function undeleteContainer(blobServiceClient, containerName) {
// version to undelete
let containerVersion;
const containerOptions = {
includeDeleted: true,
prefix: containerName
}
// container listing returns version (timestamp) in the ContainerItem
for await (const containerItem of blobServiceClient.listContainers(containerOptions)) {
// if there are multiple deleted versions of the same container,
// the versions are in asc time order
// the last version is the most recent
if (containerItem.name === containerName) {
containerVersion = containerItem.version;
}
}
const containerClient = await blobServiceClient.undeleteContainer(
containerName,
containerVersion,
// optional/new container name - if unused, original container name is used
//newContainerName
);
// undelete was successful
console.log(`${containerName} is undeleted`);
// do something with containerClient
// ...
}
资源
若要详细了解如何使用适用于 JavaScript 的 Azure Blob 存储客户端库来删除容器,请参阅以下资源。
REST API 操作
Azure SDK for JavaScript 包含基于 Azure REST API 而生成的库,允许你通过熟悉的 JavaScript 范例与 REST API 操作进行交互。 用于删除或还原容器的客户端库方法使用以下 REST API 操作: