Export (0) Print
Expand All

Queue Description

Updated: April 22, 2014

The queue description is an XML AtomPub document that defines the desired semantics for a subscription. The queue description contains the following properties. For more information, see the QueueDescription Properties topic.

MaxSizeInMegaBytes: Number
Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that will cause the queue to exceed this value will fail. You can only set this parameter at queue creation time using the following values:

  • Range: 1 – 1024 (valid values are 1024, 2048, 3072, 4096, 5120)

  • Default: 1*1024 (valid values are 1024, 2048, 3072, 4096, 5120)

SizeinBytes: Number
Reflects the actual bytes that messages in the queue currently occupy toward the queue’s quota.

  • Range: 0 –MaxSizeinMegaBytes

MessageCount: Number
Displays the number of messages currently in the queue.

DefaultMessageTimeToLive: XML datetime
Depending on whether DeadLettering is enabled, a message is automatically moved to the DeadLetterQueue or deleted if it has been stored in the queue for longer than the specified time. This value is overwritten by a TTL specified on the message if and only if the message TTL is smaller than the TTL set on the queue. This value is immutable after the Queue has been created:

  • Range: 1 second – TimeSpan.MaxValue

  • Default: TimeSpan.MaxValue

LockDuration: XML datetime
Determines the amount of time in seconds in which a message should be locked for processing by a receiver. After this period, the message is unlocked and available for consumption by the next receiver. Settable only at queue creation time:

  • Range: 0 – 5 minutes. 0 means that the message is not locked

  • Default: 30 seconds

RequiresSession: True, False
Settable only at queue creation time. If set to true, the queue will be session-aware and only SessionReceiver will be supported. Session-aware queues are not supported through REST.

  • Default for durable queue: false

RequiresDuplicateDetection: True, False
Settable only at queue creation time.

  • Default for durable queue: false

EnableDeadLetteringOnMessageExpiration: True, False
This field controls how the Service Bus handles a message whose TTL has expired. If it is enabled and a message expires, the Service Bus moves the message from the queue into the queue’s dead-letter sub-queue. If disabled, message will be permanently deleted from the queue. Settable only at queue creation time.

  • Default: false

Specifies the time span during which the Service Bus detects message duplication:

  • Range: 1 second – 7 days

  • Default: 10 minutes

Enables or disables service side batching behavior when performing operations for the specific queue. When enabled, service bus will collect/batch multiple operations to the backend to be more connection efficient. If user wants lower operation latency then they can disable this feature.

The path to the recipient to which the message is forwarded.

The maximum number of times a message SB will try to deliver before being dead lettered or discarded.

Gets whether anonymous access is allowed.

Gets the authorization rules for the description.

Gets or sets the current status of the queue (enabled or disabled). When a queue is disabled, that queue cannot send or receive messages.

Gets or sets whether the queue supports ordering.

It is important to note that the schema validation of the description during queue creation is sensitive to the order of its child elements. For example, the following is not accepted as a valid queue description.

<QueueDescription xmlns=\"http://schemas.microsoft.com/netservices/2010/10/servicebus/connect\">

However, if the elements appear as below, it is accepted as a valid queue description:

<QueueDescription xmlns=\"http://schemas.microsoft.com/netservices/2010/10/servicebus/connect\">

  • List all queues under a given path:

    http://<serviceBusAddress>/$Resources/Queues?$filter=startswith(path, ‘/foo/bar’)
  • List all queues updated in the last 5 minutes:

    http://<serviceBusAddress>/$Resources/Queues?$filter=lastModifiedTime Gt  2011-08-09T21:44:36.2481552Z
  • List all queues having at least one message:

    http://<serviceBusAddress>/$Resources/Queues?$filter=MessageCount Gt 0

© 2014 Microsoft