SBQueue Class

Definition

Description of queue Resource.

[Microsoft.Rest.Serialization.JsonTransformation]
public class SBQueue : Microsoft.Azure.Management.ServiceBus.Models.Resource
type SBQueue = class
    inherit Resource
Public Class SBQueue
Inherits Resource
Inheritance
System.Object
SBQueue
Attributes

Constructors

SBQueue()

Initializes a new instance of the SBQueue class.

Properties

AccessedAt

Gets last time a message was sent, or the last time there was a receive request to this queue.

AutoDeleteOnIdle

Gets or sets ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

CountDetails

Gets message Count Details.

CreatedAt

Gets the exact time the message was created.

DeadLetteringOnMessageExpiration

Gets or sets a value that indicates whether this queue has dead letter support when a message expires.

DefaultMessageTimeToLive

Gets or sets ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

DuplicateDetectionHistoryTimeWindow

Gets or sets ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

EnableExpress

Gets or sets a value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

EnablePartitioning

Gets or sets a value that indicates whether the queue is to be partitioned across multiple message brokers.

ForwardDeadLetteredMessagesTo

Gets or sets queue/Topic name to forward the Dead Letter message

ForwardTo

Gets or sets queue/Topic name to forward the messages

Id

Gets resource Id

(Inherited from Resource)
LockDuration

Gets or sets ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.

MaxDeliveryCount

Gets or sets the maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

MaxSizeInMegabytes

Gets or sets the maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

MessageCount

Gets the number of messages in the queue.

Name

Gets resource name

(Inherited from Resource)
RequiresDuplicateDetection

Gets or sets a value indicating if this queue requires duplicate detection.

RequiresSession

Gets or sets a value that indicates whether the queue supports the concept of sessions.

SizeInBytes

Gets the size of the queue, in bytes.

Status

Gets or sets enumerates the possible values for the status of a messaging entity. Possible values include: 'Active', 'Disabled', 'Restoring', 'SendDisabled', 'ReceiveDisabled', 'Creating', 'Deleting', 'Renaming', 'Unknown'

Type

Gets resource type

(Inherited from Resource)
UpdatedAt

Gets the exact time the message was updated.

Applies to