TopicResource Class

Description of topic resource.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.servicebus.v2015_08_01.models._models_py3.Resource
TopicResource

Constructor

TopicResource(*, location: str | None = None, auto_delete_on_idle: str | None = None, entity_availability_status: str | _models.EntityAvailabilityStatus | None = None, default_message_time_to_live: str | None = None, duplicate_detection_history_time_window: str | None = None, enable_batched_operations: bool | None = None, enable_express: bool | None = None, enable_partitioning: bool | None = None, filtering_messages_before_publishing: bool | None = None, is_anonymous_accessible: bool | None = None, is_express: bool | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, status: str | _models.EntityStatus | None = None, support_ordering: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location.

auto_delete_on_idle
str

TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

entity_availability_status

Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".

default_message_time_to_live
str

Default message time 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.

duplicate_detection_history_time_window
str

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.

enable_express

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

enable_partitioning

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

filtering_messages_before_publishing

Whether messages should be filtered before publishing.

is_anonymous_accessible

Value that indicates whether the message is accessible anonymously.

is_express
max_size_in_megabytes
int

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

requires_duplicate_detection

Value indicating if this topic requires duplicate detection.

status

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

support_ordering

Value that indicates whether the topic supports ordering.

Variables

Name Description
id
str

Resource Id.

name
str

Resource name.

location
str

Resource location.

type
str

Resource type.

accessed_at

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

auto_delete_on_idle
str

TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

entity_availability_status

Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".

created_at

Exact time the message was created.

count_details

Message Count Details.

default_message_time_to_live
str

Default message time 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.

duplicate_detection_history_time_window
str

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.

enable_express

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

enable_partitioning

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

filtering_messages_before_publishing

Whether messages should be filtered before publishing.

is_anonymous_accessible

Value that indicates whether the message is accessible anonymously.

is_express
max_size_in_megabytes
int

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

requires_duplicate_detection

Value indicating if this topic requires duplicate detection.

size_in_bytes
int

Size of the topic, in bytes.

status

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

subscription_count
int

Number of subscriptions.

support_ordering

Value that indicates whether the topic supports ordering.

updated_at

The exact time the message was updated.