tAzureAdlsGen2Get Standard properties

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.

Use an existing connection

Select this check box and in the Component List drop-down list, select the desired connection component to reuse the connection details you already defined.

Authentication method

Select one of the following authentication method from the drop-down list.

• Shared key, which requires an account access key. See Manage a storage account for related information.
• Shared Access Signature, which requires a shared access signature. See Constructing the Account SAS URI for related information.
• Azure Active Directory, Select this option to use Azure Active Directory authentication when establishing the connection. See Azure AD Authentication for related information.

Account name

Enter the name of the Data Lake Storage account you need to access. Ensure that the administrator of the system has granted you the appropriate access permissions to this account.

Endpoint suffix

Enter the Azure Storage service endpoint.

The combination of the account name and the Azure Storage service endpoint forms the endpoint of the storage account.

Shared 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. To know how to get your key, read Manage a storage account.

To enter the shared key, click the [...] button next to the Shared key field to bring out the Enter a new password dialog box, enter the shared key in the text field, and click OK. Note that you can enter the shared key either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field.

This field is available if you select Shared key from Authentication method drop-down list.

SAS token

Enter your account SAS token. You can get the SAS token for each allowed service on the Microsoft Azure portal after generating SAS. The SAS token format is https://<$storagename><$service>.core.windows.net/<$sastoken>, 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, read Constructing the Account SAS URI.

This field is available if you select Shared Access Signature from Authentication method drop-down list.

Tenant ID

Enter the ID of the Azure AD tenant. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

Client ID

Enter the client ID of your application. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

Client Secret

Enter the client secret of your application. See Acquire a token from Azure AD for authorizing requests from a client application for related information.

To enter the client secret, click the [...] button next to the Client secret field to bring out the Enter a new password dialog box, enter the client secret in the text field, and click OK. Note that you can enter the client secret either in a JSON string in the pure password mode or as a Java expression in the Java mode. You can toggle between the two modes by clicking switch to Java mode or switch to pure password mode on the top of the text field.

This option is available if you select Azure Active Directory from the Authentication method drop-down list.

File system

Enter the name of the desired blob container.

You can also click the [...] button to the right of this field and select the desired blob container from the list in the dialog box.

Blobs path

Enter the path to the blob to download files from.

Local folder

Enter the path to the folder for storing the downloaded files.

Include subdirectory

Select this option to also download the files in all the subdirectories under the specified blob.

Keep the remote directory structure

Select this option to create the same directory structure as the one on the blob and store the downloaded files in the same directories as those in the desired blob.

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

tStatCatcher Statistics

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

ERROR_MESSAGE

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

This component is typically used as a single-component subJob but can also be used as output or end object.