Skip to content

AzurequeuesClient

Attributes

QueueArray module-attribute 

QueueArray = List['QueueInfo | Mapping[str, Any]']

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 | Mapping[str, Any]] = None)

Response for Get messages

StorageAccountList dataclass 

StorageAccountList(*, value: Optional[List[StorageAccount | Mapping[str, Any]]] = None)

Response for Get storage accounts

Attributes

value class-attribute instance-attribute 
value: Optional[List[StorageAccount | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name or queue endpoint of the storage account.

display_name class-attribute instance-attribute 
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Name'})

The name of the queue.

MessagePost dataclass 

MessagePost(message: str)

Definition: MessagePost

Attributes

message class-attribute instance-attribute 
message: str = dataclass_field(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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MessageId'})

The unique identifier of the message.

insertion_time class-attribute instance-attribute 
insertion_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InsertionTime'})

The time the message was inserted into the queue.

expiration_time class-attribute instance-attribute 
expiration_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ExpirationTime'})

The time the message will expire from the queue.

pop_receipt class-attribute instance-attribute 
pop_receipt: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeNextVisible'})

The time the message will be visible to other consumers.

message_text class-attribute instance-attribute 
message_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MessageText'})

The text of the message.

dequeue_count class-attribute instance-attribute 
dequeue_count: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DequeueCount'})

The number of times the message has been dequeued.

QueueMessagesList dataclass 

QueueMessagesList(*, queue_message: Optional[List[QueueMessage | Mapping[str, Any]]] = None)

Definition: QueueMessagesList

AzurequeuesClient 

AzurequeuesClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

 required
max_retry_attempts int

The maximum number of request attempts.

 3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

 30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

 True
initial_retry_delay_seconds float

The initial retry delay in seconds.

 0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

 120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

 0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

 False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

 None
**kwargs Any

Optional Azure Core pipeline policy settings.

 {}

Methods:

delete_message async 
delete_message(storage_account_name: str, queue_name: str, message_id: str, popreceipt: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Delete message

Delete a specific message from the queue.

Swagger operation ID: DeleteMessage_V2.

Parameters:

Name Type Description Default
storage_account_name str

Azure Storage account name or queue endpoint.

 required
queue_name str

The queue to delete a message from.

 required
message_id str

The ID of the message to delete.

 required
popreceipt str

A valid pop receipt value returned from an earlier call to the Get Messages.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
get_messages async 
get_messages(storage_account_name: str, queue_name: str, *, numofmessages: Optional[str] = None, visibilitytimeout: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = 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.

Swagger operation ID: GetMessages_V2.

Parameters:

Name Type Description Default
storage_account_name str

Azure Storage account name or queue endpoint.

 required
queue_name str

The queue to get Messages from.

 required
numofmessages Optional[str]

The number of messages to grab from the queue (default 1).

 None
visibilitytimeout Optional[str]

The time in seconds that messages will be invisible to other consumers (default 30).

 None
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_queues 
list_queues(storage_account_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

List queues

List all the queues for your storage account.

Returns a single-page Azure Core async collection.

Swagger operation ID: ListQueues_V2.

Parameters:

Name Type Description Default
storage_account_name str

Azure Storage account name or queue endpoint.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.
put_message async 
put_message(input: PutMessageInput, storage_account_name: str, queue_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Put a message on a queue

Adds a message to the given queue.

Swagger operation ID: PutMessage_V2.

Parameters:

Name Type Description Default
input PutMessageInput

The request body.

 required
storage_account_name str

Azure Storage account name or queue endpoint.

 required
queue_name str

The queue to put a message to.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Name Type Description
None None

The operation completes without a response body.

Raises:

Type Description
ConnectorException

If the connector request fails.
put_queue async 
put_queue(storage_account_name: str, queue_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Create a new queue

Adds a queue to your account.

Swagger operation ID: PutQueue_V2.

Parameters:

Name Type Description Default
storage_account_name str

Azure Storage account name or queue endpoint.

 required
queue_name str

The name of the queue to create.

 required
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.
list_storage_accounts 
list_storage_accounts(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get storage accounts

This operation list the user's Azure Storage Account.

Returns a single-page Azure Core async collection.

Swagger operation ID: GetStorageAccounts.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

 None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

 None
client_request_id Optional[str]

A caller-provided request identifier.

 None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

 None

Returns:

Type Description
AsyncItemPaged[dict[str, Any]]

AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type Description
ConnectorException

If the connector request fails.