Create registered application
You must create a Azure Active Directory (AAD) application and grant it the desired access permissions, such as read/write access to the ADLS resource and read/write access to the Azure Key Vault secrets .
This service principal is used by the for access to all Azure resources. For more information, see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal.
After you have registered, acquire the following information:
Acquire this value from the Registered app blade of the Azure Portal.
|Service User Key|
Create a key for the Registered app in the Azure Portal.
NOTE: If you are using Azure AD to integrate with an Azure Databricks cluster, the Azure AD secret value stored in
azure.secret must begin with an alphanumeric character. This is a known issue.
|Directory ID||Copy the Directory ID from the Properties blade of Azure Active Directory.|
These properties are applied later in the configuration process.
Configure the Platform
Configure for HDI
If you are integrating the with a pre-existing HDI cluster, additional configuration is required. See Configure for HDInsight.
NOTE: If you created a new HDI cluster as part of the installation, all required is listed below.
Configure for Azure Databricks
Optionally, you can integrate the with Azure Databricks, instead of HDI.
For more information, see Configure for Azure Databricks.
Configure base storage layer
For Azure installations, you can set your base storage layer to be HDFS or WASB.
NOTE: The base storage layer must be set after installation. After it has been configured, it cannot be modified.
|Azure storage||webapp.storageProtocol setting||hdfs.protocolOverride setting|
See Set Base Storage Layer.
Configure for Key Vault
For authentication purposes, the must be integrated with an Azure Key Vault keystore. For more information, see https://azure.microsoft.com/en-us/services/key-vault/.
Please complete the following sections to create and configure your Azure Key Vault.
Create a Key Vault resource in Azure
- Log into the Azure portal.
- Goto: https://portal.azure.com/#create/Microsoft.KeyVault
- Complete the form for creating a new Key Vault resource:
Name: Provide a reasonable name for the resource. Example:
| Code Block|
- Location: Pick the location used by the HDI cluster.
- For other fields, add appropriate information based on your enterprise's preferences.
- To create the resource, click Create.
Enable Key Vault access for the
In the Azure portal, you must assign access policies for application principal of the
to access the Key Vault.
| D s item|
- In the Azure portal, select the Key Vault you created. Then, select Access Policies.
- In the Access Policies window, select the
| D s item|
- Click Add New.
- For Secret permissions, select the following:
- Do not select any other options.
- Click OK.
Create WASB access token
If you are enabling access to WASB, you must create this token within the Azure Portal.
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/delegating-access-with-a-shared-access-signature.
You must specify the storage protocol ( .
wasbs ) used by the
Configure Key Vault key and secret for WASB
In the Key Vault, you can create key and secret pairs for use.
|Base Storage Layer||Description|
creates its own key-secret combinations in the Key Vault. No additional configuration is required.
Please skip this section and populate the Key Vault URL into the
|WASB||For WASB, you must create key and secret values that match other values in your Azure configuration. Instructions are below.|
WASB: To enable access to the Key Vault, you must specify your key and secret values as follows:
The value of the key must be specified as the
sasTokenId in the
The value of the secret should match the shared access signature for your storage. This value is specified as
sasToken in the
Acquire shared access signature value:
In the Azure portal, please do the following:
- Open your storage account.
- Select Shared Access Signature .
- Generate or view existing signatures.
- For a new or existing signature, copy the SAS token value. Omit the leading question mark (?).
- Paste this value into a text file for safekeeping.
Create a custom key:
To create a custom key and secret pair for WASB use by the , please complete the following steps:
- On an existing or newly created Azure Key Vault resource, click Secrets.
- At the top of the menu, click Generate/Import.
- In the Create a secret menu:
- Select Manual for upload options.
Chose an appropriate name for the key.
NOTE: Please retain the name of the key for later use, when it is applied through the as the
sasTokenId value. Instructions are provided later.
- Paste the SAS token value for the key into the secret field.
- Click Create.
Configure Key Vault location
For ADLS or WASB, the location of the Azure Key Vault must be specified for the . The location can be found in the properties section of the Key Vault resource in the Azure portal.
- Log in to the Azure portal.
- Select the Key Vault resource.
- Click Properties.
- Locate the DNS Name field. Copy the field value.
This value is the location for the Key Vault. It must be applied in the .
Specify the URL in the following parameter:
| Code Block|
"azure.keyVaultURL": "<your key value URL>",
Apply SAS token identifier for WASB
If you are using WASB as your base storage layer, you must apply the SAS token value into the configuration of the .
Paste the value of the SAS Token for the key you created in the Key Vault as the following value:
| Code Block|
"azure.wasb.defaultStore.sasTokenId": "<your Sas Token Id>",
- Save your changes.
Configure Secure Token Service
Access to the Key Vault requires use of the secure token service (STS) from the . To use STS with Azure, the following properties must be specified.
NOTE: Except in rare cases, the other properties for secure token service do not need to be modified.
|" secure-token-service .autorestart"|
Set this value to
true to enable auto-restarting of the secure token service.
|"secure-token-service.port"||Set this value to |
Enter a base64 string to serve as your encryption key for the refresh token of the secure token service.
A default encryption key is inserted for you.
NOTE: If a valid base64 string value is not provided here, the platform fails to start.
|"secure-token-service.userIdHashingPepper"||Enter a base64 string.|
If needed, you can integrate the with Azure AD for Single-Sign On to the platform. See Configure SSO for Azure AD.
Configure for ADLS
Enable read-only or read-write access to ADLS. For more information, see Enable ADLS Access.
Configure for WASB
Enable read-only or read-write access to WASB. For more information on integrating with WASB, see Enable WASB Access.
Configure relational connections
If you are integrating with relational datastores, please complete the following configuration sections.
Create encryption key file
An encryption key file must be created on the . This key file is shared across all relational connections. See Create Encryption Key File.
Create Hive connection
You can create a connection to the Hive instance on the HDI cluster with some modifications.
- High Availability: Natively, Azure supports high availability for HiveServer2 via Zookeeper. Host and port information in the JDBC URL must be replaced with a Zookeeper quorum.
In addition to the other Hive connection properties, please specify the following values for the properties listed below:
Use your Zookeeper quorum value. For the final node of the list, omit the port number. Example:
| Code Block|
|Port||Set this value to |
|Connect String options|
In addition to any options required for your environment, include the following option:
| Code Block|
|Database||Enter your Hive database name.|
Connections are created through the Connections page. See Connections Page.
For additional details on creating a connection to Hive, see Create Hive Connections.
A Hive connection can also be created using the above property substitutions via programmatic methods.
Create Azure SQL Database connection
For more information, see Create Azure SQL Database Connections.
Create Azure SQL DW connection
For more information, see Create SQL DW Connections.