通过

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

放置页面

  • 项目

Put Page operation writes a range of pages to a page blob.

请求

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

PUT 方法请求 URI HTTP 版本
https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=page HTTP/1.1

模拟存储服务请求

对模拟存储服务发出请求时，请将模拟器主机名和 Blob 服务端口指定为 127.0.0.1:10000，后跟模拟的存储帐户名称：

PUT 方法请求 URI HTTP 版本
http://127.0.0.1:10000/devstoreaccount1/mycontainer/myblob?comp=page HTTP/1.1

有关详细信息，请参阅使用 Azurite 模拟器进行本地 Azure 存储开发。

URI 参数

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

参数 说明
timeout 可选。 timeout 参数以秒表示。 有关详细信息，请参阅 为 Blob 服务操作设置超时。

请求标头

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

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息，请参阅授权对 Azure 存储的请求。
Date 或 x-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息，请参阅授权对 Azure 存储的请求。
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息，请参阅 Azure 存储服务的版本控制。
Range Range or x-ms-range is required.

指定要写为页的字节范围。 必须指定范围的上限和下限。 此标头由 HTTP/1.1 协议规范定义。

对于 页面更新 操作，页面范围最多可为 4 MiB。 对于 页清除 操作，页范围可以与 Blob 的完整大小值一样大。

由于页必须与 512 字节边界对齐，因此起始偏移量必须为 512，结束偏移量必须是 512 –1 的模数。 有效字节范围的示例包括 0-511、512-1023 等。

Blob 存储仅接受标头的 Range 单个字节范围，并且必须使用以下格式指定字节范围： bytes=startByte-endByte。

如果指定了 Range 和 x-ms-range，服务将使用 x-ms-range 值。 有关详细信息，请参阅 指定 Blob 服务操作的范围标头。
x-ms-range Range or x-ms-range is required.

指定要写为页的字节范围。 必须指定范围的上限和下限。 此标头由 HTTP/1.1 协议规范定义。

对于页面更新操作，页面范围的大小可以高达 4 MiB。 对于页清除操作，页范围可高达 Blob 的实际大小值。

由于页必须与 512 字节边界对齐，因此起始偏移量必须为 512，结束偏移量必须是 512 – 1 的取模。 有效字节范围的示例包括 0-511、512-1023 等。

Blob 存储仅接受标头的 x-ms-range 单个字节范围，并且必须使用以下格式指定字节范围： bytes=startByte-endByte。

如果指定了 Range 和 x-ms-range，服务将使用 x-ms-range 值。 有关详细信息 ，请参阅指定 Blob 服务操作的范围标头 。
Content-Length 必需。 指定在请求正文中传送的字节数。 当 标头 x-ms-page-write 设置为 clear时，此标头的值必须设置为 0。
Content-MD5 可选。 页内容的 MD5 哈希值。 此哈希值用于验证传输期间页的完整性。 指定此标头时，存储服务会对已到达内容的哈希值与此标头值进行比较。
<br / >注意：此 MD5 哈希不随 Blob 一起存储。

如果这两个哈希值不匹配，操作会失败，并显示错误代码 400（错误请求）。
x-ms-content-crc64 可选。 页面内容的 CRC64 哈希。 此哈希值用于验证传输期间页的完整性。 指定此标头时，存储服务会对已到达内容的哈希值与此标头值进行比较。

注意：此 CRC64 哈希不随 Blob 一起存储。

如果这两个哈希值不匹配，操作会失败，并显示错误代码 400（错误请求）。

如果 和 x-ms-content-crc64 标头都Content-MD5存在，则请求会失败，并显示 400 (错误的请求) 。

版本 2019-02-02 及更高版本中支持此标头。
x-ms-page-write: {update ¦ clear} 必需。 可以指定以下选项之一：

