The Credentials File| Teradata Access Module for Azure Blob - The Credentials File - Access Module

Teradata® Tools and Utilities Access Module Reference - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Access Module
Release Number
20.00
Published
October 2023
ft:locale
en-US
ft:lastEdition
2024-05-14
dita:mapPath
cya1691484517272.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
hjf1479308836950
lifecycle
latest
Product Category
Teradata Tools and Utilities

The credentials file contains user credentials such as "StorageAccountName","StorageAccountKey", "ClientId", "TenantId" and "ClientSecret".

The Azure access module supports two authentication methods which are AccessKeys and AzureAD.

"StorageAccountName" and "StorageAccountKey" are required parameter for AccessKeys authentication method.

"StorageAccountName","ClientId", "TenantId" and "ClientSecret" are required parameter for AzureAD authentication method.

"ClientId" parameter takes the Application Client ID as value.

"TenantId" parameter takes the Application Tenant ID as value.

"ClientSecret" parameter takes the Application Secret key value as value.

The credentials file also contains "StorageAccountEndPoint".

"StorageAccountName" and "StorageAccountKey" are required parameters where as "StorageAccountEndPoint" is an optional parameter.

If "StorageAccountEndPoint" is not specified in the credentials file, ".blob.core.windows.net" will be used as the default Azure Blob storage endpoint.

The following is an example of the contents of the credentials file with a default location of ~ for AccessKeys authentication method.

~/azureaxsmod/credentials:
[default]
StorageAccountName = Testblobstorage
StorageAccountKey = dV6P********************************************************zA==
StorageAccountEndPoint = .blob.core.windows.net
[export_job_7]
StorageAccountName = Testblobstorage1
StorageAccountKey = oT9Z********************************************************PM==
[load_job_5]
StorageAccountName = Testblobstorage2
StorageAccountKey = sQ3R********************************************************UB==
StorageAccountEndPoint = .custom.endpoint.windows.net

The following is an example of the contents of the credentials file with a default location of ~ for AzureAD authentication method.

[default]
StorageAccountName = Testblobstorage
ClientId = fd********************************28
TenantId = 86********************************3ac
ClientSecret = jS********************************zs
[load_job_5]
StorageAccountName = Testblobstorage2
ClientId = qs********************************91
TenantId = 25********************************9zx
ClientSecret = oP********************************ps
StorageAccountEndPoint = .custom.endpoint.windows.net

These files have sections called Jobprofiles, identified with an arbitrary name in square brackets which describes the load or export job. Select a particular Jobprofile from the credentials file by using the -Jobprofile initialization string parameter.

Create an azureaxsmod directory under your home directory to keep the credentials file and this will serve as the default location for the credentials file. Additionally, you may also store the credentials file in any of your preferred directory. However, you will need to specify the directory path where the credentials file is stored through the -ConfigDir initialization string.

On the Windows platform, the HOME environment variable has to be manually created.
You may store the "StorageAccountName", "StorageAccountKey", "ClientId", "TenantId" and "ClientSecret" values in Teradata Wallet and use the corresponding tdwallet keys in the credentials file. For example:
~/azureaxsmod # cat credentials
[default]
StorageAccountName = $tdwallet(tptazure_myaccount)
StorageAccountKey =$tdwallet(tptazure_mykey)

~/azureaxsmod # cat credentials
[default]
StorageAccountName = $tdwallet(tptazure_myaccount)
StorageAccountKey =$tdwallet(tptazure_mykey)
ClientId = $tdwallet(tptazure_ClientId)
TenantId = $tdwallet(tptazure_TenantId)
ClientSecret = $tdwallet(tptazure_ClientSecret)
The key name must be prefixed by the "tptazure_" string.