ServiceBusQueue Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public class ServiceBusQueue
type ServiceBusQueue = class
Public Class ServiceBusQueue
- Inheritance
-
ServiceBusQueue
Constructors
ServiceBusQueue() |
Initializes a new instance of the ServiceBusQueue class. |
Properties
AccessedAt |
Optional. The time the queue was last accessed. |
AuthorizationRules |
Optional. Gets the authorization rules for the description. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
AutoDeleteOnIdle |
Optional. Implemented. |
CountDetails |
Optional. Current queue statistics. |
CreatedAt |
Optional. The time the queue was created at. |
DeadLetteringOnMessageExpiration |
Optional. 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 (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
DefaultMessageTimeToLive |
Optional. 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 (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
DuplicateDetectionHistoryTimeWindow |
Optional. Specifies the time span during which the Service Bus detects message duplication:* Range: 1 second - 7 days* Default: 10 minutes (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
EnableBatchedOperations |
Optional. 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. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
EntityAvailabilityStatus |
Optional. The current availability status of the queue. |
IsAnonymousAccessible |
Optional. Gets whether anonymous access is allowed. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
LockDuration |
Optional. 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
|
MaxDeliveryCount |
Optional. The maximum number of times a message SB will try to deliver before being dead lettered or discarded. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
MaxSizeInMegabytes |
Optional. 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) (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
MessageCount |
Optional. Displays the number of messages currently in the queue. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
Name |
Optional. The name of the queue. |
RequiresDuplicateDetection |
Optional. Settable only at queue creation time.* Default for durable queue: false (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
RequiresSession |
Optional. 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 (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
SizeInBytes |
Optional. Reflects the actual bytes that messages in the queue currently occupy toward the queue's quota.* Range: 0 -MaxTopicSizeinMegaBytes (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
Status |
Optional. Gets or sets the current status of the queue (enabled or disabled). When a queue is disabled, that queue cannot send or receive messages. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
SupportOrdering |
Optional. Gets or sets whether the queue supports ordering. (see http://msdn.microsoft.com/en-us/library/windowsazure/hh780773.aspx for more information) |
UpdatedAt |
Optional. The time the queue was last updated. |
Applies to
Azure SDK for .NET