TopicProperties Class

Properties of a Service Bus topic resource.

Inheritance
azure.servicebus.management._models.DictMixin
TopicProperties

Constructor

TopicProperties(name: str, **kwargs: Any)

Parameters

name

Variables

name

Name of the topic.

default_message_time_to_live

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

The maximum size of the topic in megabytes, which is the size of memory allocated for the topic.

requires_duplicate_detection

A value indicating if this topic requires duplicate detection.

duplicate_detection_history_time_window

ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

enable_batched_operations

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

size_in_bytes

The size of the topic, in bytes.

filtering_messages_before_publishing

Filter messages before publishing.

authorization_rules

Authorization rules for resource.

status

Status of a Service Bus resource. Possible values include: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", "Unknown".

support_ordering

A value that indicates whether the topic supports ordering.

auto_delete_on_idle

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

enable_partitioning

A value that indicates whether the topic is to be partitioned across multiple message brokers.

availability_status

Availability status of the entity. Possible values include: "Available", "Limited", "Renaming", "Restoring", "Unknown".

enable_express

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

user_metadata

Metadata associated with the topic.

max_message_size_in_kilobytes

The maximum size in kilobytes of message payload that can be accepted by the topic. This feature is only available when using a Premium namespace and Service Bus API version "2021-05" or higher.