Get Queue Metadata

The Get Queue Metadata operation retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-value pairs.

Request

The Get Queue Metadata request may be constructed as follows. We recommend that you use HTTPS.

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

Emulated storage service request

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

Method	Request URI	HTTP version
GET/HEAD	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

The following additional parameters may be specified on the request URI:

Parameter	Description
timeout	Optional. The timeout parameter is expressed in seconds. For more information, see Set time-outs for Azure Queue Storage 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-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.

Response

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

Status code

A successful operation returns status code 200 (OK).

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-approximate-messages-count:int-value	The approximate number of messages in the queue. This number is not lower than the actual number of messages in the queue, but could be higher.
x-ms-meta-name:string-value	A user-defined name/value pair.
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 Azure Queue Storage version that was used to execute the request. This header is returned for requests made against version 2009-09-19 or 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	Can be used to troubleshoot requests and their 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.

Sample response

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-approximate-messages-count: 0  
Date: Fri, 16 Sep 2011 01:27:38 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  

Authorization

This operation can be performed by the account owner and by anyone with a shared access signature with permissions to perform this operation.

Remarks

None.

See also

Queue Storage error codes
Authorize requests to Azure Storage
Status and error codes