Azure Storage Queue Service

Discover more about the Azure Storage Queue Service and how to use it on the Digibee Integration Platform.

Important information:

This documentation is currently available only in English but will soon be translated into Portuguese.
The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.

Stores and retrieves messages to/from Azure Storage Queue.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Required Tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Dynamic Account	When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically.	false	boolean
Account Name `(DB)`	The name of the account that is generated dynamically via the Store Account connector.		string
Account	Sets the account to be used by the connector.	N/A	account
Fail On Error	If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false	false	boolean

Dynamic Account

When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically.

false

boolean

Account Name (DB)

The name of the account that is generated dynamically via the Store Account connector.

string

Account

Sets the account to be used by the connector.

N/A

account

Fail On Error

If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false

false

boolean

Optional Tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Account Name `(DB)`	Azure account name to be used for authentication with azure queue services	N/A	string
Queue Name `(DB)`	The queue resource name	N/A	string
Create Queue	When is set to true, the queue will be automatically created when sending messages to the queue.	false	boolean
Operation	Queue service operation hint to the producer		string
Max Messages	Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.	1	number
Message Id `(DB)`	The ID of the message to be deleted or updated.	N/A	string
Pop Receipt `(DB)`	Unique identifier that must match for the message to be deleted or updated.	N/A	string
Timeout `(DB)`	An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown.	N/A	string
Time To Live `(DB)`	How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S – parses as 20.345 seconds, P2D – parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.	N/A	string
Visibility Timeout `(DB)`	The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S – parses as 20.345 seconds, P2D – parses as 2 days. However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.	N/A	string

Account Name (DB)

Azure account name to be used for authentication with azure queue services

N/A

string

Queue Name (DB)

The queue resource name

N/A

string

Create Queue

When is set to true, the queue will be automatically created when sending messages to the queue.

false

boolean

Operation

Queue service operation hint to the producer

string

Max Messages

Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.

number

Message Id (DB)

The ID of the message to be deleted or updated.

N/A

string

Pop Receipt (DB)

Unique identifier that must match for the message to be deleted or updated.

N/A

string

Timeout (DB)

An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown.

N/A

string

Time To Live (DB)

How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S – parses as 20.345 seconds, P2D – parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.

N/A

string

Visibility Timeout (DB)

The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days.

The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S – parses as 20.345 seconds, P2D – parses as 2 days. However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe.

N/A

string

Headers Tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
CamelAzureStorageQueueMetadata	(createQueue) Metadata to associate with the queue	N/A	string
CamelAzureStorageQueueMessageId `(DB)`	The ID of the message.	N/A	string
CamelAzureStorageQueueInsertionTime `(DB)`	The time the Message was inserted into the Queue.	N/A	string
CamelAzureStorageQueueExpirationTime `(DB)`	The time that the Message will expire and be automatically deleted.	N/A	string
CamelAzureStorageQueuePopReceipt `(DB)`	(deleteMessage, updateMessage) Unique identifier that must match for the message to be deleted or updated. If deletion fails using this pop receipt then the message has been dequeued by another client.	N/A	string
CamelAzureStorageQueueTimeNextVisible `(DB)`	The time that the message will again become visible in the Queue.	N/A	string
CamelAzureStorageQueueDequeueCount	The number of times the message has been dequeued.	N/A	number
CamelAzureStorageQueueOperation	(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.		string
CamelAzureStorageQueueName `(DB)`	(All) Override the queue name.	N/A	string
CamelAzureStorageQueueMaxMessages	(receiveMessages, peekMessages) Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.	N/A	number
CamelAzureStorageQueueCreateQueue	(sendMessage) When is set to true, the queue will be automatically created when sending messages to the queue.	false	boolean

CamelAzureStorageQueueMetadata

(createQueue) Metadata to associate with the queue

N/A

string

CamelAzureStorageQueueMessageId (DB)

The ID of the message.

N/A

string

CamelAzureStorageQueueInsertionTime (DB)

The time the Message was inserted into the Queue.

N/A

string

CamelAzureStorageQueueExpirationTime (DB)

The time that the Message will expire and be automatically deleted.

N/A

string

CamelAzureStorageQueuePopReceipt (DB)

(deleteMessage, updateMessage) Unique identifier that must match for the message to be deleted or updated. If deletion fails using this pop receipt then the message has been dequeued by another client.

N/A

string

CamelAzureStorageQueueTimeNextVisible (DB)

The time that the message will again become visible in the Queue.

N/A

string

CamelAzureStorageQueueDequeueCount

The number of times the message has been dequeued.

N/A

number

CamelAzureStorageQueueOperation

(All) Specify the producer operation to execute, please see the doc on this page related to producer operation.

string

CamelAzureStorageQueueName (DB)

(All) Override the queue name.

N/A

string

CamelAzureStorageQueueMaxMessages

(receiveMessages, peekMessages) Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages.

N/A

number

CamelAzureStorageQueueCreateQueue

(sendMessage) When is set to true, the queue will be automatically created when sending messages to the queue.

false

boolean

Successful executions should output at least a property "success": true

PreviousAzure NextAzure Event Hubs

Last updated 17 days ago