Package version:

Interface CreateTopicOptions

Represents settable options on a topic

interface CreateTopicOptions {
    authorizationRules?: AuthorizationRule[];
    autoDeleteOnIdle?: string;
    availabilityStatus?: EntityAvailabilityStatus;
    defaultMessageTimeToLive?: string;
    duplicateDetectionHistoryTimeWindow?: string;
    enableBatchedOperations?: boolean;
    enableExpress?: boolean;
    enablePartitioning?: boolean;
    maxMessageSizeInKilobytes?: number;
    maxSizeInMegabytes?: number;
    requiresDuplicateDetection?: boolean;
    status?: EntityStatus;
    supportOrdering?: boolean;
    userMetadata?: string;
}

Hierarchy (view full)

Properties

authorizationRules? autoDeleteOnIdle? availabilityStatus? defaultMessageTimeToLive? duplicateDetectionHistoryTimeWindow? enableBatchedOperations? enableExpress? enablePartitioning? maxMessageSizeInKilobytes? maxSizeInMegabytes? requiresDuplicateDetection? status? supportOrdering? userMetadata?

Properties

Optional authorizationRules

authorizationRules?: AuthorizationRule[]

Authorization rules on the topic

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 defaultMessageTimeToLive

defaultMessageTimeToLive?: string

Determines how long a message lives in the associated subscriptions. Subscriptions inherit the TTL from the topic unless they are created explicitly with a smaller TTL. Based on whether dead-lettering is enabled, a message whose TTL has expired will either be moved to the subscription’s associated dead-letter sub-queue or will be 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 duplicateDetectionHistoryTimeWindow

duplicateDetectionHistoryTimeWindow?: string

Specifies the time span during which the Service Bus will detect 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 topic.

Optional enablePartitioning

enablePartitioning?: boolean

Specifies whether the topic should be partitioned

Optional maxMessageSizeInKilobytes

maxMessageSizeInKilobytes?: number

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

(Configurable only for Premium Tier Service Bus namespace.)

Optional maxSizeInMegabytes

maxSizeInMegabytes?: number

Specifies the maximum topic size in megabytes. Any attempt to enqueue a message that will cause the topic to exceed this value will fail. All messages that are stored in the topic or any of its subscriptions count towards this value. Multiple copies of a message that reside in one or multiple subscriptions count as a single messages. For example, if message m exists once in subscription s1 and twice in subscription s2, m is counted as a single message.

Optional requiresDuplicateDetection

requiresDuplicateDetection?: boolean

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

Optional status

status?: EntityStatus

Status of the messaging entity.

Optional supportOrdering

supportOrdering?: boolean

Specifies whether the topic supports message ordering.

Optional userMetadata

userMetadata?: string

The user provided metadata information associated with the topic. 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