你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
设置文件元数据
操作 Set File Metadata 为指定文件设置用户定义的元数据。
协议可用性
| 已启用文件共享协议 | 可用 |
|---|---|
| SMB |  |
| NFS |  |
请求
可以按如下所示构造 Set File Metadata 请求。 建议使用 HTTPS。
| 方法 | 请求 URI | HTTP 版本 |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
HTTP/1.1 |
将请求 URI 中显示的路径组件替换为自己的组件，如下所示：
| 路径组件 | 说明 |
|---|---|
myaccount |
存储帐户的名称。 |
myshare |
文件共享的名称。 |
mydirectorypath |
可选。 父目录的路径。 |
myfile |
文件的名称。 |
有关路径命名限制的信息，请参阅 名称和引用共享、目录、文件和元数据。
URI 参数
可以在请求 URI 中指定以下附加参数：
| 参数 | 说明 |
|---|---|
timeout |
可选。 超时参数以秒表示。 有关详细信息，请参阅 设置文件服务操作的超时。 |
请求标头
| 请求标头 | 说明 |
|---|---|
Authorization |
必需。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
Date 或 x-ms-date |
必需。 指定请求的协调世界时 (UTC)。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
x-ms-version |
对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息，请参阅 Azure 存储服务的版本控制。 |
x-ms-meta-name:value |
可选。 为文件设置名称-值对。 每次调用此操作都会替换附加到该文件的所有现有元数据。 要从该文件中删除所有元数据，请不带任何元数据头调用此操作。 元数据名称必须遵循 C# 标识符的命名规则。 |
x-ms-lease-id:<ID> |
如果文件具有活动租约，则为必需。 适用于版本 2019-02-02 及更高版本。 |
x-ms-client-request-id |
可选。 提供客户端生成的不透明值，其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅监视Azure 文件存储。 |
x-ms-file-request-intent |
如果 Authorization 标头指定 OAuth 令牌，则为必需。 可接受的值为 backup。 此标头指定Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action，如果 或 包含在分配给使用 标头授权的标识的 RBAC 策略中，则应授予 或Authorization。 适用于版本 2022-11-02 及更高版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
可选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。 有关详细信息，请参阅 命名和引用共享、目录、文件和元数据。 |
请求正文
无。
响应
响应包括 HTTP 状态代码和一组响应标头。
状态代码
此操作成功后返回状态代码 200（正常）。
有关状态代码的信息，请参阅 状态和错误代码。
响应标头
此操作的响应包括以下标头。 该响应还可能包括其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范。
| 响应标头 | 说明 |
|---|---|
ETag |
包含一个值，该值表示文件的版本。 该值用引号引起来。 |
x-ms-request-id |
唯一标识发出的请求，并可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。 |
x-ms-version |
指示用于执行请求的文件服务的版本。 |
Date 或 x-ms-date |
由服务生成的 UTC 日期/时间值，指示启动响应的时间。 |
x-ms-request-server-encrypted: true/false |
版本 2017-04-17 及更高版本。 如果使用指定的算法成功加密请求的内容，则此标头的值设置为 true 。 否则，该值将设置为 false。 |
x-ms-client-request-id |
可用于对请求和相应响应进行故障排除。 如果请求中存在此标头的值，并且该值包含不超过 1，024 个可见 ASCII 字符，则此标头的值等于该标头的值 x-ms-client-request-id 。 x-ms-client-request-id如果请求中不存在标头，则它不会出现在响应中。 |
响应正文
无。
授权
只有帐户所有者可以调用此操作。
注解
Set File Metadata共享快照不受支持，共享是共享的只读副本。 尝试对共享快照执行此操作失败， (InvalidQueryParameterValue)
如果文件具有活动租约，则客户端必须在请求中指定有效的租约 ID，以便将元数据写入文件。 如果客户端未指定租约 ID 或指定无效的租用 ID，则文件服务将返回状态代码 412 (先决条件失败) 。 如果客户端指定租约 ID，但文件没有活动租约，则文件服务还会返回状态代码 412 (先决条件失败) 。