Azure Queue Storage v2

Azure Queue Storage is a messaging service for storing and retrieving large numbers of messages through Azure Storage queues.

The Flowgear Azure Queue Storage Node lets a Workflow manage queues and message lifecycles by using an account key, a SAS token, or delegated Microsoft Entra OAuth 2.0.

Revision History

0.0.0.4 - Removed list paging controls from templates and kept marker continuation inside the Node.
0.0.0.3 - Initial release.
0.0.0.6 - Renames Node inputs to PascalCase while preserving Connection property names.

Connection

Create an Azure Queue Storage Connection so the Node can authenticate with Azure Storage and optionally supply a default queue for queue-targeted methods.

Property Type Description
Authentication Type Enum Select whether the Connection uses an Account Key, SAS Token, or delegated Entra OAuth 2.0.
Account Name String Azure storage account name used to target the queue service when Service Uri is not supplied.
Service Uri String Optional absolute queue service URL, for example, https://account.queue.core.windows.net.
Default Queue Name String Optional default queue used when queue-targeted methods omit Queue Name.
Account Key Masked Azure storage account shared key used when Authentication Type is Account Key.
SAS Token Masked Shared access signature token used when Authentication Type is SAS Token.
Tenant ID String Microsoft Entra tenant identifier used when Authentication Type is Entra OAuth 2.0.
Client ID String Application client identifier used for delegated Entra OAuth 2.0.
Client Secret Masked Application secret used for delegated Entra OAuth 2.0.
Scopes String Delegated OAuth scopes used for Microsoft Entra authorization and token refresh.
Access Token Masked Delegated OAuth access token returned by Microsoft Entra ID.
Refresh Token Masked Delegated OAuth refresh token returned by Microsoft Entra ID.

Setup Notes

  • Enter either Service Uri or Account Name. If you leave Service Uri blank, Flowgear derives it from Account Name.
  • Service Uri must be an absolute URL.
  • Paste SAS Token values with or without the leading ?. The Node normalizes either format.
  • Enter Default Queue Name if you want queue-targeted methods to use one queue by default.
  • The Connection test checks Default Queue Name when it is set. Otherwise it validates access by listing queues.
  • For delegated Entra OAuth 2.0, configure Tenant ID, Client ID, Client Secret, and the delegated scopes required by your Azure registration.
  • If you leave Scopes blank for delegated OAuth, the Node uses the default Azure Storage delegated scope set.
  • Queue names must be 3 to 63 characters, use lowercase DNS-style characters only, and cannot contain consecutive hyphens.

Methods

This Node exposes methods for queue administration, queue metadata, and queue message lifecycle operations.

Enqueue Message

Use this method to add one message to a queue. You can optionally delay visibility and control how the message text is serialized.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue that receives the message. If you leave this blank, the Node uses Default Queue Name from the Connection.
MessageBody String Message text to send. The Node wraps this text in Azure's queue-message XML body.
MessageEncoding Enum Select PlainText to send the message text directly or Base64 to encode it before sending.
VisibilityTimeout Integer Optional initial invisibility period in seconds before the new message becomes visible.
MessageTtl Integer Optional message time-to-live in seconds. Use -1 for a non-expiring message where the Azure service version allows it.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the enqueue result. See the Message Write Response Properties table below.

Message Write Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Raw Azure response body, or a serialized header snapshot when Azure does not return a body.
MessageId String Identifier of the created or updated message, when available.
PopReceipt String Current pop receipt for the message. Store this if you plan to update or delete the message later.
TimeNextVisible DateTime Date and time when the message becomes visible again, when Azure supplies it.
InsertionTime DateTime Date and time when Azure inserted the message, when available.
ExpirationTime DateTime Date and time when Azure expires the message, when available.

Dequeue Messages

Use this method to receive one or more visible messages from a queue without deleting them. Azure hides the received messages for the configured visibility timeout and returns the current PopReceipt.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue to receive from. If you leave this blank, the Node uses Default Queue Name from the Connection.
NumberOfMessages Integer Optional number of messages to receive. Azure allows 1 to 32 messages per request.
VisibilityTimeout Integer Optional visibility timeout in seconds applied to the received messages.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row per received message. See the Message Response Properties table below.

Message Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Raw Azure response body, or a serialized header snapshot when Azure does not return a body.
MessageId String Identifier of the queue message.
MessageText String Message body returned by Azure Storage.
PopReceipt String Current pop receipt returned by Dequeue Messages. Peek Messages does not return this value.
InsertionTime DateTime Date and time when Azure inserted the message, when available.
ExpirationTime DateTime Date and time when Azure expires the message, when available.
TimeNextVisible DateTime Date and time when the message becomes visible again. This is returned by Dequeue Messages when Azure supplies it.
DequeueCount Integer Number of times Azure has dequeued the message, when available.

Peek Messages

Use this method to inspect visible messages without changing their visibility state.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue to peek. If you leave this blank, the Node uses Default Queue Name from the Connection.
NumberOfMessages Integer Optional number of messages to peek. Azure allows 1 to 32 messages per request.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row per visible message. See the Message Response Properties table above.

