Share via

CreateQueueOptions interface

  • Reference
Package:
@azure/service-bus

Represents settable options on a queue

Extends
OperationOptions

Properties

authorizationRules

Authorization rules on the queue
autoDeleteOnIdle

Max idle time before entity is deleted. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations
availabilityStatus

Availability status of the messaging entity.
deadLetteringOnMessageExpiration

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.
defaultMessageTimeToLive

Depending on whether DeadLettering is enabled, a message is automatically moved to the dead-letter sub-queue 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. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations
duplicateDetectionHistoryTimeWindow

Specifies the time span during which the Service Bus detects message duplication. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations
enableBatchedOperations

Specifies if batched operations should be allowed.
enableExpress

Specifies whether express entities are enabled on queue.
enablePartitioning

Specifies whether the queue should be partitioned.
forwardDeadLetteredMessagesTo

Absolute URL or the name of the queue or topic the dead-lettered messages are to be forwarded to. For example, an absolute URL input would be of the form sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
forwardTo

Absolute URL or the name of the queue or topic the messages are to be forwarded to. For example, an absolute URL input would be of the form sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>
lockDuration

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. (If sessions are enabled, this lock duration is applicable for sessions and not for messages.)

This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations
maxDeliveryCount

The maximum delivery count of messages after which if it is still not settled, gets moved to the dead-letter sub-queue.
maxMessageSizeInKilobytes

The maximum message size in kilobytes for messages sent to this queue.

(Configurable only for Premium Tier Service Bus namespace.)
maxSizeInMegabytes

Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that will cause the queue to exceed this value will fail.
requiresDuplicateDetection

If enabled, the topic will detect duplicate messages within the time span specified by the DuplicateDetectionHistoryTimeWindow property. Settable only at queue creation time.
requiresSession

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

Status of the messaging entity.
userMetadata

The user provided metadata information associated with the queue. Used to specify textual content such as tags, labels, etc. Value must not exceed 1024 bytes encoded in utf-8.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions

Options used when creating and sending HTTP requests for this operation.
serializerOptions

Options to override serialization/de-serialization behavior.
tracingOptions

Options used when tracing is enabled.

Property Details

authorizationRules

Authorization rules on the queue

authorizationRules?: AuthorizationRule[]

Property Value

AuthorizationRule[]

autoDeleteOnIdle

Max idle time before entity is deleted. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations

autoDeleteOnIdle?: string

Property Value

string

availabilityStatus

Availability status of the messaging entity.

availabilityStatus?: EntityAvailabilityStatus

Property Value

EntityAvailabilityStatus

deadLetteringOnMessageExpiration

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.

deadLetteringOnMessageExpiration?: boolean

Property Value

boolean

defaultMessageTimeToLive

Depending on whether DeadLettering is enabled, a message is automatically moved to the dead-letter sub-queue 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. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations

defaultMessageTimeToLive?: string

Property Value

string

duplicateDetectionHistoryTimeWindow

Specifies the time span during which the Service Bus detects message duplication. This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations

duplicateDetectionHistoryTimeWindow?: string

Property Value

string

enableBatchedOperations

Specifies if batched operations should be allowed.

enableBatchedOperations?: boolean

Property Value

boolean

enableExpress

Specifies whether express entities are enabled on queue.

enableExpress?: boolean

Property Value

boolean

enablePartitioning

Specifies whether the queue should be partitioned.

enablePartitioning?: boolean

Property Value

boolean

forwardDeadLetteredMessagesTo

Absolute URL or the name of the queue or topic the dead-lettered messages are to be forwarded to. For example, an absolute URL input would be of the form sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardDeadLetteredMessagesTo?: string

Property Value

string

forwardTo

Absolute URL or the name of the queue or topic the messages are to be forwarded to. For example, an absolute URL input would be of the form sb://<your-service-bus-namespace-endpoint>/<queue-or-topic-name>

forwardTo?: string

Property Value

string

lockDuration

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. (If sessions are enabled, this lock duration is applicable for sessions and not for messages.)

This is to be specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds.

More on ISO-8601 duration format: https://en.wikipedia.org/wiki/ISO_8601#Durations

lockDuration?: string

Property Value

string

maxDeliveryCount

The maximum delivery count of messages after which if it is still not settled, gets moved to the dead-letter sub-queue.

maxDeliveryCount?: number

Property Value

number

maxMessageSizeInKilobytes

The maximum message size in kilobytes for messages sent to this queue.

(Configurable only for Premium Tier Service Bus namespace.)

maxMessageSizeInKilobytes?: number

Property Value

number

maxSizeInMegabytes

Specifies the maximum queue size in megabytes. Any attempt to enqueue a message that will cause the queue to exceed this value will fail.

maxSizeInMegabytes?: number

Property Value

number

requiresDuplicateDetection

If enabled, the topic will detect duplicate messages within the time span specified by the DuplicateDetectionHistoryTimeWindow property. Settable only at queue creation time.

requiresDuplicateDetection?: boolean

Property Value

boolean

requiresSession

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

requiresSession?: boolean

Property Value

boolean

status

Status of the messaging entity.

status?: EntityStatus

Property Value

EntityStatus

userMetadata

The user provided metadata information associated with the queue. Used to specify textual content such as tags, labels, etc. Value must not exceed 1024 bytes encoded in utf-8.

userMetadata?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions