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

设置 Blob 元数据

Set Blob Metadata操作将指定 Blob 的用户定义元数据设置为一个或多个名称/值对。

请求

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

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

模拟的存储服务 URI

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

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

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

URI 参数

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

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

请求标头

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

请求标头 说明
Authorization 必需。 指定授权方案、帐户名称和签名。 有关详细信息,请参阅授权对 Azure 存储的请求
Datex-ms-date 必需。 指定请求的协调世界时 (UTC)。 有关详细信息,请参阅授权对 Azure 存储的请求
x-ms-version 对于所有已授权的请求是必需的。 指定用于此请求的操作的版本。 有关详细信息,请参阅 Azure 存储服务的版本控制
x-ms-meta-name:value 可选。 为 Blob 设置名称/值对。

每次调用此操作都会替换附加到 Blob 的所有现有元数据。 要从该 Blob 中删除所有元数据,请不带任何元数据头调用此操作。

注意:从版本 2009-09-19 开始,元数据名称必须遵守 C# 标识符的命名规则。
x-ms-encryption-scope 可选。 指示用于加密请求内容的加密范围。 版本 2019-02-02 或更高版本支持此标头。
x-ms-lease-id:<ID> 如果 Blob 具有活动租约,则是必需的。 要在具有活动租约的 Blob 上执行此操作,请为此标头指定有效的租约 ID。
x-ms-client-request-id 可选。 提供客户端生成的不透明值,其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。 强烈建议使用此标头将客户端活动与服务器接收的请求相关联。 有关详细信息,请参阅监视Azure Blob 存储

此操作还支持使用条件头在满足指定条件时设置 Blob 元数据。 有关详细信息,请参阅 为 Blob 存储操作指定条件标头

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

从版本 2019-02-02 开始,可以在请求中指定以下标头,以使用客户提供的密钥加密 Blob。 使用客户提供的密钥 (和相应的一组标头) 进行加密是可选的。 如果 Blob 以前已使用客户提供的密钥进行加密,则必须在请求中包含这些标头才能成功完成写入操作。

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

请求正文

无。

响应

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

状态代码

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

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

响应头

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

响应标头 说明
ETag 包含可用于有条件地执行操作的值。 有关详细信息 ,请参阅为 Blob 存储操作指定条件标头 。 如果请求版本为 2011-08-18 及更高版本,则 ETag 值用引号引起来。
Last-Modified 上次修改 Blob 的日期/时间。 日期格式遵循 RFC 1123。 有关详细信息,请参阅 在标头中表示日期/时间值

针对 Blob 的任何写操作(包括更新 Blob 的元数据或属性)都会更改 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 可用于对请求和相应响应进行故障排除。 如果请求中存在标头, x-ms-client-request-id 并且该值包含的可见 ASCII 字符不超过 1,024 个,则此标头的值等于标头的值。 x-ms-client-request-id如果请求中不存在标头,则响应中不会显示该标头。

响应正文

无。

授权

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

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 Metadata操作所需的 RBAC 操作,以及包含此操作的最小特权内置 Azure RBAC 角色:

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

注解

如果 Blob 具有活动租约,则客户端必须在请求中指定有效的租约 ID,以便将元数据写入 Blob。 如果客户端未指定租约 ID,或指定无效的租约 ID,则 Blob 存储将返回状态代码 412 (前置条件失败) 。 如果客户端指定租约 ID,但 blob 没有活动的租约,则 Blob 存储还会返回状态代码 412 (前置条件失败) 。

计费

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

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

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

另请参阅

授权对 Azure 存储的请求
状态和错误代码
Blob 存储错误代码