Share via

SubscriptionResource 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.v2015_08_01.models._models_py3.Resource
SubscriptionResource

Constructor

SubscriptionResource(*, location: str | None = None, auto_delete_on_idle: str | None = None, default_message_time_to_live: str | None = None, dead_lettering_on_filter_evaluation_exceptions: bool | None = None, dead_lettering_on_message_expiration: bool | None = None, enable_batched_operations: bool | None = None, entity_availability_status: str | _models.EntityAvailabilityStatus | None = None, is_read_only: bool | None = None, lock_duration: str | None = None, max_delivery_count: int | None = None, requires_session: bool | None = None, status: str | _models.EntityStatus | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
location
str

Resource location.
auto_delete_on_idle
str

TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
default_message_time_to_live
str

Default message time 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.
enable_batched_operations
bool

Value that indicates whether server-side batched operations are enabled.
entity_availability_status
str or EntityAvailabilityStatus

Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".
is_read_only
bool

Value that indicates whether the entity description is read-only.
lock_duration
str

The lock duration time span for the subscription.
max_delivery_count
int

Number of maximum deliveries.
requires_session
bool

Value indicating if a subscription supports the concept of sessions.
status
str or EntityStatus

Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", and "Unknown".

Variables

Name Description
id
str

Resource Id.
name
str

Resource name.
location
str

Resource location.
type
str

Resource type.
accessed_at
datetime

Last time there was a receive request to this subscription.
auto_delete_on_idle
str

TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.
count_details
MessageCountDetails

Message Count Details.
created_at
datetime

Exact time the message was created.
default_message_time_to_live
str

Default message time 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.
enable_batched_operations
bool

Value that indicates whether server-side batched operations are enabled.
entity_availability_status
str or EntityAvailabilityStatus

Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".
is_read_only
bool

Value that indicates whether the entity description is read-only.
lock_duration
str

The lock duration time span for the subscription.
max_delivery_count
int

Number of maximum deliveries.
message_count
int

Number of messages.
requires_session
bool

Value indicating if a subscription supports the concept of sessions.
status
str or EntityStatus

Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", and "Unknown".
updated_at
datetime

The exact time the message was updated.