CreateSubscriptionOptions interface

Package:

@azure/service-bus

Represents settable options on a subscription

Extends

OperationOptions

Properties

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.
deadLetteringOnFilterEvaluationExceptions	Determines how the Service Bus handles a message that causes an exception during a subscription’s filter evaluation. If the value is set to true, the message that caused the exception will be moved to the subscription’s dead-letter sub-queue. Otherwise, it will be discarded. By default this parameter is set to true, allowing the user a chance to investigate the cause of the exception. It can occur from a malformed message or some incorrect assumptions being made in the filter about the form of the message. Settable only at topic creation time.
deadLetteringOnMessageExpiration	If it is enabled and a message expires, the Service Bus moves the message from the queue into the subscription’s dead-letter sub-queue. If disabled, message will be permanently deleted from the subscription’s main queue. Settable only at subscription creation time.
defaultMessageTimeToLive	Determines how long a message lives in the subscription. Based on whether dead-lettering is enabled, a message whose TTL has expired will either be moved to the subscription’s associated DeadLtterQueue or permanently 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
defaultRuleOptions	Represents the options to create the default rule for the subscription.
enableBatchedOperations	Specifies if batched operations should be allowed.
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	The default lock duration is applied to subscriptions that do not define a lock duration. (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.
requiresSession	If set to true, the subscription will be session-aware and only SessionReceiver will be supported. Session-aware subscription are not supported through REST. Settable only at subscription creation time.
status	Status of the messaging entity.
userMetadata	The user provided metadata information associated with the subscription. 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

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

deadLetteringOnFilterEvaluationExceptions

Determines how the Service Bus handles a message that causes an exception during a subscription’s filter evaluation. If the value is set to true, the message that caused the exception will be moved to the subscription’s dead-letter sub-queue. Otherwise, it will be discarded. By default this parameter is set to true, allowing the user a chance to investigate the cause of the exception. It can occur from a malformed message or some incorrect assumptions being made in the filter about the form of the message. Settable only at topic creation time.

deadLetteringOnFilterEvaluationExceptions?: boolean

Property Value

boolean

deadLetteringOnMessageExpiration

If it is enabled and a message expires, the Service Bus moves the message from the queue into the subscription’s dead-letter sub-queue. If disabled, message will be permanently deleted from the subscription’s main queue. Settable only at subscription creation time.

deadLetteringOnMessageExpiration?: boolean

Property Value

boolean

defaultMessageTimeToLive

Determines how long a message lives in the subscription. Based on whether dead-lettering is enabled, a message whose TTL has expired will either be moved to the subscription’s associated DeadLtterQueue or permanently 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

defaultMessageTimeToLive?: string

Property Value

string

defaultRuleOptions

Represents the options to create the default rule for the subscription.

defaultRuleOptions?: { action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

Property Value

{ action?: SqlRuleAction, filter?: CorrelationRuleFilter | SqlRuleFilter, name: string }

enableBatchedOperations

Specifies if batched operations should be allowed.

enableBatchedOperations?: 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

The default lock duration is applied to subscriptions that do not define a lock duration. (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

requiresSession

If set to true, the subscription will be session-aware and only SessionReceiver will be supported. Session-aware subscription are not supported through REST. Settable only at subscription 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 subscription. 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