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.v2021_11_01.models._models_py3.ProxyResource

SBTopic

Constructor

SBTopic(*, default_message_time_to_live: timedelta | None = None, max_size_in_megabytes: int | None = None, max_message_size_in_kilobytes: int | None = None, requires_duplicate_detection: bool | None = None, duplicate_detection_history_time_window: timedelta | None = None, enable_batched_operations: bool | None = None, status: str | _models.EntityStatus | None = None, support_ordering: bool | None = None, auto_delete_on_idle: timedelta | None = None, enable_partitioning: bool | None = None, enable_express: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
default_message_time_to_live	timedelta 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	timedelta 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	str or 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	timedelta 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.

Variables

Name	Description
id	str Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".
location	str The geo-location where the resource lives.
system_data	SystemData The system meta data relating to this resource.
size_in_bytes	int 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.
default_message_time_to_live	timedelta 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	timedelta 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	str or 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	timedelta 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.