Connectors Reference

Azure Queues

Azure Queue storage provides cloud messaging between application components. Queue storage also supports managing asynchronous tasks and building process work flows.

 

Status: Production

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListQueues ()

List queues

GetMessages (string queueName, [Optional]string numofmessages, [advanced][Optional]string visibilitytimeout)

Get messages

PutMessage (string queueName, string message)

Put a message on a queue

DeleteMessage (string queueName, string messageId, string popreceipt)

Delete message

PutQueue (string queueName)

Create a new queue

 

Triggers:

Name

Summary

OnMessageThresholdReached (string queueName, integer threshold)

When a specified number of messages are in a given queue

OnMessages (string queueName, [advanced][Optional]string visibilitytimeout)

When there are messages in a queue

 

Objects:

Name

Summary

Messages

 

Queue

 

 

Actions:

ListQueues

Summary: List queues

Description: List all the queues for your storage account.

 

Syntax:

AzureQueues.ListQueues ()

 

Returns:

          Type:array of (Queue)

 

GetMessages

Summary: Get messages

Description: 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.

 

Syntax:

AzureQueues.GetMessages (string queueName, [Optional]string numofmessages, [advanced][Optional]string visibilitytimeout)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The queue to get Messages from.

True

ListQueues

numofmessages

string

(Number of Messages)

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

False

visibilitytimeout

string

(Visibility Timeout)

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

False

 

Returns:

          Type:Messages

 

PutMessage

Summary: Put a message on a queue

Description: Adds a message to the given queue.

 

Syntax:

AzureQueues.PutMessage (string queueName, string message)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The queue to put a message to.

True

ListQueues

message

string

 

 

True

 

Returns:

 

DeleteMessage

Summary: Delete message

Description: Delete a specific message from the queue.

 

Syntax:

AzureQueues.DeleteMessage (string queueName, string messageId, string popreceipt)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The queue to delete a message from.

True

ListQueues

messageId

string

(Message ID)

The ID of the message to delete.

True

popreceipt

string

(Pop Receipt)

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

True

 

Returns:

 

PutQueue

Summary: Create a new queue

Description: Adds a queue to your account.

 

Syntax:

AzureQueues.PutQueue (string queueName)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The name of the queue to create.

True

 

Returns:

          Type:string

 

Triggers:

Trigger OnMessageThresholdReached

Summary: When a specified number of messages are in a given queue

Description: Triggers when a specified number of messages are in the given queue.

 

Syntax:

AzureQueues.OnMessageThresholdReached (string queueName, integer threshold)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The queue to check for messages.

True

ListQueues

threshold

integer(int32)

(Threshold)

The number of messages to wait for to fire the trigger.

True

 

Returns:

          Type:string

 

Trigger OnMessages

Summary: When there are messages in a queue

Description: Triggers any time there are messages in the queue, returning up to 32 messages. The messages will be hidden but remain on the queue until the delete action is used.

 

Syntax:

AzureQueues.OnMessages (string queueName, [advanced][Optional]string visibilitytimeout)

 

Parameters:

Name

Type

Summary

Required

Related Action

queueName

string

(Queue Name)

The queue to check for messages

True

ListQueues

visibilitytimeout

string

(Visibility Timeout)

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

False

 

Returns:

          Type:Messages

 


 

Messages

Summary:

Description:

 

          Properties:

Name

Type

Summary

QueueMessagesList

QueueMessagesList

 

 

 

QueueMessagesList

Summary:

Description:

 

          Properties:

Name

Type

Summary

QueueMessage

array of (QueueMessageItem)

 

 

 

QueueMessageItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

MessageId

string

Message ID

The unique identifier of the message.

InsertionTime

string

Insertion Time

The time the message was inserted into the queue.

ExpirationTime

string

Expiration Time

The time the message will expire from the queue.

PopReceipt

string

Pop Receipt

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

TimeNextVisible

string

Next Visibile Time

The time the message will be visible to other consumers.

MessageText

string

Message Text

The text of the message.

 


 

Queue

Summary:

Description:

 

          Properties:

Name

Type

Summary

Name

string

Name

The name of the queue.