- Update：将请求正文指定的字节写入指定范围。 Range 和 Content-Length 标头必须匹配才能执行更新。
- Clear：清除指定范围并释放该范围的存储中使用的空间。 若要清除某个范围，请将 Content-Length 标头设置为 0，并将 标头设置为 Range 一个值，该值指示要清除的范围，最大为最大 Blob 大小。
x-ms-encryption-scope 可选。 指示用于加密请求内容的加密范围。 版本 2019-02-02 及更高版本中支持此标头。
x-ms-lease-id:<ID> 如果 Blob 具有活动租约，则是必需的。 要在具有活动租约的 Blob 上执行此操作，请为此标头指定有效的租约 ID。
x-ms-if-sequence-number-le: <num> 可选。 如果 Blob 的序列号小于或等于指定值，则请求将继续。 否则，它将失败，并显示 SequenceNumberConditionNotMet 错误 (HTTP 状态代码 412 – 前置条件失败) 。
x-ms-if-sequence-number-lt: <num> 可选。 如果 blob 的序列号小于指定的值，则请求将继续。 否则，它将失败并出现 SequenceNumberConditionNotMet 错误， (HTTP 状态代码 412 – 前置条件失败) 。
x-ms-if-sequence-number-eq: <num> 可选。 如果 Blob 的序列号等于指定的值，则请求将继续。 否则，它将失败并出现 SequenceNumberConditionNotMet 错误， (HTTP 状态代码 412 – 前置条件失败) 。
If-Modified-Since 可选。 一个 DateTime 值。 指定仅当 Blob 自指定日期/时间以来修改过时，此条件头才写入页。 如果 blob 尚未修改，Blob 存储将返回状态代码 412 (先决条件失败) 。
If-Unmodified-Since 可选。 一个 DateTime 值。 指定此条件标头以仅当 Blob 自指定日期/时间以来未修改时写入页。 如果 Blob 已修改，Blob 存储将返回状态代码 412 (先决条件失败) 。
If-Match 可选。 ETag 值。 指定仅当 Blob 的 ETag 值与指定值匹配时，此条件头的 ETag 值才写入页。 如果值不匹配，Blob 存储将返回状态代码 412 (先决条件失败) 。
If-None-Match 可选。 ETag 值。

指定此条件标头的 ETag 值，以便仅当 Blob 的 ETag 值与指定的值不匹配时写入页。 如果值相同，Blob 存储将返回状态代码 412 (先决条件失败) 。
x-ms-client-request-id 可选。 提供客户端生成的不透明值，其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息，请参阅监视Azure Blob 存储。

此操作还支持仅当满足指定条件时才使用条件头执行操作。 有关详细信息，请参阅 为 Blob 服务操作指定条件标头。

请求标头 (客户提供的加密密钥)

从版本 2019-02-02 开始，可以在请求中指定以下标头，以使用客户提供的密钥加密 Blob。 使用客户提供的密钥 (和相应的一组标头) 进行加密是可选的。

请求标头 说明
x-ms-encryption-key 必需。 Base64 编码的 AES-256 加密密钥。
x-ms-encryption-key-sha256 必需。 加密密钥的 Base64 编码 SHA256 哈希。
x-ms-encryption-algorithm: AES256 必需。 指定要用于加密的算法。 此标头的值必须为 AES256。

请求正文

请求正文包含页内容。

示例请求：更新字节范围

  
Request Syntax:  
PUT https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=page HTTP/1.1  
  
Request Headers:  
x-ms-page-write: update  
x-ms-date: Fri, 16 Sep 2011 22:15:50 GMT  
x-ms-version: 2011-08-18  
x-ms-range: bytes=0-65535  
Authorization: SharedKey myaccount:4KdWDiTdA9HmIF9+WF/8WfYOpUrFhieGIT7f0av+GEI=  
Content-Length: 65536

示例请求：清除字节范围

  
Request Syntax:  
PUT https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=page HTTP/1.1  
  
Request Headers:  
Range: bytes=1024-2048  
x-ms-page-write: clear  
x-ms-date: Sun, 25 Sep 2011 23:37:35 GMT  
x-ms-version: 2011-08-18  
Authorization: SharedKey myaccount:4KdWDiTdA9HmIF9+WF/8WfYOpUrFhieGIT7f0av+GEI=

响应

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

状态代码

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

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

响应头

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

语法 说明
ETag Blob 的 ETag。 如果请求版本为 2011-08-18 及更高版本，则 ETag 值用引号引起来。 ETag 可用于通过为 If-Match 或 If-None-Match 请求标头指定值来执行Put Page条件操作。
Last-Modified 上次修改 Blob 的日期和时间。 日期格式遵循 RFC 1123。 有关详细信息，请参阅 在标头中表示日期/时间值。

