SBTopicProperties Class

The Topic Properties definition.

Constructor

SBTopicProperties()

Variables

Name	Description
size_in_bytes	int Size of the topic, in bytes.
created_at	str Exact time the message was created.
updated_at	str The exact time the message was updated.
accessed_at	str Last time the message was sent, or a request was received, for this topic.
subscription_count	int Number of subscriptions.
count_details	<xref:<xref:"MessageCountDetails">> Message count details.
default_message_time_to_live	str 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.
max_size_in_megabytes	int Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.
max_message_size_in_kilobytes	int 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.
requires_duplicate_detection	bool Value indicating if this topic requires duplicate detection.
duplicate_detection_history_time_window	str ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enable_batched_operations	bool Value that indicates whether server-side batched operations are enabled.
status	Union[str, <xref:"EntityStatus">] Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown".
support_ordering	bool Value that indicates whether the topic supports ordering.
auto_delete_on_idle	str ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
enable_partitioning	bool Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
enable_express	bool Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.
user_metadata	str Gets and Sets Metadata of User.

Attributes

accessedAt

Last time the message was sent, or a request was received, for this topic.

accessedAt: str

autoDeleteOnIdle

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

autoDeleteOnIdle: str

countDetails

Message count details.

countDetails: MessageCountDetails

createdAt

Exact time the message was created.

createdAt: str

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: str

duplicateDetectionHistoryTimeWindow

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

duplicateDetectionHistoryTimeWindow: str

enableBatchedOperations

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

enableBatchedOperations: bool

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: bool

enablePartitioning

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

enablePartitioning: bool

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: int

maxSizeInMegabytes

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

maxSizeInMegabytes: int

requiresDuplicateDetection

Value indicating if this topic requires duplicate detection.

requiresDuplicateDetection: bool

sizeInBytes

Size of the topic, in bytes.

sizeInBytes: int

status

Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown".

status: str | EntityStatus

subscriptionCount

Number of subscriptions.

subscriptionCount: int

supportOrdering

Value that indicates whether the topic supports ordering.

supportOrdering: bool

updatedAt

The exact time the message was updated.

updatedAt: str

userMetadata

Gets and Sets Metadata of User.

userMetadata: str