AzurequeuesClient

Attributes

QueueArray module-attribute

QueueArray = List['QueueInfo']

PutMessageInput module-attribute

PutMessageInput = str

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnMessages_V2': {'operation_id': 'OnMessages_V2', 'path': '/{connectionId}/v2/storageAccounts/{storageAccountName}/queues/{queueName}/message_trigger', 'method': 'get', 'required_parameters': ['storageAccountName', 'queueName'], 'callback_payload_type': 'Messages'}, 'OnMessageThresholdReached_V2': {'operation_id': 'OnMessageThresholdReached_V2', 'path': '/{connectionId}/v2/storageAccounts/{storageAccountName}/queues/{queueName}/count_trigger', 'method': 'get', 'required_parameters': ['storageAccountName', 'queueName', 'threshold'], 'callback_payload_type': None}}

Classes

Messages dataclass

Messages(queue_messages_list: Optional[QueueMessagesList] = None)

Response for Get messages

StorageAccountList dataclass

StorageAccountList(value: Optional[List[StorageAccount]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute

value: Optional[List[StorageAccount]] = None

List of storage account names

StorageAccount dataclass

StorageAccount(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: StorageAccount

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name or queue endpoint of the storage account.

display_name class-attribute instance-attribute

display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the storage account.

QueueInfo dataclass

QueueInfo(name: Optional[str] = None)

Definition: Queue

Attributes

name class-attribute instance-attribute

name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the queue.

MessagePost dataclass

MessagePost(message: Optional[str] = None)

Definition: MessagePost

Attributes

message class-attribute instance-attribute

message: Optional[str] = field(default=None, metadata={'wire_name': 'Message'})

The message to put in the queue.

QueueMessage dataclass

QueueMessage(message_id: Optional[str] = None, insertion_time: Optional[str] = None, expiration_time: Optional[str] = None, pop_receipt: Optional[str] = None, next_visible_time: Optional[str] = None, message_text: Optional[str] = None, dequeue_count: Optional[str] = None)

Definition: QueueMessage

Attributes

message_id class-attribute instance-attribute

message_id: Optional[str] = field(default=None, metadata={'wire_name': 'MessageId'})

The unique identifier of the message.

insertion_time class-attribute instance-attribute

insertion_time: Optional[str] = field(default=None, metadata={'wire_name': 'InsertionTime'})

The time the message was inserted into the queue.

expiration_time class-attribute instance-attribute

expiration_time: Optional[str] = field(default=None, metadata={'wire_name': 'ExpirationTime'})

The time the message will expire from the queue.

pop_receipt class-attribute instance-attribute

pop_receipt: Optional[str] = field(default=None, metadata={'wire_name': 'PopReceipt'})

Used to delete the message after popping it off the queue.

next_visible_time class-attribute instance-attribute

next_visible_time: Optional[str] = field(default=None, metadata={'wire_name': 'TimeNextVisible'})

The time the message will be visible to other consumers.

message_text class-attribute instance-attribute

message_text: Optional[str] = field(default=None, metadata={'wire_name': 'MessageText'})

The text of the message.

dequeue_count class-attribute instance-attribute

dequeue_count: Optional[str] = field(default=None, metadata={'wire_name': 'DequeueCount'})

The number of times the message has been dequeued.

QueueMessagesList dataclass

QueueMessagesList(queue_message: Optional[List[QueueMessage]] = None)

Definition: QueueMessagesList

AzurequeuesClient

AzurequeuesClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for azurequeues connector.

Initialize a AzurequeuesClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

delete_message_async async

delete_message_async(storage_account_name: str, queue_name: str, message_id: str, popreceipt: str) -> None

Delete message

Delete a specific message from the queue.

get_messages_async async

get_messages_async(storage_account_name: str, queue_name: str, numofmessages: Optional[str] = None, visibilitytimeout: Optional[str] = None) -> dict[str, Any] | None

Get messages

Get a specific set of messages from the queue. The messages will be hidden but remain on the queue until the delete action is used.

list_queues_async async

list_queues_async(storage_account_name: str) -> dict[str, Any] | None

List queues

List all the queues for your storage account.

put_message_async async

put_message_async(input: PutMessageInput, storage_account_name: str, queue_name: str) -> None

Put a message on a queue

Adds a message to the given queue.

put_queue_async async

put_queue_async(storage_account_name: str, queue_name: str) -> dict[str, Any] | None

Create a new queue

Adds a queue to your account.

get_storage_accounts_async async

get_storage_accounts_async() -> dict[str, Any] | None

Get storage accounts

This operation list the user's Azure Storage Account.