TopicProperties interface
Represents the input for updateTopic.
Properties
| authorization |
Authorization rules on the topic |
| auto |
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 |
| availability |
Availability status of the messaging entity. |
| default |
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 |
| duplicate |
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 |
| enable |
Specifies if batched operations should be allowed. |
| enable |
Specifies whether express entities are enabled on topic. |
| enable |
Specifies whether the topic should be partitioned |
| max |
The maximum message size in kilobytes for messages sent to this queue/topic. Not applicable if service version "2017-04" is chosen when creating the |
| max |
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. |
| name | Name of the topic |
| requires |
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. |
| support |
Specifies whether the topic supports message ordering. |
| user |
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. |
Property Details
authorizationRules
Authorization rules on the topic
authorizationRules?: AuthorizationRule[]Property Value
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: stringProperty Value
string
availabilityStatus
Availability status of the messaging entity.
availabilityStatus: EntityAvailabilityStatusProperty Value
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: stringProperty 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: stringProperty Value
string
enableBatchedOperations
Specifies if batched operations should be allowed.
enableBatchedOperations: booleanProperty Value
boolean
enableExpress
Specifies whether express entities are enabled on topic.
enableExpress: booleanProperty Value
boolean
enablePartitioning
Specifies whether the topic should be partitioned
enablePartitioning: booleanProperty Value
boolean
maxMessageSizeInKilobytes
The maximum message size in kilobytes for messages sent to this queue/topic.
Not applicable if service version "2017-04" is chosen when creating the ServiceBusAdministrationClient.
maxMessageSizeInKilobytes?: numberProperty 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: numberProperty Value
number
name
Name of the topic
name: stringProperty Value
string
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: booleanProperty Value
boolean
status
supportOrdering
Specifies whether the topic supports message ordering.
supportOrdering: booleanProperty 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: stringProperty Value
string