CreateTopicOptions interface

Package:

@azure/service-bus

Represents settable options on a topic

Extends

OperationOptions

Properties

authorizationRules	Authorization rules on the topic
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.
defaultMessageTimeToLive	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
duplicateDetectionHistoryTimeWindow	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
enableBatchedOperations	Specifies if batched operations should be allowed.
enableExpress	Specifies whether express entities are enabled on topic.
enablePartitioning	Specifies whether the topic should be partitioned
maxMessageSizeInKilobytes	The maximum message size in kilobytes for messages sent to this topic. (Configurable only for Premium Tier Service Bus namespace.)
maxSizeInMegabytes	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.
requiresDuplicateDetection	If enabled, the topic will detect duplicate messages within the time span specified by the DuplicateDetectionHistoryTimeWindow property. Settable only at topic creation time.
status	Status of the messaging entity.
supportOrdering	Specifies whether the topic supports message ordering.
userMetadata	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.

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 topic

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

defaultMessageTimeToLive

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

defaultMessageTimeToLive?: string

Property Value

string

duplicateDetectionHistoryTimeWindow

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

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

enableExpress?: boolean

Property Value

boolean

enablePartitioning

Specifies whether the topic should be partitioned

enablePartitioning?: boolean

Property Value

boolean

maxMessageSizeInKilobytes

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

(Configurable only for Premium Tier Service Bus namespace.)

maxMessageSizeInKilobytes?: number

Property Value

number

maxSizeInMegabytes

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.

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 topic creation time.

requiresDuplicateDetection?: boolean

Property Value

boolean

status

Status of the messaging entity.

status?: EntityStatus

Property Value

EntityStatus

supportOrdering

Specifies whether the topic supports message ordering.

supportOrdering?: boolean

Property Value

boolean

userMetadata

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.

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