SBTopic Class

Description of topic resource.

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

Inheritance
azure.mgmt.servicebus.models._models_py3.Resource
SBTopic

Constructor

SBTopic(*, default_message_time_to_live: typing.Union[datetime.timedelta, NoneType] = None, max_size_in_megabytes: typing.Union[int, NoneType] = None, requires_duplicate_detection: typing.Union[bool, NoneType] = None, duplicate_detection_history_time_window: typing.Union[datetime.timedelta, NoneType] = None, enable_batched_operations: typing.Union[bool, NoneType] = None, status: typing.Union[str, _ForwardRef('EntityStatus'), NoneType] = None, support_ordering: typing.Union[bool, NoneType] = None, auto_delete_on_idle: typing.Union[datetime.timedelta, NoneType] = None, enable_partitioning: typing.Union[bool, NoneType] = None, enable_express: typing.Union[bool, NoneType] = None, **kwargs)

Parameters

default_message_time_to_live
timedelta
Required

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
Required

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

requires_duplicate_detection
bool
Required

Value indicating if this topic requires duplicate detection.

duplicate_detection_history_time_window
timedelta
Required

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

enable_batched_operations
bool
Required

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

status
str or EntityStatus
Required

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

support_ordering
bool
Required

Value that indicates whether the topic supports ordering.

auto_delete_on_idle
timedelta
Required

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

enable_partitioning
bool
Required

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

enable_express
bool
Required

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

Variables

id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

size_in_bytes
<xref:long>

Size of the topic, in bytes.

created_at
datetime

Exact time the message was created.

updated_at
datetime

The exact time the message was updated.

accessed_at
datetime

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

subscription_count
int

Number of subscriptions.

count_details
MessageCountDetails

Message count details.