SBSubscription Class

Description of subscription resource.

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

Inheritance

azure.mgmt.servicebus.v2021_06_01_preview.models._models_py3.Resource

SBSubscription

Constructor

SBSubscription(*, lock_duration: Optional[datetime.timedelta] = None, requires_session: Optional[bool] = None, default_message_time_to_live: Optional[datetime.timedelta] = None, dead_lettering_on_filter_evaluation_exceptions: Optional[bool] = None, dead_lettering_on_message_expiration: Optional[bool] = None, duplicate_detection_history_time_window: Optional[datetime.timedelta] = None, max_delivery_count: Optional[int] = None, status: Optional[Union[str, azure.mgmt.servicebus.v2021_06_01_preview.models._service_bus_management_client_enums.EntityStatus]] = None, enable_batched_operations: Optional[bool] = None, auto_delete_on_idle: Optional[datetime.timedelta] = None, forward_to: Optional[str] = None, forward_dead_lettered_messages_to: Optional[str] = None, is_client_affine: Optional[bool] = None, client_affine_properties: Optional[azure.mgmt.servicebus.v2021_06_01_preview.models._models_py3.SBClientAffineProperties] = None, **kwargs)

Parameters

lock_duration

timedelta

Required

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

requires_session

bool

Required

Value indicating if a subscription supports the concept of sessions.

default_message_time_to_live

timedelta

Required

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

Required

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

dead_lettering_on_message_expiration

bool

Required

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

duplicate_detection_history_time_window

timedelta

Required

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

max_delivery_count

int

Required

Number of maximum deliveries.

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".

enable_batched_operations

bool

Required

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

auto_delete_on_idle

timedelta

Required

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

forward_to

str

Required

Queue/Topic name to forward the messages.

forward_dead_lettered_messages_to

str

Required

Queue/Topic name to forward the Dead Letter message.

is_client_affine

bool

Required

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

client_affine_properties

SBClientAffineProperties

Required

Properties specific to client affine subscriptions.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

system_data

SystemData

The system meta data relating to this resource.

message_count

<xref:long>

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.