Azure Storage Queue Service
Discover more about the Azure Storage Queue Service and how to use it on the Digibee Integration Platform.
Last updated
Discover more about the Azure Storage Queue Service and how to use it on the Digibee Integration Platform.
Last updated
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
Azure Storage Queue Service stores and retrieves messages to/from Azure Storage Queue.
Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB)
.
Parameter | Description | Default value | Data type |
---|---|---|---|
Parameter | Description | Default value | Data type |
---|---|---|---|
Parameter | Description | Default value | Data type |
---|---|---|---|
Parameter | Description | Default value | Data type |
---|---|---|---|
Dynamic Account
When active, the connector will use the account dynamically. Otherwise, it will use the account statically.
False
Boolean
Account Name (DB)
The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.
N/A
String
Account
The account used by the connector. It is only available if the Dynamic Account parameter is inactive.
N/A
Account
Fail On Error
Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade "success"
.
False
Booleano
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 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 retrieve. If there are fewer messages in the queue than requested, all 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 second 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
Body (DB)
The body, if applicable.
{ }
JSON
Metadata
(createQueue) Metadata to associate with the queue.
N/A
String
Message Id (DB)
The ID of the message.
N/A
String
Insertion Time (DB)
The time the message was inserted into the queue.
N/A
String
Expiration Time (DB)
The time that the message will expire and be automatically deleted.
N/A
String
Pop Receipt (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
Time Next Visible (DB)
The time that the message will again become visible in the queue.
N/A
String
Dequeue Count
The number of times the message has been dequeued.
N/A
Number
Name (DB)
(All) Override the queue name.
N/A
String
Max Messages
(receiveMessages, peekMessages) Maximum number of messages to retrieve. If there are fewer messages in the queue than requested, all messages will be returned. If left empty, only 1 message will be retrieved. The allowed range is 1 to 32 messages.
N/A
Number
Create Queue
(sendMessage) When set to true, the queue will be automatically created when sending messages to the queue.
Documentation
Section for documenting any necessary information about the connector configuration and business rules.
N/A
String