IQueue Interface

Definition

Type representing Service Bus queue.

public interface IQueue : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.ServiceBus.Fluent.IServiceBusManager,Microsoft.Azure.Management.ServiceBus.Fluent.Models.QueueInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.ServiceBus.Fluent.Models.QueueInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.ServiceBus.Fluent.IServiceBusManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IIndependentChild<Microsoft.Azure.Management.ServiceBus.Fluent.IServiceBusManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IIndependentChildResource<Microsoft.Azure.Management.ServiceBus.Fluent.IServiceBusManager,Microsoft.Azure.Management.ServiceBus.Fluent.Models.QueueInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.ServiceBus.Fluent.IQueue>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.ServiceBus.Fluent.Queue.Update.IUpdate>
type IQueue = interface
    interface IIndependentChildResource<IServiceBusManager, QueueInner>
    interface IGroupableResource<IServiceBusManager, QueueInner>
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IHasResourceGroup
    interface IHasManager<IServiceBusManager>
    interface IHasInner<QueueInner>
    interface IIndependentChild<IServiceBusManager>
    interface IRefreshable<IQueue>
    interface IUpdatable<IUpdate>
Public Interface IQueue
Implements IGroupableResource(Of IServiceBusManager, QueueInner), IHasInner(Of QueueInner), IHasManager(Of IServiceBusManager), IIndependentChild(Of IServiceBusManager), IIndependentChildResource(Of IServiceBusManager, QueueInner), IRefreshable(Of IQueue), IUpdatable(Of IUpdate)
Implements

Remarks

(Beta: This functionality is in preview and as such is subject to change in non-backwards compatible ways in

future releases, including removal, regardless of any compatibility expectations set by the containing library

version number.).

Properties

AccessedAt

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

ActiveMessageCount

Gets number of active messages in the queue.

AuthorizationRules

Gets entry point to manage authorization rules for the Service Bus queue.

CreatedAt

Gets the exact time the queue was created.

CurrentSizeInBytes

Gets current size of the queue, in bytes.

DeadLetterMessageCount

Gets number of messages in the dead-letter queue.

DefaultMessageTtlDuration

Gets the duration after which the message expires, starting from when the message is sent to queue.

DeleteOnIdleDurationInMinutes

Gets the idle duration after which the queue is automatically deleted.

DuplicateMessageDetectionHistoryDuration

Gets the duration of the duplicate detection history.

Inner (Inherited from IHasInner<T>)
IsBatchedOperationsEnabled

Gets indicates whether server-side batched operations are enabled.

IsDeadLetteringEnabledForExpiredMessages

Gets indicates whether this queue has dead letter support when a message expires.

IsDuplicateDetectionEnabled

Gets indicates if this queue requires duplicate detection.

IsExpressEnabled

Gets indicates whether express entities are enabled.

IsPartitioningEnabled

Gets indicates whether the queue is to be partitioned across multiple message brokers.

IsSessionEnabled

Gets indicates whether the queue supports sessions.

LockDurationInSeconds

Gets the duration of peek-lock which is the amount of time that the message is locked for other receivers.

Manager

Gets the manager client type of this resource type.

(Inherited from IHasManager<ManagerT>)
MaxDeliveryCountBeforeDeadLetteringMessage

Gets the maximum number of a message delivery before marking it as dead-lettered.

MaxSizeInMB

Gets the maximum size of memory allocated for the queue in megabytes.

MessageCount

Gets the number of messages in the queue.

ScheduledMessageCount

Gets number of messages sent to the queue that are yet to be released for consumption.

Status

Gets the current status of the queue.

TransferDeadLetterMessageCount

Gets number of messages transferred into dead letters.

TransferMessageCount

Gets number of messages transferred to another queue, topic, or subscription.

UpdatedAt

Gets the exact time the queue was updated.

Methods

Refresh()

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
Update() (Inherited from IUpdatable<T>)

Applies to