# tAzureStorageQueuePurge

Purges messages in an Azure queue.

## tAzureStorageQueuePurge Standard properties

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

The Standard tAzureStorageQueuePurge component belongs to the Cloud family.

The component in this framework is available in all Talend products.

## Basic settings

| Properties | Description |
| --- | --- |
| Property Type | Select the way the connection details<br>will be set.<br><br><ul> <li> <p> <span>Built-In</span>: The connection details will be set                                locally for this component. You need to specify the values for all                                related connection properties manually.</p> </li> <li> <p> <span>Repository</span>: The connection details stored                                centrally in <span><span>Repository</span><abbr> &gt; </abbr><span>Metadata</span></span> will be reused by this component. </p> <p>You need to click                                the <span>[...]</span> button next to it and in the pop-up                                    <span>Repository Content</span> dialog box, select the                                connection details to be reused, and all related connection                                properties will be automatically filled in.</p> </li> </ul><br><br>This property is not available when other connection component is selected from<br>the Connection Component dropdown list. |
| Connection Component | Select the component whose<br>connection details will be used to set up the connection to Azure storage from the<br>drop-down list. |
| Account Name | Enter the name of the storage account you need to access. A<br>storage account name can be found in the Storage accounts dashboard of the Microsoft<br>Azure Storage system to be used. Ensure that the administrator of the system has<br>granted you the appropriate access permissions to this storage account. |
| Authentication type | Set the authentication type for connecting to Microsoft Azure Blob storage:<br>Basic, Azure Active<br>Directory, or Managed identities.<br><br><ul> <li> <span>Basic</span>: Select                          this option if you want to access Microsoft Azure Blob storage using                          your storage account access key or a shared access signature. See <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string" target="_blank">Configuring Azure Storage                              connection strings</a> and <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview" target="_blank">Using shared access signatures                                  (SAS)</a> for related information.</li> <li> <span>Azure Active                              Directory</span>: Select this option to access Microsoft Azure                          Blob storage using your Azure Active Directory (Azure AD) credentials.                          See <a href="https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad?toc=/azure/storage/blobs/toc.json" target="_blank">Authorize access to blobs and                              queues using Azure Active Directory</a> for related                          information.</li> <li><span>Managed identities</span>: Select this option to use                            system-assigned managed identities to access Azure Active                            Directory-protected resources. For more information, see <a href="https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview" target="_blank">What are managed identities for Azure                                resources</a> and <a href="https://learn.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/managed-identities-status" target="_blank">Azure services that can use managed                                identities to access other services</a>.</li> </ul><br><br>Information noteNote: The Managed identities option is available only when<br>you have installed the 8.0.1-R2023-03 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator. |
| Region | Select one of the following Azure regions from the drop-down list.<br><br><ul> <li><span>Azure Global</span></li> <li><span>Azure China</span></li> <li><span>Azure Germany</span></li> <li><span>Azure Government</span></li> <li><span>Azure Custom</span></li> </ul><br><br><br>You can use a customized Azure region by selecting the Azure<br>Custom option and entering the endpoint suffix and the authority<br>host URL in the Endpoint suffix field and the<br>Authority host field. Note that the authority host<br>URL is required when Azure Active Directory is selected<br>from the Authentication type drop-down list.<br><br>This<br>drop-down list is not available if you select Managed<br>identities from the Authentication<br>type drop-down list.<br><br>Information noteNote: The Region drop-down list is available only when<br>you have installed the 8.0.1-R2023-03 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator. |
| Account Key | Enter the key associated with the storage account you need to access. Two<br>keys are available for each account and by default, either of them can be used for<br>this access. Select the component whose connection details will be used to set up<br>the connection to Azure storage from the drop-down list.<br><br>This option is available if you select<br>Basic from the Authentication type drop-down list. |
| Protocol | Select the protocol for this connection to be created.<br><br>This option is available if you select<br>Basic from the Authentication type drop-down list. |
| Use Azure Shared Access Signature | Select this check box to use a shared access signature (SAS)<br>to access the storage resources without need for the account key. For more<br>information, see [Using Shared Access Signatures<br>(SAS)](https://docs.microsoft.com/en-us/azure/storage/storage-dotnet-shared-access-signature-part-1).<br><br>In the Azure Shared Access<br>Signature field displayed, enter your account SAS URL<br>between double quotation marks. You can get the SAS URL for each allowed<br>service on Microsoft Azure portal after generating SAS. The SAS URL format<br>is https://&lt;$storagename&gt;.&lt;$service&gt;.core.windows.net/&lt;$sastoken&gt;,<br>where &lt;$storagename&gt; is the storage<br>account name, &lt;$service&gt; is the<br>allowed service name (blob,<br>file, queue or table), and<br>&lt;$sastoken&gt; is the SAS token<br>value. For more information, see [Constructing the Account SAS<br>URI](https://docs.microsoft.com/fr-fr/rest/api/storageservices/Constructing-an-Account-SAS?redirectedfrom=MSDN#constructing-the-account-sas-uri).<br><br>Note that the SAS has valid period, you can set the start<br>time at which the SAS becomes valid and the expiry time after which the SAS<br>is no longer valid when generating it, and you need to make sure your SAS is<br>still valid when running your Job.<br><br>This option is available if you select<br>Basic from the Authentication type drop-down list. |
| Tenant ID | Enter the ID of the Azure AD tenant.<br>See [Acquire a token from Azure AD for<br>authorizing requests from a client application](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-app) for related<br>information.<br><br>This option is available if you select Azure<br>Active Directory from the Authentication<br>method drop-down list. |
| Client ID | Enter the client ID of your<br>application. See [Acquire a token from Azure AD for<br>authorizing requests from a client application](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-app) for related<br>information.<br><br>This option is available if you select Azure<br>Active Directory from the Authentication<br>method drop-down list. |
| Client Secret | Enter the client secret of your<br>application. See [Acquire a token from Azure AD for<br>authorizing requests from a client application](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-app) for related<br>information.<br><br>This option is available if you select Azure<br>Active Directory from the Authentication<br>method drop-down list. |
| Queue name | Specify the name of the Azure queue in which the messages will be purged. |
| Die on error | Select the checkbox to stop the execution of the Job when an error<br>occurs. |

## Advanced settings

| Properties | Description |
| --- | --- |
| tStatCatcher Statistics | Select this checkbox to gather the Job processing metadata at the Job level<br>as well as at each component level. |

## Global Variables

| Variables | Description |
| --- | --- |
| ERROR\_MESSAGE | The error message generated by the component when an error occurs. This<br>is an After variable and it returns a string. |

## Usage

| Usage guidance | Description |
| --- | --- |
| Usage rule | This component can be used as a standalone component of a Job or<br>subJob. |