Retrieves the messages from an Azure Queue Storage. The retrieved messages will be deleted from the queue by default. If the requirement is to consume messages without deleting them, set 'Auto Delete Messages' to 'false'. Note: There might be chances of receiving duplicates in situations like when a message is received but was unable to be deleted from the queue due to some unexpected situations.
azure, queue, microsoft, storage, dequeue, cloud
In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Queue Name | Queue Name | Name of the Azure Storage Queue Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Endpoint Suffix | storage-endpoint-suffix | queue.core.windows.net | Storage accounts in public Azure always use a common FQDN suffix. Override this endpoint suffix with a different suffix in certain circumstances (like Azure Stack or non-public Azure regions). | |
| Credentials Service | Credentials Service | Controller Service API: AzureStorageCredentialsService_v12 Implementations: AzureStorageCredentialsControllerService_v12 AzureStorageCredentialsControllerServiceLookup_v12 | Controller Service used to obtain Azure Storage Credentials. | |
| Auto Delete Messages | Auto Delete Messages | true |
| Specifies whether the received message is to be automatically deleted from the queue. |
| Message Batch Size | Message Batch Size | 32 | The number of messages to be retrieved from the queue. | |
| Visibility Timeout | Visibility Timeout | 30 secs | The duration during which the retrieved message should be invisible to other consumers. | |
| Request Timeout | Request Timeout | 10 secs | The timeout for read or write requests to Azure Queue Storage. Defaults to 1 second. | |
| Proxy Configuration Service | proxy-configuration-service | Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService | Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP, SOCKS In case of SOCKS, it is not guaranteed that the selected SOCKS Version will be used by the processor. |
| Name | Description |
|---|---|
| success | All successfully processed FlowFiles are routed to this relationship |
| Name | Description |
|---|---|
| azure.queue.uri | The absolute URI of the configured Azure Queue Storage |
| azure.queue.insertionTime | The time when the message was inserted into the queue storage |
| azure.queue.expirationTime | The time when the message will expire from the queue storage |
| azure.queue.messageId | The ID of the retrieved message |
| azure.queue.popReceipt | The pop receipt of the retrieved message |