QueueResource Class

Description of queue Resource.

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

Inheritance

azure.mgmt.servicebus.v2015_08_01.models._models_py3.Resource

QueueResource

Constructor

QueueResource(*, location: Optional[str] = None, lock_duration: Optional[str] = None, auto_delete_on_idle: Optional[str] = None, entity_availability_status: Optional[Union[str, azure.mgmt.servicebus.v2015_08_01.models._service_bus_management_client_enums.EntityAvailabilityStatus]] = None, default_message_time_to_live: Optional[str] = None, duplicate_detection_history_time_window: Optional[str] = None, enable_batched_operations: Optional[bool] = None, dead_lettering_on_message_expiration: Optional[bool] = None, enable_express: Optional[bool] = None, enable_partitioning: Optional[bool] = None, is_anonymous_accessible: Optional[bool] = None, max_delivery_count: Optional[int] = None, max_size_in_megabytes: Optional[int] = None, requires_duplicate_detection: Optional[bool] = None, requires_session: Optional[bool] = None, status: Optional[Union[str, azure.mgmt.servicebus.v2015_08_01.models._service_bus_management_client_enums.EntityStatus]] = None, support_ordering: Optional[bool] = None, **kwargs)

Parameters

location

str

Required

Resource location.

lock_duration

str

Required

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

auto_delete_on_idle

str

Required

the TimeSpan idle interval after which the queue is automatically deleted. The minimum duration is 5 minutes.

entity_availability_status

str or EntityAvailabilityStatus

Required

Entity availability status for the queue. Possible values include: "Available", "Limited", "Renaming", "Restoring", "Unknown".

default_message_time_to_live

str

Required

The default message time 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

str

Required

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

enable_batched_operations

bool

Required

A value that indicates whether server-side batched operations are enabled.

dead_lettering_on_message_expiration

bool

Required

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

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.

enable_partitioning

bool

Required

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

is_anonymous_accessible

bool

Required

A value that indicates whether the message is accessible anonymously.

max_delivery_count

int

Required

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

max_size_in_megabytes

<xref:long>

Required

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

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.

status

str or EntityStatus

Required

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

support_ordering

bool

Required

A value that indicates whether the queue supports ordering.

Variables

id

str

Resource Id.

name

str

Resource name.

type

str

Resource type.

accessed_at

datetime

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

created_at

datetime

The exact time the message was created.

message_count

<xref:long>

The number of messages in the queue.

count_details

MessageCountDetails

Message Count Details.

size_in_bytes

<xref:long>

The size of the queue, in bytes.

updated_at

datetime

The exact time the message was updated.