SBQueue Class

Description of queue Resource.

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

Constructor

SBQueue(*, lock_duration: timedelta | None = None, max_size_in_megabytes: int | None = None, max_message_size_in_kilobytes: 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	timedelta 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. Default value: None
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. Default value: None
max_message_size_in_kilobytes	int 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. Default value: None
requires_duplicate_detection	bool A value indicating if this queue requires duplicate detection. Default value: None
requires_session	bool A value that indicates whether the queue supports the concept of sessions. Default value: None
default_message_time_to_live	timedelta 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. Default value: None
dead_lettering_on_message_expiration	bool A value that indicates whether this queue has dead letter support when a message expires. Default value: None
duplicate_detection_history_time_window	timedelta ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes. Default value: None
max_delivery_count	int The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10. Default value: None
status	str or EntityStatus Enumerates the possible values for the status of a messaging entity. Known values are: "Active", "Disabled", "Restoring", "SendDisabled", "ReceiveDisabled", "Creating", "Deleting", "Renaming", and "Unknown". Default value: None
enable_batched_operations	bool Value that indicates whether server-side batched operations are enabled. Default value: None
auto_delete_on_idle	timedelta ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes. Default value: None
enable_partitioning	bool A value that indicates whether the queue is to be partitioned across multiple message brokers. Default value: None
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. Default value: None
forward_to	str Queue/Topic name to forward the messages. Default value: None
forward_dead_lettered_messages_to	str Queue/Topic name to forward the Dead Letter message. Default value: None

Variables

Name	Description
id	str Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	str The name of the resource.
type	str The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".
location	str The geo-location where the resource lives.
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	int The size of the queue, in bytes.
message_count	int The number of messages in the queue.
lock_duration	timedelta 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.
max_message_size_in_kilobytes	int 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 A value indicating if this queue requires duplicate detection.
requires_session	bool A value that indicates whether the queue supports the concept of sessions.
default_message_time_to_live	timedelta 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 A value that indicates whether this queue has dead letter support when a message expires.
duplicate_detection_history_time_window	timedelta 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	str or EntityStatus 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	bool Value that indicates whether server-side batched operations are enabled.
auto_delete_on_idle	timedelta ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.
enable_partitioning	bool A value that indicates whether the queue is to be partitioned across multiple message brokers.
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.
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.