SBQueue interface

Package:

@azure/arm-servicebus

Description of queue Resource.

Extends

ProxyResource

Properties

accessedAt	Last time a message was sent, or the last time there was a receive request to this queue. NOTE: This property will not be serialized. It can only be populated by the server.
autoDeleteOnIdle	ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
countDetails	Message Count Details. NOTE: This property will not be serialized. It can only be populated by the server.
createdAt	The exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.
deadLetteringOnMessageExpiration	A value that indicates whether this queue has dead letter support when a message expires.
defaultMessageTimeToLive	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	ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations	Value that indicates whether server-side batched operations are enabled.
enableExpress	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	A value that indicates whether the queue is to be partitioned across multiple message brokers.
forwardDeadLetteredMessagesTo	Queue/Topic name to forward the Dead Letter message
forwardTo	Queue/Topic name to forward the messages
lockDuration	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	The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.
maxMessageSizeInKilobytes	Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.
maxSizeInMegabytes	The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.
messageCount	The number of messages in the queue. NOTE: This property will not be serialized. It can only be populated by the server.
requiresDuplicateDetection	A value indicating if this queue requires duplicate detection.
requiresSession	A value that indicates whether the queue supports the concept of sessions.
sizeInBytes	The size of the queue, in bytes. NOTE: This property will not be serialized. It can only be populated by the server.
status	Enumerates the possible values for the status of a messaging entity.
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt	The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accessedAt

Last time a message was sent, or the last time there was a receive request to this queue. NOTE: This property will not be serialized. It can only be populated by the server.

accessedAt?: Date

Property Value

Date

autoDeleteOnIdle

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

autoDeleteOnIdle?: string

Property Value

string

countDetails

Message Count Details. NOTE: This property will not be serialized. It can only be populated by the server.

countDetails?: MessageCountDetails

Property Value

MessageCountDetails

createdAt

The exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdAt?: Date

Property Value

Date

deadLetteringOnMessageExpiration

A value that indicates whether this queue has dead letter support when a message expires.

deadLetteringOnMessageExpiration?: boolean

Property Value

boolean

defaultMessageTimeToLive

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.

defaultMessageTimeToLive?: string

Property Value

string

duplicateDetectionHistoryTimeWindow

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

duplicateDetectionHistoryTimeWindow?: string

Property Value

string

enableBatchedOperations

Value that indicates whether server-side batched operations are enabled.

enableBatchedOperations?: boolean

Property Value

boolean

enableExpress

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

enableExpress?: boolean

Property Value

boolean

enablePartitioning

A value that indicates whether the queue is to be partitioned across multiple message brokers.

enablePartitioning?: boolean

Property Value

boolean

forwardDeadLetteredMessagesTo

Queue/Topic name to forward the Dead Letter message

forwardDeadLetteredMessagesTo?: string

Property Value

string

forwardTo

Queue/Topic name to forward the messages

forwardTo?: string

Property Value

string

lockDuration

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.

lockDuration?: string

Property Value

string

maxDeliveryCount

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

maxDeliveryCount?: number

Property Value

number

maxMessageSizeInKilobytes

Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.

maxMessageSizeInKilobytes?: number

Property Value

number

maxSizeInMegabytes

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

maxSizeInMegabytes?: number

Property Value

number

messageCount

The number of messages in the queue. NOTE: This property will not be serialized. It can only be populated by the server.

messageCount?: number

Property Value

number

requiresDuplicateDetection

A value indicating if this queue requires duplicate detection.

requiresDuplicateDetection?: boolean

Property Value

boolean

requiresSession

A value that indicates whether the queue supports the concept of sessions.

requiresSession?: boolean

Property Value

boolean

sizeInBytes

The size of the queue, in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

sizeInBytes?: number

Property Value

number

status

Enumerates the possible values for the status of a messaging entity.

status?: EntityStatus

Property Value

EntityStatus

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

updatedAt

The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

updatedAt?: Date

Property Value

Date

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

location

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From ProxyResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type