Get Queue Metadata

Get Queue Metadata

Switch on low bandwidth view

Collapse All

Language Filter

Windows Azure SDK, Community Technology Preview

Get Queue Metadata

[This is preliminary documentation and is subject to change.]

This operation retrieves user-defined metadata and queue properties on the specified queue. Metadata is associated with the queue as name-values pairs.

Request

The Get Queue Metadata request may be constructed as follows:

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

Development Storage URI

When making a request against development storage, specify the local hostname and Queue service port as 127.0.0.1:10001, followed by the development 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 About Development Storage.

URI Parameters

None.

Request Headers

The following table describes required and optional request headers.

Request Header	Description
Authorization	Required. Specifies the authentication scheme, account name, and signature. See Authentication Schemes for more information.
Date or x-ms-date	Required. Specifies the UTC time for the request. See for more information. See Authentication Schemes for more information.
x-ms-version	Optional. Specifies the version of the operation to use for this request. See Storage Service Versioning for more information.

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 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-message-count:int-value	The approximate number of messages in the queue.
x-ms-meta-name:string-value	A user-defined name/value pair.
x-ms-request-id	This header uniquely identifies the request that was made and can be used for troubleshooting the request. See Troubleshooting API Operations for more information.

Response Body

None.

Sample Response

Response Status:
HTTP/1.1 200 OK

Response Headers:
Transfer-Encoding: chunked
x-ms-approximate-messages-count: 0
Date: Tue, 18 Nov 2008 01:27:38 GMT
Server: Queue Service Version 1.0 Microsoft-HTTPAPI/2.0

Authorization

Only the account owner may call this operation.

Remarks

None.

Concepts

Queue Service Error Codes
Authentication Schemes
Status and Error Codes
About Development Storage