创建共享（FileREST API） - Azure 文件

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

项目
08/07/2024

Create Share 操作在指定的帐户下创建新的 Azure 文件共享。尽管完全支持此 API，但这是一个旧版管理 API。建议改用文件共享 - 创建，该由 Azure 存储资源提供程序（Microsoft.Storage）提供。若要详细了解如何使用 Azure 存储资源提供程序以编程方式与 FileShare 资源进行交互，请参阅 FileShares 上的操作。

如果已存在具有相同名称的共享，操作将失败。共享资源包括该共享的元数据和属性。它不包括共享中包含的文件列表。

协议可用性

已启用文件共享协议	可用
服务器消息块（SMB）
网络文件系统（NFS）

请求

可以构造 Create Share 请求，如下所示。建议使用 HTTPS。

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

将请求 URI 中显示的路径组件替换为自己的路径组件，如下所示：

路径组件	描述
`myaccount`	存储帐户的名称。
`myshare`	文件共享的名称。名称只能包含小写字符。

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

URI 参数

可以在请求 URI 上指定以下附加参数：

参数	描述
`timeout`	自选。超时参数以秒为单位表示。有关详细信息，请参阅设置文件服务操作的超时。

请求标头

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

请求标头	描述
`Authorization`	必填。指定授权方案、帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必填。指定请求的协调世界时（UTC）时间。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	所有授权请求都是必需的。指定要用于此请求的操作的版本。有关详细信息，请参阅 azure 存储服务版本控制。
`x-ms-meta-name:value`	自选。要作为元数据与共享关联的名称/值对。元数据名称必须遵循 C# 标识符的命名规则。
`x-ms-share-quota`	自选。版本 2015-02-21 及更高版本中受支持。指定共享的最大大小（以 GiB 为单位）。
`x-ms-access-tier`	自选。在版本 2019-12-12 及更高版本中受支持。指定共享的访问层。有效值为 `TransactionOptimized`、`Hot`和 `Cool`。有关文件共享层的详细信息，请参阅 Azure 文件存储层。
`x-ms-enabled-protocols: <SMB \\| NFS>`	自选。版本 2019-07-07 及更高版本中受支持。指定共享上启用的协议。如果未指定它们，则默认值为 SMB。 - `SMB`：可以通过 SMBv3.0、SMBv2.1 和 REST 访问共享。 - `NFS`：NFSv4.1 可以访问共享。此选项需要高级帐户。
`x-ms-root-squash: <NoRootSquash \\| RootSquash \\| AllSquash>`	自选。仅限 NFS。版本 2019-07-07 及更高版本中受支持。指定启用 NFS 时共享上的根争用行为。如果未指定，则默认值为 NoRootSquash。 - `NoRootSquash`：关闭根壁球。 - `RootSquash`：将 uid/gid 0 的请求映射到匿名 uid/gid。 - `AllSquash`：将所有 uid 和 gid 映射到匿名用户。
`x-ms-enable-snapshot-virtual-directory-access: <true \\| false>`	自选。版本 2024-08-04 及更高版本中受支持。指定启用 NFS 后，是否应在共享装入点的根目录中访问快照虚拟目录。如果未指定，则默认值为 true。
`x-ms-client-request-id`	自选。提供客户端生成的不透明值，该值具有配置日志记录时日志中记录的 1-kibibyte （KiB）字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视 Azure 文件。
`x-ms-share-paid-bursting-enabled: <true \\| false>`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享（FileStorage 存储帐户类型中的文件共享）。此属性启用付费突发。如果未指定属性，则默认值为 false。
`x-ms-share-paid-bursting-max-iops`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享。一个整数，表示共享允许的最大付费突发输入/输出操作数（IOPS）。如果未指定，则默认值为共享允许的最大 IOPS。如果设置了此标头，则 `x-ms-share-paid-bursting-enabled` 也必须设置为 true。
`x-ms-share-paid-bursting-max-bandwidth-mibps`	自选。版本 2024-11-04 及更高版本中受支持。仅允许高级文件共享。一个整数，表示允许共享的最大付费突发字节数（MiB/s）。如果未指定，则默认值为共享允许的最大 MiB/s。如果设置了此标头，则 `x-ms-share-paid-bursting-enabled` 也必须设置为 true。

请求正文

没有。

示例请求

PUT https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1  
  
Request Headers:  
x-ms-version: 2020-02-10  
x-ms-date: <date>  
x-ms-meta-Name: StorageSample  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=

响应

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

状态代码

成功的操作返回状态代码 201（已创建）。

有关详细信息，请参阅状态和错误代码。

响应标头

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

响应标头	描述
`ETag`	包含一个值，该值表示共享的版本，用引号括起来。
`Last-Modified`	返回上次修改共享的日期和时间。日期格式遵循 RFC 1123。有关详细信息，请参阅表示标头中的日期/时间值。任何修改共享或其属性或元数据的操作都更新上次修改时间。对文件执行的操作不会影响共享的上次修改时间。
`x-ms-request-id`	唯一标识请求，可以使用它对请求进行故障排除。有关详细信息，请参阅 API 操作疑难解答
`x-ms-version`	指示用于执行请求的 Azure 文件版本。
`Date`	由服务生成的 UTC 日期/时间值，该值指示启动响应的时间。
`x-ms-client-request-id`	可用于对请求和相应的响应进行故障排除。如果此标头存在于请求中，则此标头的值等于 `x-ms-client-request-id` 标头的值，并且该值包含不超过 1,024 个可见 ASCII 字符。如果请求中不存在 `x-ms-client-request-id` 标头，则响应中不存在该标头。

响应正文

没有。

示例响应

Response Status:  
HTTP/1.1 201 Created  
  
Response Headers:  
Transfer-Encoding: chunked  
Date: <date>  
ETag: "0x8CB14C3E29B7E82"  
Last-Modified: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

授权

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

言论

共享会立即在存储帐户中创建。无法将一个共享嵌套在另一个共享中。

在创建共享时，可以通过在请求中包含一个或多个元数据标头来指定共享的元数据。元数据标头的格式 x-ms-meta-name:value。

如果在调用 Create Share时删除同名共享，服务器将返回状态代码 409（冲突），其他错误信息指示正在删除共享。

可以使用共享大小配额来限制存储在共享上的文件大小。配额不会限制快照的大小。与文件关联的开销，用于计算存储帐户的计费大小不会计入配额中。

当共享上文件的大小总和超过在共享上设置的配额时，尝试增加文件大小将失败，并且创建新的非空文件（通过 REST）将失败。你仍然可以创建空文件。

更改或设置配额不会影响计费。你仍会根据文件大小和开销计费。

另请参阅

azure 文件共享上的操作

通过

创建共享