针对 Blob 的任何写操作，包括更新 Blob 的元数据或属性，更改 Blob 的上次修改时间。
Content-MD5 返回此标头是为了客户端可以检查消息内容完整性。 此标头的值由 Blob 存储计算。 它不一定与请求标头中指定的值相同。 对于版本 2019-02-02 及更高版本，仅当请求具有此标头时，才会返回此标头。
x-ms-content-crc64 对于版本 2019-02-02 或更高版本，返回此标头，以便客户端可以检查消息内容完整性。 此标头的值由 Blob 存储计算。 它不一定与请求标头中指定的值相同。

当请求中不存在标头时 Content-MD5 ，将返回此标头。
x-ms-blob-sequence-number 页 Blob 的当前序列号。
x-ms-request-id 唯一标识发出的请求，并可用于对请求进行故障排除。 有关详细信息，请参阅 API 操作疑难解答。
x-ms-version 指示用于执行请求的 Blob 服务版本。 对于针对版本 2009-09-19 及更高版本发出的请求，返回此标头。
Date 由服务生成的 UTC 日期/时间值，指示启动响应的时间。
x-ms-request-server-encrypted: true/false 版本 2015-12-11 及更高版本。 如果使用指定的算法成功加密请求的内容，则此标头的值设置为 true 。 否则，该值将设置为 false。
x-ms-encryption-key-sha256 版本 2019-02-02 及更高版本。 如果请求使用客户提供的密钥进行加密，则返回 ，因此客户端可以确保使用提供的密钥成功加密请求的内容。
x-ms-encryption-scope 版本 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 201 Created  
  
Response Headers:  
x-ms-content-crc64: 77uWZTolTHU  
Date: Sun, 25 Sep 2011 22:33:35 GMT  
ETag: "0x8CB171BA9E94B0B"  
Last-Modified: Sun, 25 Sep 2011 12:13:31 GMT  
x-ms-version: 2011-08-18  
x-ms-blob-sequence-number: 0  
Content-Length: 0  
Server: Windows-Azure-Blob/1.0 Microsoft-HTTPAPI/2.0

授权

在 Azure 存储中调用任何数据访问操作时，都需要授权。 可以如下所述授权 Put Page 操作。

重要

Microsoft 建议将 Microsoft Entra ID 与托管标识配合使用来授权对 Azure 存储的请求。 与共享密钥授权相比，Microsoft Entra ID提供优越的安全性和易用性。

Azure 存储支持使用 Microsoft Entra ID 授权对 Blob 数据的请求。 使用 Microsoft Entra ID，可以使用 Azure 基于角色的访问控制 (Azure RBAC) 向安全主体授予权限。 安全主体可以是用户、组、应用程序服务主体或 Azure 托管标识。 安全主体由 Microsoft Entra ID 进行身份验证，以返回 OAuth 2.0 令牌。 然后可以使用令牌来授权对 Blob 服务发出请求。

若要详细了解如何使用Microsoft Entra ID授权，请参阅使用 Microsoft Entra ID 授权访问 blob。

权限

下面列出了Microsoft Entra用户、组、托管标识或服务主体调用Put Page操作所需的 RBAC 操作，以及包含此操作的最低特权内置 Azure RBAC 角色：

若要详细了解如何使用 Azure RBAC 分配角色，请参阅 分配 Azure 角色以访问 Blob 数据。

注解

Put Page operation writes a range of pages to a page blob. 只能在现有页 Blob 上调用此操作。 不能调用它来创建新的页 Blob，也不能在块 Blob 上调用它。 使用当前不存在的 blob 名称调用 Put Page 将返回 HTTP 状态代码 404 (找不到) 。

若要创建新的页 Blob，请调用 Put Blob 并指定要创建为页 Blob 的 Blob 类型。 页 Blob 的大小最大可以为 8 TiB。

如果 Blob 具有活动租约，则客户端必须在写入页的请求中指定有效的租约 ID。

页面更新操作

使用 Update 选项调用Put Page时，将对指定的页 Blob 执行就地写入。 更新将覆盖指定页中的所有内容。

重要

