8.4 Azure Profile
- Jenni Wallin
- Former user (Deleted)
- Yeok Hong Ng (Deactivated)
The Azure Profile is used for setting up the access credentials and properties to be used to connect to an Azure environment. Currently, the profile can be used with the following agents:
- ADLS2 File collection agent
- ADLS2 File forwarding agent
- Azure Event Hub Consumer agent
- Azure Event Hub Producer agent
Menus
The contents of the menus in the menu bar may change depending on which configuration type has been opened in the currently displayed tab. The Azure Profile uses the standard menu items and buttons that are visible for all configurations, and these are described in 2.1 Menus and Buttons.
The Edit menu is specific to the Azure Profile configurations.
| Item | Description |
|---|---|
External References
| Select this menu item to enable the use of External References in the Azure profile configuration. This can be used to configure the following fields: Shared Key
Connection String
Secret Key
Certificate
For further information, see 8.11.4 Using External Reference in Agent Profile Fields and 8.11 External Reference Profile. |
Configuration - General Tab
The General tab is displayed by default when creating or opening an Azure profile.
Azure Data Lake Storage
Authentication Method - Shared Key
The following settings are available in the Shared Key authentication method for the Azure Data Lake Storage application in the Azure profile.
Azure profile - Azure Data Lake Storage Shared Key configuration
| Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For ADLS2 file agents, select Azure Data Lake Storage. |
| Authentication Method | Select the authentication method for accessing the Azure Data Lake Storage. There are 3 choices with Shared Key, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Storage Account Name | Enter the name of the Azure storage account name that will be used by the Azure Data Lake Storage. |
| Key | Enter the authorized shared access key used to access the Azure storage account. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. |
Authentication Method - Secret Key
The following settings are available in the Secret Key authentication method for the Azure Data Lake Storage application in the Azure profile.
Azure profile - Azure Data Lake Storage Secret Key configuration
Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For ADLS2 file agents, select Azure Data Lake Storage. |
Authentication Method | Select the authentication method for accessing the Azure Data Lake Storage. There are 3 choices with Shared Key, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Storage Account Name | Enter the name of the Azure storage account name that will be used by the Azure Data Lake Storage. |
Client ID | Enter the client ID (application ID) used to create the application for the Azure Active Directory that will allow the profile to access the Azure Data Lake Storage. The ID entered here should correlate with the client ID that is used when registering the application on the Azure Active Directory. |
| Tenant ID | Enter the tenant ID (directory ID) linked to the Azure AD application that will be used by the profile to access the Azure Data Lake Storage. |
| Client Secret | Enter the client secret provided when creating the application for the Azure Active Directory with the client ID above. The client secret will only be visible when registering the client ID. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. Note! The application (Client ID) needs to be configured with roles that have write access in order for the connection test to be successful. However during runtime, the agent will work as expected if the proper permissions are granted, whether it is configured through Role Based Access Control (IAM) or Access Control List (ACL). |
Authentication Method - Certificate
The following settings are available in the Certificate authentication method for the Azure Data Lake Storage application in the Azure profile.
Azure profile - Azure Data Lake Storage Certificate configuration
| Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For ADLS2 file agents, select Azure Data Lake Storage. |
| Authentication Method | Select the authentication method for accessing the Azure Data Lake Storage. There are 3 choices with Shared Key, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Storage Account Name | Enter the name of the Azure storage account name that will be used by the Azure Data Lake Storage. |
| Client ID | Enter the client ID (application ID) used to create the application for the Azure Active Directory that will allow the profile to access the Azure Data Lake Storage. The ID entered here should correlate with the client ID that is used when registering the application on the Azure Active Directory. |
| Tenant ID | Enter the tenant ID (directory ID) linked to the Azure AD application that will be used by the profile to access the Azure Data Lake Storage. |
| Certificate Type | Set the certificate format that is used by the Azure AD application. You can set it to either a PEM or PFX formatted certificate. |
| Certificate Path | Define the full local path of the certificate. The certificate must be stored in the same location as the EC that will be running the workflows with the ADLS2 file agents. The certificate must be the same one used by the Azure AD application. |
| Certificate Password | Enter the password for the PFX certificate, where the password value can also be an empty string. Password locked PEM certificates are not supported. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. Note! The application (Client ID) needs to be configured with roles that have write access in order for the connection test to be successful. However during runtime, the agent will work as expected if the proper permissions are granted, whether it is configured through Role Based Access Control (IAM) or Access Control List (ACL). Note! The certificate path must point to a certificate located in the Platform in order for the connection test to be successful. However during runtime, the certificate path must point to a certificate located in the EC. |
Note!
For the Test Connection button to work while using certificate authentication, the certificate path must point to a certificate located in the Platform. However when running workflows, the certificate path must point to a certificate located in the EC.
As this feature is intended for testing, a temp directory will be created to establish a successful connection. Users with read-only permission will encounter a failure when running the Test Connection. However, the runtime for Azure Data Lake Storage Collection agent workflow will still work for such users.
Azure Event Hub
Authentication Method - Connection String
The following settings are available in the Connection String authentication method for the Azure Event Hub application in the Azure profile.
Azure profile - Azure Event Hub Connection String configuration
| Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For Azure Event Hub agents, select Azure Event Hub. |
| Protocol Select | Allows you to select the Transport Type that the profile will use to collect records from the Azure Event Hub. Currently, the supported protocols are:
|
| Authentication Method | Select the authentication method for accessing the Azure Event Hub. There are 3 choices with Connection String, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Connection String | Enter the connection string-primary key of the event hub instance that the profile will be accessing. You can locate the connection string from the shared access policies menu in the target event hub instance. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. |
Authentication Method - Secret Key
The following settings are available in the Secret Key authentication method for the Azure Event Hub application in the Azure profile.
Azure profile - Azure Event Hub Secret Key configuration
| Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For Azure Event Hub agents, select Azure Event Hub. |
| Protocol Select | Allows you to select the Transport Type that the profile will use to collect records from the Azure Event Hub. Currently, the supported protocols are:
|
| Authentication Method | Select the authentication method for accessing the Azure Event Hub. There are 3 choices with Connection String, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Namespace | Enter the namespace of the Event Hub that the profile will be accessing. |
| Event Hub Name | Enter the name of the Event Hub Instance within the Event Hub Namespace above that the profile will be accessing. |
| Client ID | Enter the client ID (application ID) used to create the application for the Azure Active Directory that will allow the profile to access the Azure Event Hub. The ID entered here should correlate with the client ID that is used when registering the application on the Azure Active Directory. |
| Tenant ID | Enter the tenant ID (directory ID) linked to the Azure AD application that will be used by the profile to access the Azure Event Hub. |
| Client Secret | Enter the client secret provided when creating the application for the Azure Active Directory with the client ID above. The client secret will only be visible when registering the client ID. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. Note! The application (Client ID) needs to be configured with roles that have write access in order for the connection test to be successful. However during runtime, the agent will work as expected if the proper permissions are granted, whether it is configured through Role Based Access Control (IAM) or Access Control List (ACL). |
Authentication Method - Certificate
The following settings are available in the Certificate authentication method for the Azure Event Hub application in the Azure profile.
Azure profile - Azure Event Hub Certificate configuration
| Setting | Description |
|---|---|
| Application Select | Allows you to select the Azure resource that the profile will connect to. For Azure Event Hub agents, select Azure Event Hub. |
| Protocol Select | Allows you to select the Transport Type that the profile will use to collect records from the Azure Event Hub. Currently, the supported protocols are:
|
| Authentication Method | Select the authentication method for accessing the Azure Event Hub. There are 3 choices with Connection String, Secret Key and Certificate. Choosing one of the options will display the appropriate configuration menu for the chosen authentication method. |
| Namespace | Enter the namespace of the Event Hub that the profile will be accessing. |
| Event Hub Name | Enter the name of the Event Hub Instance within the Event Hub Namespace above that the profile will be accessing. |
| Client ID | Enter the client ID (application ID) used to create the application for the Azure Active Directory that will allow the profile to access the Azure Event Hub. The ID entered here should correlate with the client ID that is used when registering the application on the Azure Active Directory. |
| Tenant ID | Enter the tenant ID (directory ID) linked to the Azure AD application that will be used by the profile to access the Azure Event Hub. |
| Certificate Type | Set the certificate format that is used by the Azure AD application. You can set it to either a PEM or PFX formatted certificate. |
| Certificate Path | Define the full local path of the certificate. The certificate must be stored in the same location as the EC that will be running the workflows with the Event Hub agents. The certificate must be the same one used by the Azure AD application. |
| Certificate Password | Enter the password for the PFX certificate, where the password value can also be an empty string. Password locked PEM certificates are not supported. |
| Test Connection | Test the connectivity to the selected azure service using the authentication credentials provided. Note! The application (Client ID) needs to be configured with roles that have write access in order for the connection test to be successful. However during runtime, the agent will work as expected if the proper permissions are granted, whether it is configured through Role Based Access Control (IAM) or Access Control List (ACL). Note! The certificate path must point to a certificate located in the Platform in order for the connection test to be successful. However during runtime, the certificate path must point to a certificate located in the EC. |
Configuration - Advanced Tab
The following settings are available in the Advanced Tab for both Azure Data Lake Storage and Azure Event Hub applications in the Azure profile.
Azure profile - Advanced Tab
| Setting | Description |
|---|---|
| Authority Host | Enter the URL for the directory that Microsoft Authentication Library will request tokens from. If this is not entered, the following default values will be used accordingly:
|
| API Endpoint | Enter the API endpoint in Azure to be used for accessing and managing the services. If this is not entered, the the following default values will be used accordingly:
|
Info!
To find out more about the configuration for both authority and endpoints, refer to https://docs.microsoft.com/en-us/azure/active-directory/develop/authentication-national-cloud#azure-ad-authentication-endpoints and https://docs.microsoft.com/en-us/azure/azure-government/compare-azure-government-global-azure.