Delete Message

Use this method to delete one previously received message by MessageId and the current PopReceipt.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue that owns the target message. If you leave this blank, the Node uses Default Queue Name from the Connection.
MessageId String Message identifier returned by Dequeue Messages or Enqueue Message.
PopReceipt String Current pop receipt returned by the latest Dequeue Messages or Update Message call.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the delete result. See the Operation Result Response Properties table below.

Operation Result Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Serialized header snapshot returned for no-body Azure responses.
Success Boolean Indicates whether Azure accepted the operation.

Update Message

Use this method to update one message's visibility timeout and optionally replace its body. You must supply MessageBody, VisibilityTimeout, or both.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue that owns the target message. If you leave this blank, the Node uses Default Queue Name from the Connection.
MessageId String Message identifier returned by Dequeue Messages or Enqueue Message.
PopReceipt String Current pop receipt returned by the latest Dequeue Messages or Update Message call.
MessageBody String Optional new message text. Leave this blank to keep the current body while updating visibility.
MessageEncoding Enum Select PlainText to send the message text directly or Base64 to encode it before sending.
VisibilityTimeout Integer Optional new visibility timeout in seconds.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the updated message details. See the Message Write Response Properties table above.

Clear Messages

Use this method to delete all messages from one queue.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue to clear. If you leave this blank, the Node uses Default Queue Name from the Connection.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the clear result. See the Operation Result Response Properties table above.

Create Queue

Use this method to create one queue and optionally apply metadata during creation.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue name to create.
Metadata Object Optional queue metadata as key/value pairs. The Node sends each entry as an x-ms-meta-* header.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the create result. See the Create Queue Response Properties table below.

Create Queue Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Serialized header snapshot returned for the create response.
QueueName String Queue name targeted by the operation.
Created Boolean Indicates whether Azure created the queue during this request.

Delete Queue

Use this method to delete one queue. Azure can delay queue-name reuse for a short period after deletion.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue name to delete.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the delete result. See the Operation Result Response Properties table above.

List Queues

Use this method to list queues visible to the configured credential. The Node follows Azure's opaque continuation markers internally and returns rows from every page.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
Prefix String Optional queue-name prefix used to limit the returned queues.
IncludeMetadata Boolean When true, Azure includes queue metadata in the list response.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row per matching queue across all Azure pages. See the Queue List Response Properties table below.

Queue List Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Raw Azure XML response body.
QueueName String Queue name returned by Azure Storage.
Metadata Object Queue metadata returned by Azure when IncludeMetadata is true.

Get Queue Metadata

Use this method to read queue metadata and the approximate message count for one queue.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue to inspect. If you leave this blank, the Node uses Default Queue Name from the Connection.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with queue metadata details. See the Queue Metadata Response Properties table below.

Queue Metadata Response Properties

Property Type Description
Flowgear Object Flowgear success or error details for the method call.
RequestId String Azure request identifier for the operation, when available.
StatusCode Integer HTTP status code returned by Azure Storage.
RawResponse String Serialized header snapshot returned by the metadata request.
QueueName String Queue name targeted by the operation.
Metadata Object Queue metadata returned by Azure Storage.
ApproximateMessageCount Integer Approximate number of messages currently in the queue, when Azure supplies it.

Set Queue Metadata

Use this method to replace all metadata on one queue and then return the refreshed metadata plus the approximate message count.

Parameter Type Description
Connection Connection Azure Queue Storage Connection details including the selected account key, SAS token, or delegated Entra OAuth 2.0 settings.
QueueName String Queue to update. If you leave this blank, the Node uses Default Queue Name from the Connection.
Metadata Object Queue metadata as key/value pairs. Supply an empty Object to clear existing metadata.
Timeout Integer Optional Azure REST timeout in seconds for this request.
Return Type Description
Response Object One row with the refreshed metadata details. See the Queue Metadata Response Properties table above.

Usage Notes

  • When upgrading, refresh templates and update bindings for PascalCase Node inputs such as QueueName, MessageBody and PopReceipt. Existing Connection property labels and keys remain unchanged.

  • JSON-returning methods place Flowgear success and error details under Response.Flowgear. Provider-specific fields are nested directly under Response.

  • Dequeue Messages and Peek Messages return one row per message.

  • List Queues templates omit Marker and Max Results. The Node follows Azure continuation markers internally and returns one row per matching queue.

  • If you omit QueueName on queue-targeted methods, the Node uses Default Queue Name from the Connection.

  • Delete Message and Update Message require the current PopReceipt. Use the latest receipt returned by Dequeue Messages or Update Message.

  • Set Queue Metadata replaces the full metadata set on the queue.

  • Message bodies are returned exactly as stored by Azure. If you choose Base64 for MessageEncoding, downstream steps must decode MessageText explicitly.

  • Metadata is a simple key/value object. The Node sends each entry as an x-ms-meta-* header.

Known Issues

  • If Clear Messages, Delete Queue, or Update Message times out, check queue state before retrying. Azure can complete the operation even when the client times out.