你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取文件属性
Get File Properties 操作返回文件的所有用户定义的元数据、标准 HTTP 属性和系统属性。 它不会返回文件的内容。
协议可用性
| 已启用文件共享协议 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
请求
可以按如下方式构建Get File Properties请求。 建议使用 HTTPS。
| 方法 | 请求 URI | HTTP 版本 |
|---|---|---|
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile |
HTTP/1.1 |
HEAD |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime> |
HTTP/1.1 |
将请求 URI 中显示的路径组件替换为自己的组件，如下所示：
| 路径组件 | 说明 |
|---|---|
myaccount |
存储帐户的名称。 |
myshare |
文件共享的名称。 |
mydirectorypath |
可选。 父目录的路径。 |
myfile |
文件的名称。 |
有关路径命名限制的信息，请参阅 名称和引用共享、目录、文件和元数据。
URI 参数
可以在请求 URI 上指定以下附加参数：
| 参数 | 说明 |
|---|---|
sharesnapshot |
可选。 版本 2017-04-17 及更高版本。 参数sharesnapshot是一个不透明的 DateTime 值，如果存在，则指定要查询文件属性的共享快照。 |
timeout |
可选。
timeout 参数以秒表示。 有关详细信息，请参阅为Azure 文件存储操作设置超时。 |
请求标头
下表描述了必需的和可选的请求标头：
| 请求标头 | 说明 |
|---|---|
| 授权 | 必需。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
Date 或 x-ms-date |
必需。 指定请求的协调世界时 (UTC)。 有关详细信息，请参阅授权对 Azure 存储的请求。 |
x-ms-version |
对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息，请参阅 Azure 存储服务的版本控制。 |
x-ms-lease-id:<ID> |
可选。 版本 2019-02-02 及更高版本。 如果指定了 标头，则仅当文件的租约当前处于活动状态且请求中指定的租约 ID 与文件的租约 ID 匹配时，才会执行该操作。 如果不匹配，则操作将失败，状态代码为 412 (前置条件失败) 。 |
x-ms-client-request-id |
可选。 提供客户端生成的不透明值，其大小为 1-kib (KiB) 字符限制，启用 Azure 存储分析 日志记录时，该限制记录在分析日志中。 强烈建议在将客户端活动与服务器收到的请求相关联时使用此标头。 有关详细信息，请参阅监视Azure Blob 存储。 |
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 协议规范。
| 响应标头 | 说明 |
|---|---|
Last-Modified |
返回上次修改文件的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息，请参阅 在标头中表示日期/时间值。 修改文件或其属性的任何操作会更新上次修改时间。 |
x-ms-meta-name:value |
作为用户定义的元数据与此文件关联的一组名称/值对。 |
x-ms-type: <File> |
返回类型 File。 保留供将来使用。 |
Content-Length |
文件大小（字节）。 此标头返回随文件一起存储的标头的值 x-ms-content-length 。 |
Content-Type |
为文件指定的内容类型。 如果未指定内容类型，则默认内容类型为 application/octet-stream。 |
ETag |
ETag 包含一个值，你可以使用该值有条件地执行操作。 该值用引号引起来。 |
Content-MD5 |
如果为文件设置了 Content-MD5 标头，则会返回 Content-MD5 响应标头，以便客户端可以检查消息内容完整性。 |
Content-Encoding |
如果以前为文件设置了 Content-Encoding 请求标头，则会在此标头中返回 Content-Encoding 值。 |
Content-Language |
如果以前为文件设置了 Content-Language 请求标头，则会在此标头中返回 Content-Language 值。 |
Cache-Control |
如果以前为文件设置了 Cache-Control 请求标头，则会在此标头中返回 Cache-Control 值。 |
Content-Disposition |
返回为 x-ms-content-disposition 标头指定的值，并指定如何处理响应。响应 Content-Disposition 标头字段传达了有关如何处理响应有效负载的其他信息，你可以使用它附加其他元数据。 例如，如果设置为 attachment， Content-Disposition 则指示用户代理不应显示响应，但应改为显示“另存为”窗口。 |
x-ms-request-id |
唯一标识发出的请求，可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。 |
x-ms-version |
指示用于执行请求的服务版本。 |
Date |
由服务生成的 UTC 日期/时间值，指示启动响应的时间。 |
x-ms-copy-completion-time:<datetime> |
版本 2015-02-21 及更高版本。 上次尝试 复制文件 操作的结束时间，其中此文件是目标文件。 该值可以指定已完成、已中止或失败的复制尝试时间。 如果副本处于挂起状态，如果此文件从未成为复制文件操作中的目标，或者此文件在使用“设置文件属性”或“创建文件”完成复制文件操作后已修改，则不会显示此标头。 |
x-ms-copy-status-description: <error string> |
版本 2015-02-21 及更高版本。 仅在失败或挂起时x-ms-copy-status显示。 它描述了致命或非致命复制操作失败的原因。 如果副本处于挂起状态，如果此文件从未成为复制文件操作中的目标，或者此文件在使用“设置文件属性”或“创建文件”完成复制文件操作后已修改，则不会显示此标头。 |
x-ms-copy-id: <id> |
版本 2015-02-21 及更高版本。 上次尝试的 复制文件 操作的字符串标识符，其中此文件是目标文件。 如果此文件从未成为 复制文件 操作的目标，或者此文件在完成复制 文件 操作后使用 “设置文件属性” 或“ 创建文件”进行了修改，则不会显示此标头。 |
x-ms-copy-progress: <bytes copied/bytes total> |
版本 2015-02-21 及更高版本。 包含上次尝试的复制 文件 操作中复制的字节数和源中的总字节数，其中此文件是目标文件。 可以显示介于 0 和复制的字节数 Content-Length 之间。 如果此文件从未成为 复制文件 操作的目标，或者此文件在完成复制 文件 操作后使用 “设置文件属性” 或“ 创建文件”进行了修改，则不会显示此标头。 |
x-ms-copy-source: url |
版本 2015-02-21 及更高版本。 最多 2 KB 字符的 URL，指定在上次尝试 的复制文件 操作中使用的源文件，其中此文件是目标文件。 如果此文件从未成为 复制文件 操作的目标，或者此文件在完成复制 文件 操作后使用 “设置文件属性” 或“ 创建文件”进行了修改，则不会显示此标头。 |
x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed> |
版本 2015-02-21 及更高版本。 由 x-ms-copy-id标识的复制操作的状态，这些值包括：- 成功： 复制已成功完成。 - 等待： 复制正在进行中。 检查 x-ms-copy-status-description 间歇性、非致命错误是否妨碍了复制进度，但不会导致失败。- 中止： 复制已由 中止复制文件结束。 - 失败： 复制失败。 有关错误详细信息，请参阅 x-ms-copy-status-description。如果此文件从未成为 复制文件 操作的目标，或者此文件在完成复制 文件 操作后使用 “设置文件属性” 或“ 创建文件”进行了修改，则不会显示此标头。 |
x-ms-server-encrypted: true/false |
版本 2017-04-17 及更高版本。 如果使用指定的算法完全加密文件数据和应用程序元数据，则此标头的值设置为 true 。 如果文件未加密，或者仅加密文件或应用程序元数据的一部分，则该值设置为 false 。 |
x-ms-file-permission-key |
版本 2019-02-02 及更高版本。 文件权限的键。 |
x-ms-file-attributes |
版本 2019-02-02 及更高版本。 文件的文件系统属性。 有关详细信息，请参阅 可用属性列表。 |
x-ms-file-creation-time |
版本 2019-02-02 及更高版本。 表示文件的创建时间属性的 UTC 日期/时间值。 |
x-ms-file-last-write-time |
版本 2019-02-02 及更高版本。 表示文件的上次写入时间属性的 UTC 日期/时间值。 |
x-ms-file-change-time |
版本 2019-02-02 及更高版本。 表示文件的更改时间属性的 UTC 日期/时间值。 |
x-ms-file-file-id |
版本 2019-02-02 及更高版本。 文件的文件 ID。 |
x-ms-file-parent-id |
版本 2019-02-02 及更高版本。 文件的父文件 ID。 |
x-ms-lease-duration:infinite |
版本 2019-02-02 及更高版本。 租用文件时，指定租约的持续时间是无限的。 |
x-ms-lease-state:<available;leased;broken> |
版本 2019-02-02 及更高版本。 租用文件时，指定文件的租用状态。 |
x-ms-lease-status:<locked;unlocked> |
版本 2019-02-02 及更高版本。 租用文件时，指定文件的租用状态。 |
x-ms-client-request-id |
可用于对请求和相应响应进行故障排除。 如果请求中存在此标头的值，并且该值包含不超过 1,024 个可见 ASCII 字符，则此标头的值等于该标头的值 x-ms-client-request-id 。
x-ms-client-request-id如果请求中不存在标头，则响应中不存在该标头。 |
响应正文
无。
示例响应
Response Status:
HTTP/1.1 200 OK
Response Headers:
x-ms-type: File
x-ms-meta-m1: v1
x-ms-meta-m2: v2
Content-Length: 11
Content-Type: text/plain; charset=UTF-8
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-version: 2019-02-02
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
x-ms-copy-id: 36650d67-05c9-4a24-9a7d-a2213e53caf6
x-ms-copy-source: <url>
x-ms-copy-status: success
x-ms-copy-progress: 11/11
x-ms-copy-completion-time: <date>
x-ms-lease-duration: infinite
x-ms-lease-state: leased
x-ms-lease-status: locked
授权
只有帐户所有者可以调用此操作。