SBQueue Class

Description of queue Resource.

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

Inheritance
azure.mgmt.servicebus.v2018_01_01_preview.models._models_py3.Resource
SBQueue

Constructor

SBQueue(*, lock_duration: timedelta | None = None, max_size_in_megabytes: int | None = None, requires_duplicate_detection: bool | None = None, requires_session: bool | None = None, default_message_time_to_live: timedelta | None = None, dead_lettering_on_message_expiration: bool | None = None, duplicate_detection_history_time_window: timedelta | None = None, max_delivery_count: int | None = None, status: str | _models.EntityStatus | None = None, enable_batched_operations: bool | None = None, auto_delete_on_idle: timedelta | None = None, enable_partitioning: bool | None = None, enable_express: bool | None = None, forward_to: str | None = None, forward_dead_lettered_messages_to: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
lock_duration

ISO 8601 timespan 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.

max_size_in_megabytes
int

The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

requires_duplicate_detection

A value indicating if this queue requires duplicate detection.

requires_session

A value that indicates whether the queue supports the concept of sessions.

default_message_time_to_live

ISO 8601 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_message_expiration

A value that indicates whether this queue has dead letter support when a message expires.

duplicate_detection_history_time_window

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

max_delivery_count
int

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

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

enable_batched_operations

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

auto_delete_on_idle

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

enable_partitioning

A value that indicates whether the queue is to be partitioned across multiple message brokers.

enable_express

A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

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.

Variables

Name Description
id
str

Resource Id.

name
str

Resource name.

type
str

Resource type.

count_details

Message Count Details.

created_at

The exact time the message was created.

updated_at

The exact time the message was updated.

accessed_at

Last time a message was sent, or the last time there was a receive request to this queue.

size_in_bytes
int

The size of the queue, in bytes.

message_count
int

The number of messages in the queue.

lock_duration

ISO 8601 timespan 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.

max_size_in_megabytes
int

The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. Default is 1024.

requires_duplicate_detection

A value indicating if this queue requires duplicate detection.

requires_session

A value that indicates whether the queue supports the concept of sessions.

default_message_time_to_live

ISO 8601 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_message_expiration

A value that indicates whether this queue has dead letter support when a message expires.

duplicate_detection_history_time_window

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

max_delivery_count
int

The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.

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

enable_batched_operations

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

auto_delete_on_idle

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

enable_partitioning

A value that indicates whether the queue is to be partitioned across multiple message brokers.

enable_express

A value that indicates whether Express Entities are enabled. An express queue holds a message in memory temporarily before writing it to persistent storage.

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.