SBTopic interface

Package:

@azure/arm-servicebus

Description of topic resource.

Extends

ProxyResource

Properties

accessedAt	Last time the message was sent, or a request was received, for this topic. NOTE: This property will not be serialized. It can only be populated by the server.
autoDeleteOnIdle	ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
countDetails	Message count details NOTE: This property will not be serialized. It can only be populated by the server.
createdAt	Exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.
defaultMessageTimeToLive	ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
duplicateDetectionHistoryTimeWindow	ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enableBatchedOperations	Value that indicates whether server-side batched operations are enabled.
enableExpress	Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
enablePartitioning	Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
maxMessageSizeInKilobytes	Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.
maxSizeInMegabytes	Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
requiresDuplicateDetection	Value indicating if this topic requires duplicate detection.
sizeInBytes	Size of the topic, in bytes. NOTE: This property will not be serialized. It can only be populated by the server.
status	Enumerates the possible values for the status of a messaging entity.
subscriptionCount	Number of subscriptions. NOTE: This property will not be serialized. It can only be populated by the server.
supportOrdering	Value that indicates whether the topic supports ordering.
systemData	The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.
updatedAt	The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location	The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

accessedAt

Last time the message was sent, or a request was received, for this topic. NOTE: This property will not be serialized. It can only be populated by the server.

accessedAt?: Date

Property Value

Date

autoDeleteOnIdle

ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

autoDeleteOnIdle?: string

Property Value

string

countDetails

Message count details NOTE: This property will not be serialized. It can only be populated by the server.

countDetails?: MessageCountDetails

Property Value

MessageCountDetails

createdAt

Exact time the message was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdAt?: Date

Property Value

Date

defaultMessageTimeToLive

ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

defaultMessageTimeToLive?: string

Property Value

string

duplicateDetectionHistoryTimeWindow

ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

duplicateDetectionHistoryTimeWindow?: string

Property Value

string

enableBatchedOperations

Value that indicates whether server-side batched operations are enabled.

enableBatchedOperations?: boolean

Property Value

boolean

enableExpress

Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

enableExpress?: boolean

Property Value

boolean

enablePartitioning

Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

enablePartitioning?: boolean

Property Value

boolean

maxMessageSizeInKilobytes

Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

maxMessageSizeInKilobytes?: number

Property Value

number

maxSizeInMegabytes

Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

maxSizeInMegabytes?: number

Property Value

number

requiresDuplicateDetection

Value indicating if this topic requires duplicate detection.

requiresDuplicateDetection?: boolean

Property Value

boolean

sizeInBytes

Size of the topic, in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

sizeInBytes?: number

Property Value

number

status

Enumerates the possible values for the status of a messaging entity.

status?: EntityStatus

Property Value

EntityStatus

subscriptionCount

Number of subscriptions. NOTE: This property will not be serialized. It can only be populated by the server.

subscriptionCount?: number

Property Value

number

supportOrdering

Value that indicates whether the topic supports ordering.

supportOrdering?: boolean

Property Value

boolean

systemData

The system meta data relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

updatedAt

The exact time the message was updated. NOTE: This property will not be serialized. It can only be populated by the server.

updatedAt?: Date

Property Value

Date

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

location

The geo-location where the resource lives NOTE: This property will not be serialized. It can only be populated by the server.

location?: string

Property Value

string

Inherited From ProxyResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type