Package version:

Interface CreateQueueOptions

Represents settable options on a queue

interface CreateQueueOptions {
    authorizationRules?: AuthorizationRule[];
    autoDeleteOnIdle?: string;
    availabilityStatus?: EntityAvailabilityStatus;
    deadLetteringOnMessageExpiration?: boolean;
    defaultMessageTimeToLive?: string;
    duplicateDetectionHistoryTimeWindow?: string;
    enableBatchedOperations?: boolean;
    enableExpress?: boolean;
    enablePartitioning?: boolean;
    forwardDeadLetteredMessagesTo?: string;
    forwardTo?: string;
    lockDuration?: string;
    maxDeliveryCount?: number;
    maxMessageSizeInKilobytes?: number;
    maxSizeInMegabytes?: number;
    requiresDuplicateDetection?: boolean;
    requiresSession?: boolean;
    status?: EntityStatus;
    userMetadata?: string;
}

Hierarchy (view full)

Properties

authorizationRules? autoDeleteOnIdle? availabilityStatus? deadLetteringOnMessageExpiration? defaultMessageTimeToLive? duplicateDetectionHistoryTimeWindow? enableBatchedOperations? enableExpress? enablePartitioning? forwardDeadLetteredMessagesTo? forwardTo? lockDuration? maxDeliveryCount? maxMessageSizeInKilobytes? maxSizeInMegabytes? requiresDuplicateDetection? requiresSession? status? userMetadata?

Properties

Optional authorizationRules

authorizationRules?: AuthorizationRule[]

Authorization rules on the queue

Optional autoDeleteOnIdle

autoDeleteOnIdle?: string

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

Optional availabilityStatus

availabilityStatus?: EntityAvailabilityStatus

Availability status of the messaging entity.

Optional deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: boolean

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.

Optional defaultMessageTimeToLive

defaultMessageTimeToLive?: string

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

Optional duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: string

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

Optional enableBatchedOperations

enableBatchedOperations?: boolean

Specifies if batched operations should be allowed.

Optional enableExpress

enableExpress?: boolean

Specifies whether express entities are enabled on queue.

Optional enablePartitioning

enablePartitioning?: boolean

Specifies whether the queue should be partitioned.

Optional forwardDeadLetteredMessagesTo

forwardDeadLetteredMessagesTo?: string

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>

Optional forwardTo

forwardTo?: string

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>

Optional lockDuration

lockDuration?: string

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

Optional maxDeliveryCount

maxDeliveryCount?: number

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

Optional maxMessageSizeInKilobytes

maxMessageSizeInKilobytes?: number

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

(Configurable only for Premium Tier Service Bus namespace.)

Optional maxSizeInMegabytes

maxSizeInMegabytes?: number

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

Optional requiresDuplicateDetection

requiresDuplicateDetection?: boolean

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

Optional requiresSession

requiresSession?: boolean

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.

Optional status

status?: EntityStatus

Status of the messaging entity.

Optional userMetadata

userMetadata?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc