QueueProperties Class

Properties of a Service Bus queue resource.

Inheritance

azure.servicebus.management._models.DictMixin

QueueProperties

Constructor

QueueProperties(name: str, **kwargs: Any)

Parameters

name

Variables

name

Name of the queue.

authorization_rules

Authorization rules for resource.

auto_delete_on_idle

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

dead_lettering_on_message_expiration

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

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.

duplicate_detection_history_time_window

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

availability_status

Availibility status of the entity. Possible values include: "Available", "Limited", "Renaming", "Restoring", "Unknown".

enable_batched_operations

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

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.

enable_partitioning

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

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_delivery_count

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

max_size_in_megabytes

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

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.

status

Status of a Service Bus resource. Possible values include: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", "Unknown".

forward_to

The name of the recipient entity to which all the messages sent to the queue are forwarded to.

user_metadata

Custom metdata that user can associate with the description. Max length is 1024 chars.

forward_dead_lettered_messages_to

The name of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.

max_message_size_in_kilobytes

The maximum size in kilobytes of message payload that can be accepted by the queue. This feature is only available when using a Premium namespace and Service Bus API version "2021-05" or higher.