你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
设置文件元数据
Set File Metadata作为指定文件设置用户定义的元数据。 在版本 2025-05-05 及更高版本中支持此作，以启用 NFS 协议的文件共享。
协议可用性
| 已启用文件共享协议 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
请求
Set File Metadata 请求构造如下。 建议使用 HTTPS。
| 方法 | 请求 URI | HTTP 版本 |
|---|---|---|
| 放 | 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 |
所有授权请求都是必需的。 指定要用于此请求的作的版本。 在版本 2025-05-05 及更高版本中支持此作，以启用 NFS 协议的文件共享。 有关详细信息，请参阅 azure 存储服务 版本控制。 |
x-ms-meta-name:value |
自选。 设置文件的名称/值对。 每次调用此作都会替换附加到文件的所有现有元数据。 若要从文件中删除所有元数据，请调用不带元数据标头的此作。 元数据名称必须遵循 C# 标识符的命名规则。 |
x-ms-lease-id:<ID> |
如果文件具有活动租约，则为必需。 适用于版本 2019-02-02 及更高版本。 如果文件位于启用了 NFS 协议的文件共享上，则忽略此标头，不支持文件租用。 |
x-ms-client-request-id |
自选。 提供客户端生成的不透明值，该值具有配置日志记录时日志中记录的 1-kibibyte （KiB） 字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅 监视 Azure 文件。 |
x-ms-file-request-intent |
如果需要 Authorization 标头指定 OAuth 令牌。 可接受的值为 backup。 此标头指定，如果 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 包含在分配给使用 Authorization 标头授权的标识的 RBAC 策略中，则应授予 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action。 适用于版本 2022-11-02 及更高版本。 |
x-ms-allow-trailing-dot: { <Boolean> } |
自选。 版本 2022-11-02 及更高版本。 布尔值指定是否应剪裁请求 URL 中存在的尾随点。 如果目标位于启用了 NFS 协议的文件共享上，则默认支持尾随点，则忽略此标头。 有关详细信息，请参阅 命名和引用共享、目录、文件和元数据。 |
仅 SMB 请求标头
没有。
仅 NFS 请求标头
没有。
请求正文
没有。
响应
响应包括 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 |
可用于对请求和相应的响应进行故障排除。 如果此标头存在于请求中，则此标头的值等于 x-ms-client-request-id 标头的值，并且该值包含不超过 1,024 个可见 ASCII 字符。 如果请求中不存在 x-ms-client-request-id 标头，则响应中不会显示该标头。 |
仅 SMB 响应标头
没有。
仅 NFS 响应标头
没有。
响应正文
没有。
授权
只有帐户所有者才能调用此作。
言论
共享快照不支持 Set File Metadata，这是共享的只读副本。 尝试对共享快照执行此作失败，并出现 400 （InvalidQueryParameterValue）
如果文件具有活动租约，客户端必须在请求上指定有效的租约 ID，才能将元数据写入文件。 如果客户端未指定租约 ID 或指定无效的租约 ID，则文件服务将返回状态代码 412（前置条件失败）。 如果客户端指定租约 ID 但文件没有活动租约，则文件服务还会返回状态代码 412（前置条件失败）。