你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SubscriptionResource Class
Description of subscription resource.
Variables are only populated by the server, and will be ignored when sending a request.
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
|
Resource location. Default value: None
|
auto_delete_on_idle
|
TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. Default value: None
|
default_message_time_to_live
|
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. Default value: None
|
dead_lettering_on_filter_evaluation_exceptions
|
Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. Default value: None
|
dead_lettering_on_message_expiration
|
Value that indicates whether a subscription has dead letter support when a message expires. Default value: None
|
enable_batched_operations
|
Value that indicates whether server-side batched operations are enabled. Default value: None
|
entity_availability_status
|
Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown". Default value: None
|
is_read_only
|
Value that indicates whether the entity description is read-only. Default value: None
|
lock_duration
|
The lock duration time span for the subscription. Default value: None
|
max_delivery_count
|
Number of maximum deliveries. Default value: None
|
requires_session
|
Value indicating if a subscription supports the concept of sessions. Default value: None
|
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". Default value: None
|
Variables
Name | Description |
---|---|
id
|
Resource Id. |
name
|
Resource name. |
location
|
Resource location. |
type
|
Resource type. |
accessed_at
|
Last time there was a receive request to this subscription. |
auto_delete_on_idle
|
TimeSpan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes. |
count_details
|
Message Count Details. |
created_at
|
Exact time the message was created. |
default_message_time_to_live
|
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
|
Value that indicates whether a subscription has dead letter support on filter evaluation exceptions. |
dead_lettering_on_message_expiration
|
Value that indicates whether a subscription has dead letter support when a message expires. |
enable_batched_operations
|
Value that indicates whether server-side batched operations are enabled. |
entity_availability_status
|
Entity availability status for the topic. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown". |
is_read_only
|
Value that indicates whether the entity description is read-only. |
lock_duration
|
The lock duration time span for the subscription. |
max_delivery_count
|
Number of maximum deliveries. |
message_count
|
Number of messages. |
requires_session
|
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
|
The exact time the message was updated. |