Package version:

Interface CreateSubscriptionOptions

Represents settable options on a subscription

interface CreateSubscriptionOptions {
    autoDeleteOnIdle?: string;
    availabilityStatus?: EntityAvailabilityStatus;
    deadLetteringOnFilterEvaluationExceptions?: boolean;
    deadLetteringOnMessageExpiration?: boolean;
    defaultMessageTimeToLive?: string;
    defaultRuleOptions?: {
        action?: SqlRuleAction;
        filter?: CorrelationRuleFilter | SqlRuleFilter;
        name: string;
    };
    enableBatchedOperations?: boolean;
    forwardDeadLetteredMessagesTo?: string;
    forwardTo?: string;
    lockDuration?: string;
    maxDeliveryCount?: number;
    requiresSession?: boolean;
    status?: EntityStatus;
    userMetadata?: string;
}

Hierarchy (view full)

  • delay
    • CreateSubscriptionOptions

Properties

autoDeleteOnIdle? availabilityStatus? deadLetteringOnFilterEvaluationExceptions? deadLetteringOnMessageExpiration? defaultMessageTimeToLive? defaultRuleOptions? enableBatchedOperations? forwardDeadLetteredMessagesTo? forwardTo? lockDuration? maxDeliveryCount? requiresSession? status? userMetadata?

Properties

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 deadLetteringOnFilterEvaluationExceptions

deadLetteringOnFilterEvaluationExceptions?: boolean

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.

Optional deadLetteringOnMessageExpiration

deadLetteringOnMessageExpiration?: boolean

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.

Optional defaultMessageTimeToLive

defaultMessageTimeToLive?: string

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

Optional defaultRuleOptions

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

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

Type declaration

  • Optional action?: SqlRuleAction

    The SQL like expression that can be executed on the message should the associated filter apply.

  • Optional filter?: CorrelationRuleFilter | SqlRuleFilter

    Defines the filter expression that the rule evaluates. For SqlRuleFilter input, the expression string is interpreted as a SQL92 expression which must evaluate to True or False. Only one between a CorrelationRuleFilter or a SqlRuleFilter can be defined.

  • name: string

    Name of the rule

Optional enableBatchedOperations

enableBatchedOperations?: boolean

Specifies if batched operations should be allowed.

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

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

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 requiresSession

requiresSession?: boolean

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.

Optional status

status?: EntityStatus

Status of the messaging entity.

Optional userMetadata

userMetadata?: string

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.

Settings

Member Visibility

Theme

Generated using TypeDoc