SBSubscriptionProperties Class

Description of Subscription Resource.

Constructor

SBSubscriptionProperties()

Variables

Name	Description
message_count	int Number of messages.
created_at	str Exact time the message was created.
accessed_at	str Last time there was a receive request to this subscription.
updated_at	str The exact time the message was updated.
count_details	<xref:<xref:"MessageCountDetails">> Message count details.
lock_duration	str 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	str 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	str 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	Union[str, <xref:"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	str 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	<xref:<xref:"SBClientAffineProperties">> Properties specific to client affine subscriptions.

Attributes

accessedAt

Last time there was a receive request to this subscription.

accessedAt: str

autoDeleteOnIdle

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

autoDeleteOnIdle: str

clientAffineProperties

Properties specific to client affine subscriptions.

clientAffineProperties: SBClientAffineProperties

countDetails

Message count details.

countDetails: MessageCountDetails

createdAt

Exact time the message was created.

createdAt: str

deadLetteringOnFilterEvaluationExceptions

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

deadLetteringOnFilterEvaluationExceptions: bool

deadLetteringOnMessageExpiration

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

deadLetteringOnMessageExpiration: bool

defaultMessageTimeToLive

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.

defaultMessageTimeToLive: str

duplicateDetectionHistoryTimeWindow

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

duplicateDetectionHistoryTimeWindow: str

enableBatchedOperations

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

enableBatchedOperations: bool

forwardDeadLetteredMessagesTo

Queue/Topic name to forward the Dead Letter message.

forwardDeadLetteredMessagesTo: str

forwardTo

Queue/Topic name to forward the messages.

forwardTo: str

isClientAffine

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

isClientAffine: bool

lockDuration

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

lockDuration: str

maxDeliveryCount

Number of maximum deliveries.

maxDeliveryCount: int

messageCount

Number of messages.

messageCount: int

requiresSession

Value indicating if a subscription supports the concept of sessions.

requiresSession: bool

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 | EntityStatus

updatedAt

The exact time the message was updated.

updatedAt: str

userMetadata

Gets and Sets Metadata of User.

userMetadata: str