1. Home
  2. FlexRule Runtime (SDK)
  3. Commands
  4. Azure Queue Storage Commands

Azure Queue Storage Commands

◷ Reading Time: 1 minute

Put Message

Put a message in the Azure Storage Queue.

Summary
  • Data Source (required): String value for the connection to the storage.
  • Queue Name (required): Name of the queue.
  • Content (required): The content of the message.
  • Visibility Timeout: Integer value in seconds.
  • Message Time-to-Live: Integer value in seconds.

Example

Put a Message

1. Set up a variable definition to hold the contents of the result.

2. Add a Put Message activity to your flow.

3. Set the arguments and the results to be stored in the result variable.

4. Execute your flow and your message will be added to the queue.
The result of the request will be shown in the result variable in the Parameters window.

Get Messages

Get messages from the Azure Storage Queue.

Summary
  • Data Source (required): String value for the connection to the storage.
  • Queue Name (required): Name of the queue.
  • Number of Messages: Integer value of messages to get. Max is 32.
  • Visibility Timeout: Integer value in seconds.

Example

Get Messages

1. Set up a variable definition to hold the contents of the result.

2. Add a Get Messages activity to your flow.

3. Set the arguments and the results to be stored in the result variable.

4. Execute your flow. Your result variable should contain the messages from the queue.

<?xml version="1.0" encoding="UTF-8"?>
<QueueMessagesList>
   <QueueMessage>
      <MessageId>148afb95-f948-4afa-8030-439a497a68fa</MessageId>
      <InsertionTime>Thu, 27 Feb 2020 22:49:17 GMT</InsertionTime>
      <ExpirationTime>Thu, 05 Mar 2020 22:49:17 GMT</ExpirationTime>
      <PopReceipt>AgAAAAMAAAAAAAAAcnSkS8Dt1QE=</PopReceipt>
      <TimeNextVisible>Thu, 27 Feb 2020 22:50:23 GMT</TimeNextVisible>
      <DequeueCount>1</DequeueCount>
      <MessageText>My message using FlexRule</MessageText>
   </QueueMessage>
</QueueMessagesList>

Peek Messages

Peek messages in the Azure Storage Queue.

Summary
  • Data Source (required): String value for the connection to the storage.
  • Queue Name (required): Name of the queue.
  • Number of Messages: Integer value of messages to get. Max is 32.

Example

Peek Messages

1. Set up a variable definition to hold the contents of the result.

2. Add a Peek Messages activity to your flow.

3. Set the arguments and the results to be stored in the result variable.

4. Execute your flow.

<?xml version="1.0" encoding="UTF-8"?>
<QueueMessagesList>
   <QueueMessage>
      <MessageId>f5817e5e-f639-4c37-827c-bc1e767e08e9</MessageId>
      <InsertionTime>Thu, 27 Feb 2020 22:49:23 GMT</InsertionTime>
      <ExpirationTime>Thu, 05 Mar 2020 22:49:23 GMT</ExpirationTime>
      <DequeueCount>0</DequeueCount>
      <MessageText>My message using FlexRule</MessageText>
   </QueueMessage>
</QueueMessagesList>

Delete Message

Delete a message in the Azure Storage Queue.

Summary
  • Data Source (required): String value for the connection to the storage.
  • Queue Name (required): Name of the queue.
  • Message ID (required): The ID of the message to delete.
  • Pop Receipt (required): Receipt received when you perform a Get request.

Example

Delete a Message

1. Perform a Get Messages activity before deleting, as you’ll need the MessageId and PopReceipt from the result for the message you want to delete.

<?xml version="1.0" encoding="UTF-8"?>
<QueueMessagesList>
   <QueueMessage>
      <MessageId>148afb95-f948-4afa-8030-439a497a68fa</MessageId>
      <InsertionTime>Thu, 27 Feb 2020 22:49:17 GMT</InsertionTime>
      <ExpirationTime>Thu, 05 Mar 2020 22:49:17 GMT</ExpirationTime>
      <PopReceipt>AgAAAAMAAAAAAAAAcnSkS8Dt1QE=</PopReceipt>
      <TimeNextVisible>Thu, 27 Feb 2020 22:50:23 GMT</TimeNextVisible>
      <DequeueCount>1</DequeueCount>
      <MessageText>My message using FlexRule</MessageText>
   </QueueMessage>
</QueueMessagesList>

2. Add a Delete Message activity to your flow.

3. Set the arguments.
Use the MessageId and PopReceipt from the Get Messages activity in step 1.

4. Execute the flow. The specified message will be deleted from the queue.

Updated on May 17, 2021

Was this article helpful?

Related Articles