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 NameAPI NameDefault ValueAllowable ValuesDescription
Queue NameQueue NameName of the Azure Storage Queue
Supports Expression Language: true (will be evaluated using variable registry only)
Endpoint 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 ServiceCredentials ServiceController Service API:
Implementations: AzureStorageCredentialsControllerServiceLookup_v12
Controller Service used to obtain Azure Storage Credentials.
Auto Delete MessagesAuto Delete Messagestrue
  • true
  • false
Specifies whether the received message is to be automatically deleted from the queue.
Message Batch SizeMessage Batch Size32The number of messages to be retrieved from the queue.
Visibility TimeoutVisibility Timeout30 secsThe duration during which the retrieved message should be invisible to other consumers.
Request TimeoutRequest Timeout10 secsThe timeout for read or write requests to Azure Queue Storage. Defaults to 1 second.
Proxy Configuration Serviceproxy-configuration-serviceController Service API:
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.


successAll successfully processed FlowFiles are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

azure.queue.uriThe absolute URI of the configured Azure Queue Storage
azure.queue.insertionTimeThe time when the message was inserted into the queue storage
azure.queue.expirationTimeThe time when the message will expire from the queue storage
azure.queue.messageIdThe ID of the retrieved message
azure.queue.popReceiptThe pop receipt of the retrieved message

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

See Also: