August 15, 2023

tAzureStorageQueueInputLoop – Docs for ESB 6.x


Runs an endless loop to retrieve messages from the front of an Azure

tAzureStorageQueueInputLoop Standard properties

These properties are used to configure tAzureStorageQueueInputLoop
running in the Standard Job framework.

The Standard
tAzureStorageQueueInputLoop component belongs to the Cloud family.

The component in this framework is generally available.

Basic settings

Property Type

Select the way the connection details
will be set.

  • Built-In: The connection details will be set
    locally for this component. You need to specify the values for all
    related connection properties manually.

  • Repository: The connection details stored
    centrally in Repository > Metadata will be reused by this component. You need to click
    the […] button next to it and in the pop-up
    Repository Content dialog box, select the
    connection details to be reused, and all related connection
    properties will be automatically filled in.

This property is not available when other connection component is selected
from the Connection Component drop-down list.

Connection Component

Select the component whose connection details will be
used to set up the connection to Azure storage from the drop-down list.

Account Name

Enter the name of the storage account you need to access. A storage account
name can be found in the Storage accounts dashboard of the Microsoft Azure Storage
system to be used. Ensure that the administrator of the system has granted you the
appropriate access permissions to this storage account.

Account Key

Enter the key associated with the storage account you need to access. Two
keys are available for each account and by default, either of them can be used for
this access.


Select the protocol for this connection to be created.

Use Azure Shared Access Signature

Select this check box to use a shared access signature (SAS) to access the
storage resources without need for the account key. For more information,
see Using Shared Access Signatures

In the Azure Shared Access Signature field displayed,
enter your account SAS URL between double quotation marks. You can get the
SAS URL for each allowed service on Microsoft Azure portal after generating
SAS. The SAS URL format is
where <$storagename> is the storage account name,
<$service> is the allowed service name
(blob, file,
queue or table), and
<$sastoken> is the SAS token value. For more
information, see Constructing the Account SAS

Note that the SAS has valid period, you can set the start time at which the
SAS becomes valid and the expiry time after which the SAS is no longer valid
when generating it, and you need to make sure your SAS is still valid when
running your Job.

Queue name

Specify the name of the Azure queue from which the
messages will be retrieved.

Schema and Edit schema

A schema is a row description. It defines the number of fields (columns) to
be processed and passed on to the next component. The schema is either Built-In or stored remotely in the Repository.

  • Built-In: You create and store the
    schema locally for this component only. Related topic: see
    Talend Studio

    User Guide.

  • Repository: You have already created
    the schema and stored it in the Repository. You can reuse it in various projects and
    Job designs. Related topic: see
    Talend Studio

    User Guide.

The schema of this component is predefined with
the following columns:

  • MessageId: the id of the message.
  • MessageContent: the body of the message.
  • InsertionTime: the time when the message was added to the
  • ExpirationTime: the time when the message will be
  • NextVisibleTime: the time when the message becomes
    visible next time.
  • DequeueCount: the number of times that the message has
    been dequeued. This value is incremented each time the message is dequeued, but
    it will not be incremented when the message is peeked.
  • PopReceipt: the pop receipt value that is required to
    delete the message.

Click Edit schema to make changes to the schema.
If the current schema is of the Repository type, three
options are available:

  • View schema: choose this option to view the
    schema only.

  • Change to built-in property: choose this
    option to change the schema to Built-in for
    local changes.

  • Update repository connection: choose this
    option to change the schema stored in the repository and decide whether to propagate
    the changes to all the Jobs upon completion. If you just want to propagate the
    changes to the current Job, you can select No
    upon completion and choose this schema metadata again in the [Repository Content] window.

Number of messages

Enter the number of messages to be retrieved from the
specified queue at a time, up to a maximum of 32.

Loop wait time

Specify the duration (in seconds) for which the loop will wait for the message to
arrive in the queue before returning.

Die on error

Select the check box to stop the execution of the Job when an error

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level
as well as at each component level.

Global Variables


The number of rows processed. This is an After variable and it returns an


The name of the Azure queue. This is an After variable and it
returns a string.


The error message generated by the component when an error occurs. This
is an After variable and it returns a string.


Usage rule

This component is usually used as a start component of a Job or Subjob and it
always needs an output link.

Related scenario

No scenario is available for this component yet.

Document get from Talend
Thank you for watching.
Notify of
Inline Feedbacks
View all comments
Would love your thoughts, please comment.x