Export (0) Print
Expand All
2 out of 10 rated this helpful - Rate this topic

Queue Service REST API

Updated: January 16, 2014

The Queue service stores messages that may be read by any client who has access to the storage account.

A queue can contain an unlimited number of messages, each of which can be up to 64KB in size using version 2011-08-18 or newer. For previous versions, the maximum size of a message is 8KB. Messages are generally added to the end of the queue and retrieved from the front of the queue, although first in, first out (FIFO) behavior is not guaranteed.

If you need to store messages larger than 64KB, you can store message data as a blob or in a table, and then store a reference to the data as a message in a queue.

The REST API for the Queue service includes the operations shown in the following table.


Operation Description

Set Queue Service Properties (REST API)

Sets the properties of the Queue service.

Get Queue Service Properties (REST API)

Gets the properties of the Queue service.

List Queues (REST API)

Lists all queues under the given account.

Preflight Queue Request

Queries the Cross-Origin Resource Sharing (CORS) rules for the Queue service prior to sending the actual request.

Get Queue Service Stats (REST API)

Retrieves statistics related to replication for the Queue service. This operation is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account.

Create Queue (REST API)

Creates a new queue under the given account.

Delete Queue (REST API)

Deletes a queue.

Get Queue Metadata (REST API)

Returns queue properties, including user-defined metadata.

Set Queue Metadata (REST API)

Sets user-defined metadata on the queue.

Get Queue ACL (REST API)

Returns details on any stored access policies specified on the queue.

Set Queue ACL (REST API)

Sets stored access policies for the queue that may be used with Shared Access Signatures.

Put Message (REST API)

Adds a message to the queue and optionally sets a visibility timeout for the message.

Get Messages (REST API)

Retrieves a message from the queue and makes it invisible to other consumers.

Peek Messages (REST API)

Retrieves a message from the front of the queue, without changing the message visibility.

Delete Message (REST API)

Deletes a specified message from the queue.

Clear Messages (REST API)

Clears all messages from the queue.

Update Message (REST API)

Updates the visibility timeout of a message and/or the message contents.

See Also

© 2014 Microsoft. All rights reserved.