SBSubscription Class

Reference

Description of subscription resource.

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

Inheritance: azure.mgmt.servicebus.v2022_01_01_preview.models._models_py3.ProxyResource

SBSubscription

Constructor

SBSubscription(*, lock_duration: timedelta | None = None, requires_session: bool | None = None, default_message_time_to_live: timedelta | None = None, dead_lettering_on_filter_evaluation_exceptions: bool | None = None, dead_lettering_on_message_expiration: bool | None = None, duplicate_detection_history_time_window: timedelta | None = None, max_delivery_count: int | None = None, status: str | _models.EntityStatus | None = None, enable_batched_operations: bool | None = None, auto_delete_on_idle: timedelta | None = None, forward_to: str | None = None, forward_dead_lettered_messages_to: str | None = None, is_client_affine: bool | None = None, client_affine_properties: _models.SBClientAffineProperties | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
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.
client_affine_properties	SBClientAffineProperties Properties specific to client affine subscriptions.

Variables

Name	Description
id	str Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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.
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.
client_affine_properties	SBClientAffineProperties Properties specific to client affine subscriptions.

Share via

SBSubscription Class

Constructor

Keyword-Only Parameters

Variables

Additional resources