QueueResource Class

Reference

Description of queue 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

QueueResource

Constructor

QueueResource(*, location: str | None = None, lock_duration: str | None = None, auto_delete_on_idle: str | None = None, entity_availability_status: str | _models.EntityAvailabilityStatus | None = None, default_message_time_to_live: str | None = None, duplicate_detection_history_time_window: str | None = None, enable_batched_operations: bool | None = None, dead_lettering_on_message_expiration: bool | None = None, enable_express: bool | None = None, enable_partitioning: bool | None = None, is_anonymous_accessible: bool | None = None, max_delivery_count: int | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, requires_session: bool | None = None, status: str | _models.EntityStatus | None = None, support_ordering: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
location	str Resource location.
lock_duration	str The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
auto_delete_on_idle	str the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
entity_availability_status	str or EntityAvailabilityStatus Entity availability status for the queue. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".
default_message_time_to_live	str The 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.
duplicate_detection_history_time_window	str TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enable_batched_operations	bool A value that indicates whether server-side batched operations are enabled.
dead_lettering_on_message_expiration	bool A value that indicates whether this queue has dead letter support when a message expires.
enable_express	bool A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enable_partitioning	bool A value that indicates whether the queue is to be partitioned across multiple message brokers.
is_anonymous_accessible	bool A value that indicates whether the message is accessible anonymously.
max_delivery_count	int The maximum delivery count. A message is automatically deadlettered after this number of deliveries.
max_size_in_megabytes	int The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
requires_duplicate_detection	bool A value indicating if this queue requires duplicate detection.
requires_session	bool A value that indicates whether the queue 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".
support_ordering	bool A value that indicates whether the queue supports ordering.

Variables

Name	Description
id	str Resource Id.
name	str Resource name.
location	str Resource location.
type	str Resource type.
lock_duration	str The duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.
accessed_at	datetime Last time a message was sent, or the last time there was a receive request to this queue.
auto_delete_on_idle	str the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
entity_availability_status	str or EntityAvailabilityStatus Entity availability status for the queue. Known values are: "Available", "Limited", "Renaming", "Restoring", and "Unknown".
created_at	datetime The exact time the message was created.
default_message_time_to_live	str The 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.
duplicate_detection_history_time_window	str TimeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
enable_batched_operations	bool A value that indicates whether server-side batched operations are enabled.
dead_lettering_on_message_expiration	bool A value that indicates whether this queue has dead letter support when a message expires.
enable_express	bool A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.
enable_partitioning	bool A value that indicates whether the queue is to be partitioned across multiple message brokers.
is_anonymous_accessible	bool A value that indicates whether the message is accessible anonymously.
max_delivery_count	int The maximum delivery count. A message is automatically deadlettered after this number of deliveries.
max_size_in_megabytes	int The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
message_count	int The number of messages in the queue.
count_details	MessageCountDetails Message Count Details.
requires_duplicate_detection	bool A value indicating if this queue requires duplicate detection.
requires_session	bool A value that indicates whether the queue supports the concept of sessions.
size_in_bytes	int The size of the queue, in bytes.
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".
support_ordering	bool A value that indicates whether the queue supports ordering.
updated_at	datetime The exact time the message was updated.

Share via

QueueResource Class

Constructor

Keyword-Only Parameters

Variables

Additional resources