你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

删除共享

操作Delete Share删除指定的共享或共享快照。 此 API 完全受支持,但请注意,这是旧版管理 API。

最好改用 文件共享 - 删除 。 它由存储资源提供程序 (Microsoft.Storage) 提供。 若要详细了解如何使用存储资源提供程序以编程方式与 FileShare 资源交互,请参阅 对 FileShares 的操作

协议可用性

已启用文件共享协议 可用
SMB 是
NFS 是

请求

可以按如下所示构造 Delete Share 请求。 建议使用 HTTPS。

方法 请求 URI HTTP 版本
DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
DELETE https://myaccount.file.core.windows.net/myshare?sharesnapshot=<DateTime>&restype=share HTTP/1.1

将请求 URI 中所示的路径组件替换为你自己的组件,如下所示:

路径组件 说明
myaccount 存储帐户的名称。
myshare 文件共享的名称。

有关路径命名限制的详细信息,请参阅 命名和引用共享、目录、文件和元数据

URI 参数

可以在请求 URI 中指定以下附加参数。

参数 说明
sharesnapshot 可选。 版本 2017-04-17 及更高版本。 参数sharesnapshot是一个不透明的DateTime值,如果存在,则指定要删除的共享快照。
timeout 可选。 timeout 参数以秒表示。 有关详细信息,请参阅设置Azure 文件存储操作的超时

请求标头

下表介绍必需的和可选的请求标头。

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
x-ms-delete-snapshots: { include, include-leased } 如果共享具有关联的快照,则为可选。 指定以下选项之一:
  • include:删除基本共享及其所有快照。
  • include-leased:版本 2020-02-10 及更高版本。 删除基本共享及其所有快照,即使一个或多个快照具有活动共享租约。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure 文件存储
x-ms-lease-id: <ID> 如果目标文件共享具有有效的租约,则是必需的。 适用于版本 2020-02-10 及更高版本。 如果请求不包含租约 ID 或无效,则操作将失败,状态代码为 412 (先决条件失败) 。

如果指定了此标头,并且目标文件共享当前没有活动租约,则操作也会失败,状态代码为 412 (前置条件失败) 。

请求正文

无。

示例请求

DELETE https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2014-02-14  
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT  
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ= TBD  

响应

响应包括 HTTP 状态代码和一组响应标头。

状态代码

成功的操作将返回状态代码 202(已接受)。 有关状态代码的信息,请参阅 状态和错误代码

响应头

此操作的响应包括以下标头。 响应还可以包含其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范

响应标头 说明
x-ms-request-id 此标头唯一标识发出的请求,可用于对请求进行故障排除。 有关详细信息,请参阅 API 操作故障排除
x-ms-version 指示用于运行请求Azure 文件存储的版本。
Datex-ms-date 指示启动响应的时间的 UTC 日期/时间值。 服务生成此值。
x-ms-client-request-id 可以使用此标头对请求和相应的响应进行故障排除。 如果请求中存在,则此标头的值等于 标头的值 x-ms-client-request-id 。 该值最多为 1,024 个可见 ASCII 字符。 x-ms-client-request-id如果请求中不存在标头,则响应中不会显示此标头。

响应正文

无。

授权

只有帐户所有者才能调用此操作。

注解

删除共享时,不能在至少 30 秒内创建同名共享。 删除共享时,尝试重新创建同名共享将失败,状态代码为 409 (冲突) 。 服务返回其他错误信息,指示共享正在删除。 在删除共享时,所有其他操作(包括对共享下的任何文件执行的操作)将失败并返回状态代码 404(“找不到”)。

目前,不允许删除包含快照的共享。 共享快照可以单独删除,也可以使用 标头与共享 x-ms-delete-snapshots=include 一起删除。

应仅为针对基本共享资源的请求指定 x-ms-delete-snapshots 。 如果在删除单个快照的请求中指定此标头,Azure 文件存储将返回状态代码 400 (查询参数值) 无效。 如果未在删除请求中指定此标头,并且共享具有关联的快照,则Azure 文件存储返回状态代码 409 (Share Has Snapshots) 。

另请参阅

共享 (Azure 文件存储) 的操作