你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取共享元数据
该Get Share Metadata操作返回 Azure 文件共享或共享快照的所有用户定义元数据。
尽管此 API 完全受支持，但它是旧版管理 API。 出于此原因，建议改用存储资源提供程序提供的 “文件共享 - 获取”， (Microsoft.Storage) 。
若要详细了解如何使用存储资源提供程序以编程方式与 FileShare 资源交互，请参阅 Azure 文件共享上的操作。
协议可用性
| 已启用文件共享协议 | 可用 |
|---|---|
| SMB |  |
| NFS | |
请求
按如下方式构建Get Share Metadata请求。 建议使用 HTTPS。
| 方法 | 请求 URI | HTTP 版本 |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata&sharesnapshot=<DateTime> |
HTTP/1.1 |
将请求 URI 中显示的路径组件替换为自己的组件，如下所示：
| 路径组件 | 说明 |
|---|---|
myaccount |
存储帐户的名称。 |
myshare |
文件共享的名称。 |
有关路径命名限制的信息，请参阅 名称和引用共享、目录、文件和元数据。
URI 参数
可以在请求 URI 中指定以下附加参数：
| 参数 | 说明 |
|---|---|
sharesnapshot |
可选。 版本 2017-04-17 及更高版本。 参数sharesnapshot是一个不透明的日期/时间值，如果存在，则指定要查询以检索元数据的共享快照 |
timeout |
可选。 timeout 参数以秒表示。 有关详细信息，请参阅为Azure 文件存储操作设置超时。 |
请求标头
| 请求标头 | 说明 |
|---|---|
Authorization |
必需。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
Date 或 x-ms-date |
必需。 指定请求的协调世界时 (UTC)。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
x-ms-version |
对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息，请参阅 Azure 存储服务的版本控制。 |
x-ms-client-request-id |
可选。 提供客户端生成的不透明值，其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅监视Azure 文件存储。 |
x-ms-lease-id:<ID> |
可选。 版本 2020-02-10 及更高版本。 如果指定了 标头，则仅当文件共享的租约当前处于活动状态且请求中指定的租约 ID 与文件共享的租约 ID 匹配时，才会执行该操作。 如果没有匹配项，则操作失败，状态代码为 412 (前置条件失败) 。 |
请求正文
无。
响应
响应包括 HTTP 状态代码和一组响应标头。
状态代码
此操作成功后返回状态代码 200（正常）。
有关状态代码的详细信息，请参阅 状态和错误代码。
响应头
此操作的响应包括以下标头。 该响应还可能包括其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范。
| 响应标头 | 说明 |
|---|---|
Last-Modified |
返回上次修改共享的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息，请参阅 在标头中表示日期/时间值。 修改共享或其属性的任何操作都将更新上次修改时间。 对文件执行的操作不会影响共享的上次修改时间。 |
x-ms-meta-name:value |
一组名称/值对，其中包含共享的用户定义元数据。 |
ETag |
包含可用于有条件地执行操作的值。 该值用引号引起来。 |
x-ms-request-id |
唯一标识发出的请求，可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。 |
x-ms-version |
指示用于执行请求的Azure 文件存储版本。 |
Date 或 x-ms-date |
由服务生成的 UTC 日期/时间值，指示启动响应的时间。 |
x-ms-client-request-id |
可用于对请求及其相应响应进行故障排除。 如果请求中存在标头， x-ms-client-request-id 并且该值包含的可见 ASCII 字符不超过 1，024 个，则此标头的值等于标头的值。 x-ms-client-request-id如果请求中不存在标头，则响应中不会显示该标头。 |
响应正文
无。
示例响应
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: somemetadata
Date: Mon, 27 Jan 2014 22:49:18 GMT
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: Mon, 27 Jan 2014 22:48:29 GMT
x-ms-version: 2014-02-14
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
授权
只有帐户所有者可以调用此操作。
注解
此操作仅返回共享上的用户定义元数据。 若要也返回系统属性，请调用 获取共享属性。