azure.mgmt.servicebus.models.SBSubscriptionProperties class

Constructor

SBSubscriptionProperties(*args: Any, **kwargs: Any)

Variables

Name	Description
message_count	int Number of messages.
created_at	datetime Exact time the message was created.
accessed_at	datetime Last time there was a receive request to this subscription.
updated_at	datetime The exact time the message was updated.
count_details	MessageCountDetails Message count details.
lock_duration	timedelta ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.
requires_session	bool Value indicating if a subscription supports the concept of sessions.
default_message_time_to_live	timedelta ISO 8061 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.
dead_lettering_on_filter_evaluation_exceptions	bool Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
dead_lettering_on_message_expiration	bool Value that indicates whether a subscription has dead letter support when a message expires.
duplicate_detection_history_time_window	timedelta ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
max_delivery_count	int Number of maximum deliveries.
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".
enable_batched_operations	bool Value that indicates whether server-side batched operations are enabled.
auto_delete_on_idle	timedelta ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
forward_to	str Queue/Topic name to forward the messages.
forward_dead_lettered_messages_to	str Queue/Topic name to forward the Dead Letter message.
is_client_affine	bool Value that indicates whether the subscription has an affinity to the client id.
user_metadata	str Gets and Sets Metadata of User.
client_affine_properties	SBClientAffineProperties Properties specific to client affine subscriptions.

accessed_at

Last time there was a receive request to this subscription.

accessed_at: datetime | None

auto_delete_on_idle

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

auto_delete_on_idle: timedelta | None

client_affine_properties

Properties specific to client affine subscriptions.

client_affine_properties: _models.SBClientAffineProperties | None

count_details

Message count details.

count_details: _models.MessageCountDetails | None

created_at

Exact time the message was created.

created_at: datetime | None

dead_lettering_on_filter_evaluation_exceptions

Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.

dead_lettering_on_filter_evaluation_exceptions: bool | None

dead_lettering_on_message_expiration

Value that indicates whether a subscription has dead letter support when a message expires.

dead_lettering_on_message_expiration: bool | None

default_message_time_to_live

ISO 8061 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.

default_message_time_to_live: timedelta | None

duplicate_detection_history_time_window

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

duplicate_detection_history_time_window: timedelta | None

enable_batched_operations

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

enable_batched_operations: bool | None

forward_dead_lettered_messages_to

Queue/Topic name to forward the Dead Letter message.

forward_dead_lettered_messages_to: str | None

forward_to

Queue/Topic name to forward the messages.

forward_to: str | None

is_client_affine

Value that indicates whether the subscription has an affinity to the client id.

is_client_affine: bool | None

lock_duration

ISO 8061 lock duration timespan for the subscription. The default value is 1 minute.

lock_duration: timedelta | None

max_delivery_count

Number of maximum deliveries.

max_delivery_count: int | None

message_count

Number of messages.

message_count: int | None

requires_session

Value indicating if a subscription supports the concept of sessions.

requires_session: bool | None

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 | _models.EntityStatus | None

updated_at

The exact time the message was updated.

updated_at: datetime | None

user_metadata

Gets and Sets Metadata of User.

user_metadata: str | None