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

SBQueue

Constructor

SBQueue(*, lock_duration: Optional[datetime.timedelta] = None, max_size_in_megabytes: Optional[int] = None, max_message_size_in_kilobytes: Optional[int] = None, requires_duplicate_detection: Optional[bool] = None, requires_session: Optional[bool] = None, default_message_time_to_live: Optional[datetime.timedelta] = None, dead_lettering_on_message_expiration: Optional[bool] = None, duplicate_detection_history_time_window: Optional[datetime.timedelta] = None, max_delivery_count: Optional[int] = None, status: Optional[Union[str, azure.mgmt.servicebus.v2021_06_01_preview.models._service_bus_management_client_enums.EntityStatus]] = None, enable_batched_operations: Optional[bool] = None, auto_delete_on_idle: Optional[datetime.timedelta] = None, enable_partitioning: Optional[bool] = None, enable_express: Optional[bool] = None, forward_to: Optional[str] = None, forward_dead_lettered_messages_to: Optional[str] = None, **kwargs)

Parameters

lock_duration

timedelta

Required

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

Required

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

max_message_size_in_kilobytes

<xref:long>

Required

Maximum size (in KB) of the message payload that can be accepted by the queue. This property is only used in Premium today and default is 1024.

requires_duplicate_detection

bool

Required

A value indicating if this queue requires duplicate detection.

requires_session

bool

Required

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

default_message_time_to_live

timedelta

Required

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

bool

Required

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

duplicate_detection_history_time_window

timedelta

Required

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

max_delivery_count

int

Required

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

status

str or EntityStatus

Required

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

enable_batched_operations

bool

Required

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

auto_delete_on_idle

timedelta

Required

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

enable_partitioning

bool

Required

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

enable_express

bool

Required

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

Required

Queue/Topic name to forward the messages.

forward_dead_lettered_messages_to

str

Required

Queue/Topic name to forward the Dead Letter message.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

system_data

SystemData

The system meta data relating to this resource.

count_details

MessageCountDetails

Message Count Details.

created_at

datetime

The exact time the message was created.

updated_at

datetime

The exact time the message was updated.

accessed_at

datetime

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

size_in_bytes

<xref:long>

The size of the queue, in bytes.

message_count

<xref:long>

The number of messages in the queue.