你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

设置共享属性

操作 Set Share Properties 为指定的 Azure 文件共享设置属性。 尽管此操作完全受支持,但它是旧版管理操作。 建议改用存储资源提供程序提供的 文件共享 - 更新 操作 (Microsoft.Storage) 。 若要详细了解如何使用存储资源提供程序以编程方式与 FileShare 资源交互,请参阅 对 FileShare 资源的操作

协议可用性

已启用文件共享协议 可用
SMB 是
NFS 是

请求

可以按如下所示构造 Set Share Properties 请求。 建议使用 HTTPS。 将 myaccount 替换为存储帐户的名称。

方法 请求 URI HTTP 版本
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties HTTP/1.1

将请求 URI 中所示的路径组件替换为你自己的组件,如下所示:

路径组件 说明
myaccount 存储帐户的名称。
myshare 文件共享的名称。

有关路径命名限制的详细信息,请参阅 命名和引用共享、目录、文件和元数据

URI 参数

可以在请求 URI 中指定以下附加参数:

参数 说明
timeout 可选。 以秒为单位。 有关详细信息,请参阅为Azure 文件存储操作设置超时

请求标头

下表描述了必需请求标头和可选请求标头:

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
x-ms-share-quota 可选。 在版本 2015-02-21 及更高版本中受支持。 指定共享的最大大小(以 giB (GiB) 为单位)。
x-ms-access-tier 可选。 在版本 2019-12-12 及更高版本中受支持。 指定共享的访问层。 有效值为 TransactionOptimizedHotCool。 有关文件共享分层的详细信息,请参阅Azure 文件存储存储层
x-ms-root-squash: <NoRootSquash | RootSquash | AllSquash> 可选。 在版本 2020-02-10 及更高版本中受支持。 指定启用 NFS 时共享上的根压缩行为。 如果未指定,则默认值为 NoRootSquash
  • NoRootSquash:关闭根挤压。
  • RootSquash:将来自 UID/GID 0 的请求映射到匿名 UID/GID。
  • AllSquash:将所有 UID 和 GID 映射到匿名用户。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1 kibite (KiB) 字符限制,该限制在配置日志记录时记录在存储分析日志中。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure Blob 存储
x-ms-lease-id:<ID> 如果目标文件共享具有有效的租约,则是必需的。 适用于版本 2020-02-10 及更高版本。 如果请求不包含租约 ID 或无效,则操作将失败,状态代码为 412 (先决条件失败) 。

如果指定了此标头,并且目标文件共享当前没有活动租约,则操作将失败,状态代码为 412 (前置条件失败) 。

请求正文

无。

示例请求

PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=properties  
  
Request Headers:  
x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount: Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00Jdjid0Q=  
x-ms-share-quota: 55  
x-ms-root-squash: RootSquash

响应

响应包括 HTTP 状态代码和一组响应标头。

状态代码

此操作成功后返回状态代码 200(正常)。

有关状态代码的信息,请参阅 状态和错误代码

响应头

此操作的响应包括以下标头。 响应还可能包括其他标准 HTTP 标头。 所有标准标头都符合 HTTP/1.1 协议规范

响应标头 说明
Last-Modified 返回上次修改共享的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息,请参阅 标头中的日期/时间值的表示形式。 修改共享或其属性的任何操作都将更新上次修改时间。 对文件执行的操作不会影响共享的上次修改时间。
ETag 包含一个值,该值以带引号的字符串形式表示共享的版本。
x-ms-request-id 唯一标识发出的请求。 还可以使用它来排查请求问题。 有关详细信息,请参阅 API 操作疑难解答
x-ms-version 指示用于执行请求的Azure 文件存储的版本。
Datex-ms-date 一个 UTC 日期/时间值,指示服务发送响应的时间。
x-ms-client-request-id 可用于对请求和相应的响应进行故障排除。 如果请求中存在此标头的值 x-ms-client-request-id 并且该值最多为 1,024 个可见 ASCII 字符,则此标头的值等于标头的值。 x-ms-client-request-id如果请求中不存在标头,则响应中不会显示此标头。

响应正文

无。

授权

只有帐户所有者才能调用此操作。

注解

有关设置共享配额的详细信息,请参阅 创建共享

如果将共享配额设置为小于共享上的数据大小,则操作将成功。 但是,在共享上的数据量减少到配额以下之前,无法向共享添加更多数据。 可以通过删除或压缩文件来减少数据量。

Set Share Properties不支持共享快照。 尝试对共享快照执行此操作将失败,状态代码为 400 (InvalidQueryParameterValue) 。

另请参阅

对 FileShare 资源的操作 (Azure 文件存储)