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

设置 Blob 标记

操作 Set Blob Tags 将指定 blob 的用户定义标记设置为一个或多个键值对。

请求

可以按如下方式构建Set Blob Tags请求。 建议使用 HTTPS。 将 myaccount 替换为存储帐户的名称:

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

https://myaccount.blob.core.windows.net/mycontainer/myblob?comp=tags&versionid=<DateTime>
HTTP/1.1

URI 参数

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

参数 说明
versionid 对于版本 2019-12-12 及更高版本是可选的。 参数 versionid 是一个不透明的 DateTime 值,如果存在,则指定要检索的 Blob 的版本。
timeout 可选。 timeout 参数以秒表示。 有关详细信息,请参阅 为 Blob 存储操作设置超时

请求标头

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

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
Content-Length 必需。 请求内容的长度(字节)。 此标头是指标记文档的内容长度,而不是 Blob 本身的内容长度。
Content-Type 必需。 此标头的值应为 application/xml;charset=UTF-8。
Content-MD5 可选。 请求内容的 MD5 哈希值。 此哈希值用于验证传输期间请求内容的完整性。 如果这两个哈希值不匹配,操作会失败,并显示错误代码 400(错误请求)。

此标头与请求内容相关联,而不是与 Blob 本身的内容相关联。
x-ms-content-crc64 可选。 请求内容的 CRC64 哈希。 此哈希值用于验证传输期间请求内容的完整性。 如果这两个哈希值不匹配,操作会失败,并显示错误代码 400(错误请求)。

此标头与请求内容相关联,而不是与 Blob 本身的内容相关联。

如果 和 x-ms-content-crc64 标头都Content-MD5存在,则请求失败,错误代码为 400 (错误的请求) 。
x-ms-lease-id:<ID> 如果 Blob 具有活动租约,则是必需的。

要在具有活动租约的 Blob 上执行此操作,请为此标头指定有效的租约 ID。 如果未在请求中指定有效的租约 ID,则操作将失败,状态代码为 403 (禁止) 。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure Blob 存储

仅当满足指定条件时, x-ms-if-tags 此操作才支持条件标头设置 blob 标记。 有关详细信息,请参阅 为 Blob 存储操作指定条件标头

请求正文

请求正文的格式如下所示:

<?xml version="1.0" encoding="utf-8"?>  
<Tags>  
    <TagSet>  
        <Tag>  
            <Key>tag-name-1</Key>  
            <Value>tag-value-1</Value>  
        </Tag>  
        <Tag>  
            <Key>tag-name-2</Key>  
            <Value>tag-value-2</Value>  
        </Tag>  
    </TagSet>  
</Tags>  

请求正文必须是格式正确的 UTF-8 XML 文档,并包含表示 Blob 标记的标记集。

标记集可以包含不超过 10 个标记。 标记键和值都区分大小写。 标记键必须为 1 到 128 个字符,标记值必须介于 0 到 256 个字符之间。 有效的标记键和值字符包括:

  • a-z、A-Z) (小写字母和大写字母
  • 数字 (0-9)
  • 空格 ( )
  • 加上 (+) 、减 (-) 、句点 (.) 、斜杠 (/) 、冒号 (:) 、等于 (=) 和下划线 (_)

响应

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

状态代码

成功的操作将返回状态代码 204(无内容)。

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

响应头

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

响应标头 说明
x-ms-request-id 唯一标识发出的请求,可用于对请求进行故障排除。 有关详细信息,请参阅 API 操作疑难解答
x-ms-version 用于执行请求的 Blob 存储版本。
Date 由服务生成的 UTC 日期/时间值,指示启动响应的时间。
x-ms-client-request-id 可用于对请求和相应的响应进行故障排除。 如果请求中存在标头, x-ms-client-request-id 并且该值包含的可见 ASCII 字符不超过 1,024 个,则此标头的值等于标头的值。 x-ms-client-request-id如果请求中不存在标头,则响应中不会显示该标头。

响应正文

无。

授权

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

重要

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用户、组、托管标识或服务主体调用Set Blob Tags操作所需的 RBAC 操作,以及包含此操作的最低特权内置 Azure RBAC 角色:

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

注解

Set Blob Tags REST API 版本 2019-12-12 及更高版本中支持此操作。

对于启用了分层命名空间的帐户,不支持此操作, Set Blob Tags 因为分层命名空间帐户不支持 Blob 标记。

Set Blob Tags 操作将覆盖 Blob 上的所有现有标记。 若要从 Blob 中删除所有标记,请使用空 <TagSet>发送Set Blob Tags请求。

此操作不会更新 Blob 的 ETag 或上次修改时间。 可以在存档的 Blob 上设置标记。

存储服务在 Blob 与其标记之间保持高度一致性。 对 Blob 标记的更改对 Blob 的后续 Get Blob Tags 操作立即可见。 但是,辅助索引最终是一致的。 对 Blob 标记的更改可能不会立即对 Find Blobs by Tags 操作可见。

如果请求提供无效标记,Blob 存储将返回状态代码 400 (“错误请求) 。

计费

定价请求可以源自使用 Blob 存储 API 的客户端,可以直接通过 Blob 存储 REST API 或 Azure 存储客户端库。 这些请求按事务产生费用。 事务类型会影响帐户的计费方式。 例如,读取事务应计为与写入事务不同的计费类别。 下表显示了基于存储帐户类型的请求的计费类别 Set Blob Tags

操作 存储帐户类型 计费类别
设置 Blob 标记 高级块 blob
标准常规用途 v2
其他操作
设置 Blob 标记 标准常规用途 v1 写入操作

若要了解指定计费类别的定价,请参阅Azure Blob 存储定价

另请参阅

使用 Blob 索引标记管理和查找 Blob 存储数据
授权对 Azure 存储的请求
状态和错误代码
Blob 存储错误代码