Set Queue Metadata

Article
06/27/2023

The Set Queue Metadata operation sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.

Request

You can construct the Set Queue Metadata request as follows. We recommend that you use HTTPS.

Method	Request URI	HTTP version
`PUT`	`https://myaccount.queue.core.windows.net/myqueue?comp=metadata`	HTTP/1.1

Emulated storage service request

When you're making a request against the emulated storage service, specify the emulator hostname and Queue service port as 127.0.0.1:10001, followed by the emulated storage account name:

Method	Request URI	HTTP version
`PUT`	`http://127.0.0.1:10001/devstoreaccount1/myqueue?comp=metadata`	HTTP/1.1

For more information, see Use the Azurite emulator for local Azure Storage development.

URI parameters

You can specify the following additional parameters on the request URI:

Parameter	Description
`timeout`	Optional. The `timeout` parameter is expressed in seconds. For more information, see Set time-outs for Queue service operations.

Request headers

The required and optional request headers are described in the following table:

Request header	Description
`Authorization`	Required. Specifies the authorization scheme, account name, and signature. For more information, see Authorize requests to Azure Storage.
`Date` or `x-ms-date`	Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authorize requests to Azure Storage.
`x-ms-version`	Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage services.
`x-ms-meta-name:string-value`	Optional. A name-value pair to associate with the queue as metadata. Each call to this operation replaces all existing metadata attached to the queue. To remove all metadata from the queue, call this operation with no metadata headers. Note: As of version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers.
`x-ms-client-request-id`	Optional. Provides a client-generated, opaque value with a 1-kibibyte (KiB) character limit that's recorded in the logs when logging is configured. We highly recommend that you use this header to correlate client-side activities with requests that the server receives. For more information, see Monitor Azure Queue Storage.

Request body

None.

Sample request

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=

Response

The response includes an HTTP status code and a set of response headers.

Status code

A successful operation returns status code 204 (No Content).

For more information about status codes, see Status and error codes.

Response headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response header	Description
`x-ms-request-id`	Uniquely identifies the request that was made and can be used to troubleshoot the request. For more information, see Troubleshoot API operations.
`x-ms-version`	Indicates the Queue service version that was used to execute the request. This header is returned for requests that were made against version 2009-09-19 and later.
`Date`	A UTC date/time value that's generated by the service, which indicates the time when the response was initiated.
`x-ms-client-request-id`	This header can be used to troubleshoot requests and corresponding responses. The value of this header is equal to the value of the `x-ms-client-request-id` header if it's present in the request and the value contains no more than 1,024 visible ASCII characters. If the `x-ms-client-request-id` header isn't present in the request, it won't be present in the response.

Response body

None.

Authorization

Only the account owner may call this operation.

Remarks

To delete queue metadata, call Set Queue Metadata without specifying any metadata headers.

Share via