如果服务器超时或在操作期间 Put Page 关闭连接，则页面可能已更新，也可能未更新。 因此，应继续重试更新，直到收到指示成功的响应。

为更新操作提交的 Put Page 每个页面范围可能最大为 4 MiB。 页的起始和结束范围必须与 512 字节的边界对齐。 如果尝试上传大于 4 MiB 的页面范围，服务将返回状态代码 413 (请求实体太大) 。

页面清除操作

使用 Clear 选项调用 Put Page 将释放指定页面使用的存储空间。 已清除的页将不再作为页 Blob 的一部分进行跟踪。

已清除的页不再对存储帐户产生费用，因为它们的存储资源已释放。 唯一的例外是存在页 Blob 的现有快照。 如果快照中的页不再作为源 Blob 的一部分存在，则会产生费用。

管理并发问题

Blob 存储按顺序处理对重叠页的并发写入。 也就是说，由服务处理的最后一页确定 Blob 的内容。 因此，为了确保 Blob 内容的完整性，客户端应使用以下一种或多种方法处理对重叠页的写入：

  • 可以检查对Put Page的每个成功调用的 Last-Modified 响应标头的值。 从 Blob 存储返回的响应顺序不一定与服务执行它们的顺序相对应。 但 Last-Modified 的值始终指示服务处理请求的顺序。

  • 可以使用乐观并发机制根据 Blob 的 ETag 或上次修改时间有条件地执行更新。 如果并发写入数相对较低，此方法十分适用。 使用条件请求标头 If-Match、If-None-Match、If-Modified-Since 和 If-Unmodified-Since 可实现此用途。

  • 可以调用 租约 Blob 以将 Blob 锁定为一分钟或更长时间（如果续订租约），以针对其他写入操作锁定 Blob。

  • 可以使用 Blob 的序列号来确保重试没有响应的请求不会导致并发更新。 此方法可能最适合需要高吞吐量进行页面写入的客户端。 下一部分对此进行了详细介绍。

使用页 Blob 序列号重试请求

当对 Put Page 的调用超时或未返回响应时，无法确定请求是否成功。 因此，需要重试请求，但由于 Azure 存储服务的分布式性质，在重试的请求成功后，可能会处理原始请求。 延迟的原始请求可能覆盖其他更新并产生意外结果。 以下顺序演示了这种情况的发生方式：

  1. 将 Put Page 值“X”写入页 0 的请求超时或不返回响应。

  2. 将值“X”写入页 0 的重试请求成功。

  3. 将值“Y”写入页 0 的请求成功。

  4. 原始请求成功，从而将值“X”写入页 0。

  5. 读取页 0 时返回值“X”，此时客户端需要值“Y”。

如果原始请求未返回 100 到 499 或 503 (服务器忙) 的状态代码，则会发生此类冲突。 如果返回其中的某一状态代码，则可以确定请求是成功还是失败。 但如果该服务返回超出此范围的状态代码，则无法知道原始请求的状态。

若要防止此类冲突，可以使用页 Blob 的序列号来确保重试请求时，原始请求不会成功。 为此，应在重试原始请求之前递增序列号。 然后，可以使用条件序列号标头来确保请求的序列号与预期的序列号不匹配时失败。 以下序列说明这种方法：

  1. 客户端使用 放置 Blob 创建页 Blob，并将其序列号设置为 0。

  2. 请求 Put Page 将值“X”写入页 0，并将 if-sequence-number-lt 标头设置为 1 超时或不返回响应。

  3. 客户端调用 Set Blob Properties 以将序列号更新为 1。

  4. 将值“X”写入页 0 并将 if-sequence-number-lt 设置为 2 的重试请求成功。

  5. 将值“Y”写入页 0 并将 if-sequence-number-lt 设置为 2 的请求成功。

  6. 原始请求最终得到处理，但它失败，因为它指定了序列号必须小于 1 (即 if-sequence-num-lt 标头设置为 1) 的条件。 错误为 SequenceNumberConditionNotMet（HTTP 状态代码 412 – 前置条件失败）。

  7. 读取页 0 时返回预期值“Y”。

另请参阅

授权对 Azure 存储的请求
状态和错误代码
为 Blob 服务操作设置超时