Set Queue Metadata
Updated: June 29, 2016
The Set Queue Metadata operation sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs.
The Set Queue Metadata request may be constructed as follows. HTTPS is recommended.
When 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:
The following additional parameters may be specified on the request URI.
Optional. The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Queue Service Operations.
The following table describes required and optional request headers.
Required. Specifies the authentication scheme, account name, and signature. For more information, see Authentication for the Azure Storage Services.
Date or x-ms-date
Required. Specifies the Coordinated Universal Time (UTC) for the request. For more information, see Authentication for the Azure Storage Services.
Optional. Specifies the version of the operation to use for this request. For more information, see Versioning for the Azure Storage Services.
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 that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers.
Optional. Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. Using this header is highly recommended for correlating client-side activities with requests received by the server. For more information, see About Storage Analytics Logging and Azure Logging: Using Logs to Track Storage Requests.
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=
The response includes an HTTP status code and a set of response headers.
A successful operation returns status code 204 (No Content).
For information about status codes, see Status and Error Codes.
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.
This header uniquely identifies the request that was made and can be used for troubleshooting the request. For more information, see Troubleshooting API Operations.
Indicates the version of the Queue service used to execute the request. This header is returned for requests made against version 2009-09-19 and later.
A UTC date/time value generated by the service that indicates the time at which the response was initiated.
Only the account owner may call this operation.
To delete queue metadata, call Set Queue Metadata without specifying any metadata headers.