Queue Service API
[This is prerelease documentation and is subject to change in future releases.]

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 8 KB in size. 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 8 KB, 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

List Queues

Lists all queues under the given account.

Create Queue

Creates a new queue under the given account.

Delete Queue

Deletes a queue.

Get Queue Metadata

Returns queue properties, including user-defined metadata.

Set Queue Metadata

Sets user-defined metadata on the queue.

Put Message

Adds a message to the queue.

Get Messages

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

Peek Messages

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

Delete Message

Deletes a specified message from the queue.

Clear Messages

Clears all messages from the queue.

In This Section

See Also

Page view tracker