你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取共享属性
Get Share Properties 请求返回指定共享或共享快照的属性。
尽管完全支持此 API，但它是旧版管理 API。 出于此原因，我们建议改用 文件共享 - 获取，后者由存储资源提供程序（Microsoft.Storage）提供。
若要详细了解如何使用存储资源提供程序以编程方式与
协议可用性
| 已启用文件共享协议 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
请求
Get Share Properties 请求可以按如下方式构造。 建议使用 HTTPS。
| 方法 | 请求 URI | HTTP 版本 |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
将请求 URI 中显示的路径组件替换为你自己的路径组件，如下所示：
| 路径组件 | 描述 |
|---|---|
myaccount |
存储帐户的名称。 |
myshare |
文件共享的名称。 |
有关路径命名限制的信息，请参阅 名称和引用共享、目录、文件和元数据。
URI 参数
可以在请求 URI 中指定以下附加参数：
| 参数 | 描述 |
|---|---|
sharesnapshot |
自选。 版本 2017-04-17 及更高版本。
sharesnapshot 参数是一个不透明的日期/时间值，如果存在，则指定要查询的共享快照以检索属性。 |
timeout |
自选。 超时参数以秒为单位表示。 有关详细信息，请参阅 设置 Azure 文件存储操作的超时。 |
请求标头
下表描述了必需标头和可选标头：
| 请求标头 | 描述 |
|---|---|
Authorization |
必填。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅 授权对 Azure 存储的请求。 |
Date 或 x-ms-date |
必填。 指定请求的协调世界时（UTC）。 有关详细信息，请参阅 授权对 Azure 存储的请求。 |
x-ms-version |
所有授权请求都是必需的。 指定要用于此请求的操作的版本。 有关详细信息，请参阅 azure 存储服务 |
x-ms-client-request-id |
自选。 提供客户端生成的不透明值，该值具有配置日志记录时日志中记录的 1-kibibyte （KiB） 字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅 监视 Azure 文件。 |
x-ms-lease-id:<ID> |
自选。 版本 2020-02-10 及更高版本。 如果指定了标头，则仅当文件共享的租约当前处于活动状态并且请求中指定的租约 ID 与文件共享的租约 ID 匹配时，才会执行该操作。 如果没有匹配项，则操作失败，状态代码为 412（前置条件失败）。 |
请求正文
没有。
响应
响应包括 HTTP 状态代码和一组响应标头。
状态代码
成功的操作返回状态代码 200（正常）。
有关状态代码的详细信息，请参阅 状态和错误代码。
响应标头
此操作的响应包括以下标头。 响应还可能包括其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范。
| 响应标头 | 描述 |
|---|---|
Last-Modified |
返回上次修改共享的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息，请参阅标头中 Date-Time 值的 |
x-ms-meta-name:value |
一组名称/值对，其中包含共享的用户定义元数据。 |
ETag |
包含可用于有条件地执行操作的值。 该值用引号引起来。 |
x-ms-request-id |
唯一标识已发出的请求，并可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。 |
x-ms-version |
用于执行请求的 Azure 文件版本。 |
Date |
由服务生成的 UTC 日期/时间值，该值指示启动响应的时间。 |
x-ms-share-quota |
版本 2015-02-21 及更高版本。 返回当前共享配额（以 GiB 为单位）。 |
x-ms-share-provisioned-iops |
版本 2019-07-07 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 返回为高级共享预配的每秒输入/输出操作数（IOPS）。 |
x-ms-share-provisioned-ingress-mbps |
版本 2019-07-07 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 返回为高级共享预配的每秒兆字节（MiB/s）的入口。 |
x-ms-share-provisioned-egress-mbps |
版本 2019-07-07 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 返回为高级共享预配的 MiB/s 中的出口量。 |
x-ms-share-provisioned-bandwidth-mibps |
版本 2021-02-12 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 返回为高级共享预配的 MiB/s 中合并的（入口 + 出口）带宽。 |
x-ms-share-next-allowed-quota-downgrade-time |
版本 2019-07-07 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 一个日期/时间值，指定何时允许减少高级文件共享的配额。 日期格式遵循 RFC 1123。 |
x-ms-access-tier |
版本 2019-12-12 及更高版本。 返回共享的当前访问层。 在常规用途版本 2（GPv2）存储帐户中，TransationOptimized 是共享的默认层。 在 FileStorage 存储帐户类型中，Premium 是共享的默认层。 |
x-ms-access-tier-change-time |
版本 2019-12-12 及更高版本。 返回上次修改共享上的访问层的日期和时间。 |
x-ms-access-tier-transition-state |
版本 2019-12-12 及更高版本。 如果共享正在进行层转换，则此标头指示要从中转换的层。 |
x-ms-lease-duration:<fixed,infinite> |
版本 2020-02-10 及更高版本。 指定共享租约是无限持续时间还是固定持续时间。 |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
版本 2020-02-10 及更高版本。 共享租用时，此标头指定共享的租约状态。 |
x-ms-lease-status: <locked;unlocked> |
版本 2020-02-10 及更高版本。 共享租用时，此标头指定共享的租约状态。 |
x-ms-enabled-protocols: <SMB;NFS> |
返回版本 2019-07-07 及更高版本的当前已启用共享的协议。 - SMB：可以通过 SMBv3.0、SMBv2.1 和 REST 访问共享。- NFS：NFSv4.1 可以访问共享。 |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
返回版本 2019-07-07 及更高版本的当前共享根挤压行为。 仅限 NFS。 - NoRootSquash：根壁球关闭。- RootSquash：来自 UID/GID 0 的请求映射到匿名 UID/GID。- AllSquash：所有 UID 和 GID 都映射到匿名用户。此标头仅针对共享返回，而不适用于快照。 |
x-ms-enable-snapshot-virtual-directory-access: <true;false> |
版本 2024-08-04 及更新。 指定启用 NFS 后，是否应在共享装入点的根目录中访问快照虚拟目录。 此标头仅针对共享返回，而不适用于快照。 |
x-ms-client-request-id |
可用于对请求和相应的响应进行故障排除。 如果此标头存在于请求中，则此标头的值等于 x-ms-client-request-id 标头的值，并且该值包含不超过 1,024 个可见 ASCII 字符。 如果请求中不存在 x-ms-client-request-id 标头，则响应中不会显示该标头。 |
x-ms-share-paid-bursting-enabled: <true;false> |
版本 2024-11-04 及更高版本。 仅针对高级文件共享（FileStorage 存储帐户类型中的文件共享）返回。 指定是否启用付费突发。 此标头仅针对共享返回，而不适用于快照。 |
x-ms-share-paid-bursting-max-iops |
版本 2024-11-04 及更高版本。 仅针对高级文件共享返回。 返回共享允许的最大付费突发 IOPS。 仅当 x-ms-share-paid-bursting-enabled 为 true 时才返回。此标头仅针对共享返回，而不适用于快照。 |
x-ms-share-paid-bursting-max-bandwidth-mibps |
版本 2024-11-04 及更高版本。 仅针对高级文件共享返回。 返回共享允许的最大付费突发 MiB/s。 仅当 x-ms-share-paid-bursting-enabled 为 true 时才返回。此标头仅针对共享返回，而不适用于快照。 |
响应正文
没有。
示例响应
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
授权
只有帐户所有者才能调用此操作。
言论
没有。
另请参阅
azure 文件共享上的 操作