QueueProperties Class

Properties of a Service Bus queue resource.

Please use get_queue, create_queue, or list_queues on the ServiceBusAdministrationClient to get a QueueProperties instance instead of instantiating a QueueProperties object directly.

Inheritance

azure.servicebus.management._models.DictMixin

QueueProperties

Constructor

QueueProperties(name: str, *, authorization_rules: List[AuthorizationRule] | None, auto_delete_on_idle: timedelta | str | None, dead_lettering_on_message_expiration: bool | None, default_message_time_to_live: timedelta | str | None, duplicate_detection_history_time_window: timedelta | str | None, availability_status: str | EntityAvailabilityStatus | None, enable_batched_operations: bool | None, enable_express: bool | None, enable_partitioning: bool | None, lock_duration: timedelta | str | None, max_delivery_count: int | None, max_size_in_megabytes: int | None, requires_duplicate_detection: bool | None, requires_session: bool | None, status: str | EntityStatus | None, forward_to: str | None, user_metadata: str | None, forward_dead_lettered_messages_to: str | None, max_message_size_in_kilobytes: int | None)

Parameters

Name	Description
name Required	str Name of the queue.

Keyword-Only Parameters

Name	Description
authorization_rules	list[AuthorizationRule] or None Authorization rules for resource.
auto_delete_on_idle	timedelta or str or None ISO 8601 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
dead_lettering_on_message_expiration	bool or None A value that indicates whether this queue has dead letter support when a message expires.
default_message_time_to_live	timedelta or str or None 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	timedelta or str or None ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
availability_status	str or None or EntityAvailabilityStatus Availibility status of the entity. Possible values include: "Available", "Limited", "Renaming", "Restoring", "Unknown".
enable_batched_operations	bool or None Value that indicates whether server-side batched operations are enabled.
enable_express	bool or None 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 or None A value that indicates whether the queue is to be partitioned across multiple message brokers.
lock_duration	<xref:datetime.timedelt> or <xref:Nonea> 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	int or None The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10.
max_size_in_megabytes	int or None The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
requires_duplicate_detection	bool or None A value indicating if this queue requires duplicate detection.
requires_session	bool or None A value that indicates whether the queue supports the concept of sessions.
status	str or EntityStatus Status of a Service Bus resource. Possible values include: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", "Unknown".
forward_to	str or None The name of the recipient entity to which all the messages sent to the queue are forwarded to.
user_metadata	str or None Custom metdata that user can associate with the description. Max length is 1024 chars.
forward_dead_lettered_messages_to	str or None The name of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.
max_message_size_in_kilobytes	int or None 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.

Variables

Name	Description
name	str or None Name of the queue.
authorization_rules	list[AuthorizationRule] Authorization rules for resource.
auto_delete_on_idle	timedelta or str or None ISO 8601 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
dead_lettering_on_message_expiration	bool or None A value that indicates whether this queue has dead letter support when a message expires.
default_message_time_to_live	timedelta or str or None 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	timedelta or str or None ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.
availability_status	str or None or EntityAvailabilityStatus Availibility status of the entity. Possible values include: "Available", "Limited", "Renaming", "Restoring", "Unknown".
enable_batched_operations	bool or None Value that indicates whether server-side batched operations are enabled.
enable_express	bool or None 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 or None A value that indicates whether the queue is to be partitioned across multiple message brokers.
lock_duration	timedelta or str or None 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	int or None The maximum delivery count. A message is automatically deadlettered after this number of deliveries. Default value is 10.
max_size_in_megabytes	int or None The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
requires_duplicate_detection	bool or None A value indicating if this queue requires duplicate detection.
requires_session	bool or None A value that indicates whether the queue supports the concept of sessions.
status	str or EntityStatus or None Status of a Service Bus resource. Possible values include: "Active", "Creating", "Deleting", "Disabled", "ReceiveDisabled", "Renaming", "Restoring", "SendDisabled", "Unknown".
forward_to	str or None The name of the recipient entity to which all the messages sent to the queue are forwarded to.
user_metadata	str or None Custom metdata that user can associate with the description. Max length is 1024 chars.
forward_dead_lettered_messages_to	str or None The name of the recipient entity to which all the dead-lettered messages of this subscription are forwarded to.
max_message_size_in_kilobytes	int or None 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.

Methods

get
has_key
items
keys
update
values

get

get(key: str, default: Any | None = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

has_key

has_key(k: str) -> bool

Parameters

Name	Description
k Required

items

items() -> List[Tuple[str, Any]]

keys

keys() -> List[str]

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> List[Any]