设置共享属性（FileREST API） - Azure 文件

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

项目
08/07/2024

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 存储的请求。
`Date` 或 `x-ms-date`	必填。指定请求的协调世界时（UTC）。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	所有授权请求都是必需的。指定要用于此请求的操作的版本。有关详细信息，请参阅 azure 存储服务版本控制。
`x-ms-share-quota`	自选。版本 2015-02-21 及更高版本中受支持。指定共享的最大大小（以 GiB 为单位）。
`x-ms-access-tier`	自选。在版本 2019-12-12 及更高版本中受支持。指定共享的访问层。有效值为 `TransactionOptimized`、`Hot`和 `Cool`。有关文件共享分层的详细信息，请参阅 Azure 文件存储层。
`x-ms-root-squash: <NoRootSquash \\| RootSquash \\| AllSquash>`	自选。在版本 2020-02-10 及更高版本中受支持。指定启用 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`	自选。提供客户端生成的不透明值，其中包含配置日志记录时在存储分析日志中记录的 1-kibibyte （KiB）字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视 Azure Blob 存储。
`x-ms-lease-id:<ID>`	如果目标文件共享具有活动租约，则为必需。适用于版本 2020-02-10 及更高版本。如果请求不包含租约 ID 或无效，则操作将失败，状态代码为 412（前置条件失败）。如果指定了此标头，并且目标文件共享当前没有活动租约，则操作将失败，状态代码为 412（前置条件失败）。
`x-ms-share-paid-bursting-enabled: <true \\| false>`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享（FileStorage 存储帐户类型中的文件共享）。此属性可用于启用或禁用付费突发。如果未指定该属性，共享将保留其现有的付费突发启用状态。
`x-ms-share-paid-bursting-max-iops`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享。一个整数，表示共享允许的最大付费突发输入/输出操作数（IOPS）。如果尚未在共享上启用付费突发：该行为与 Create Share 中的 `x-ms-share-paid-bursting-max-iops` 标头相同。如果未指定，则默认值为共享允许的最大 IOPS。如果设置了此标头，则 `x-ms-share-paid-bursting-enabled` 也必须设置为 true。如果已在共享上启用付费突发：可以使用 `x-ms-share-paid-bursting-max-iops` 更新共享的最大付费突发 IOPS。在这种情况下，不需要设置 `x-ms-share-paid-bursting-enabled`。如果 `x-ms-share-paid-bursting-enabled` 设置为 true 但未设置 `x-ms-share-paid-bursting-max-iops`，则最大付费突发 IOPS 将保持不变。
`x-ms-share-paid-bursting-max-bandwidth-mibps`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享。一个整数，表示允许共享的最大付费突发字节数（MiB/s）。如果尚未在共享上启用付费突发：该行为与 Create Share 中的 `x-ms-share-paid-bursting-max-bandwidth-mibps` 标头相同。如果未指定，则默认值为共享允许的最大 MiB/s。如果设置了此标头，则 `x-ms-share-paid-bursting-enabled` 也必须设置为 true。如果已在共享上启用付费突发：可以使用 `x-ms-share-paid-bursting-max-bandwidth-mibps` 更新共享的最大付费突发 MiB/s。在这种情况下，不需要设置 `x-ms-share-paid-bursting-enabled`。如果 `x-ms-share-paid-bursting-enabled` 设置为 true 但未设置 `x-ms-share-paid-bursting-max-bandwidth-mibps`，则最大付费突发带宽将保持不变。

请求正文

没有。

示例请求

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 文件的版本。
`Date` 或 `x-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）。

如果为 NFS 共享设置 x-ms-enable-snapshot-virtual-directory-access 标头，请重新装载共享以观察更新的行为。

另请参阅

对文件共享资源（Azure 文件）操作

通过

设置共享属性