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

设置队列元数据

项目
08/05/2023

Set Queue Metadata操作在指定的队列上设置用户定义的元数据。元数据以名称-值对的形式与队列相关联。

请求

可以按如下所示构造 Set Queue Metadata 请求。建议使用 HTTPS。

方法	请求 URI	HTTP 版本
`PUT`	`https://myaccount.queue.core.windows.net/myqueue?comp=metadata`	HTTP/1.1

模拟存储服务请求

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

方法	请求 URI	HTTP 版本
`PUT`	`http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=metadata`	HTTP/1.1

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

URI 参数

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

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

请求标头

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

请求标头	说明
`Authorization`	必需。指定授权方案、帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必需。指定请求的协调世界时 (UTC)。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	可选。指定用于此请求的操作的版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-meta-name:string-value`	可选。作为元数据与队列关联的名称-值对。每次调用此操作时，将替换与队列关联的所有现有的元数据。要从队列中删除所有元数据，请调用此操作而不指定任何元数据标头。注意：从版本 2009-09-19 开始，元数据名称必须遵守 C# 标识符的命名规则。
`x-ms-client-request-id`	可选。提供客户端生成的不透明值，其中包含 1-kibite (KiB) 配置日志记录时记录在日志中的字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视 Azure 队列存储。

请求正文

无。

示例请求

Request Syntax:  
PUT https://myaccount.queue.core.windows.net/myqueue?comp=metadata HTTP/1.1  
  
Request Headers:  
x-ms-version: 2011-08-18  
x-ms-date: Fri, 16 Sep 2011 01:47:14 GMT  
x-ms-meta-meta-sample1: sample1  
x-ms-meta-meta-sample2: sample2  
Authorization: SharedKey myaccount:u6PSIebDltGW5xHpO77epRpiUhcsTkWMvcM4GTmfqqA=

响应

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

状态代码

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

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

响应头

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

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

响应正文

无。

授权

只有帐户所有者可以调用此操作。

注解

要删除队列元数据，请调用Set Queue Metadata而不指定任何元数据标头。

另请参阅

队列服务错误代码
 授权对 Azure 存储的请求
 状态和错误代码

通过