Set up an Azure Key Vault connection
Before you begin:
- You have network access to your Azure Key Vault instance.
- You have the required Azure credentials: a client secret, a client certificate, or a Precisely Agent secret key depending on your chosen authentication method.
- You have your Azure Tenant ID and Client ID available.
- Go to .
-
Select Add Key Vault and fill in the following details:
Table 1. Azure Key Vault Configuration Fields Field Description Key vault name A name that reflects the vault's purpose or environment. Description A summary of the key vault's role or scope to clarify its usage. Key vault type Select Azure Vault from the dropdown list. Host URL The URL of your Azure Key Vault instance. Data Integrity Suite uses this address to connect and retrieve credentials. Authentication method The method used to authenticate with Azure Key Vault. Choose one of the following:
-
Client Secret: Authenticates using an Azure Active Directory application identity with a client secret. Commonly used in automated environments and service-to-service integrations.
- Tenant ID: The unique identifier of your Azure Active Directory tenant.
- Client ID: The application (client) ID registered in Azure Active Directory.
- Client Secret: The secret value associated with the Azure Active Directory application registration.
-
Client Certificate: Authenticates using a certificate instead of a secret, providing stronger security for environments that require certificate-based identity verification.
- Tenant ID: The unique identifier of your Azure Active Directory tenant.
- Client ID: The application (client) ID registered in Azure Active Directory.
- Client Certificate: The certificate content used for authentication.
-
Precisely Agent: A secure intermediary that retrieves credentials from the vault when direct access is not available. Commonly used in on-premises or hybrid environments where Data Integrity Suite cannot connect to Azure Key Vault directly.
- Agent secret key: The key name used by the agent to locate and retrieve the correct secret. This value must exactly match the key name deployed using the DISCLI command. See Install Azure vault agent secret.
- Test agent: Select an agent from the dropdown list to test the connection. This selection is only used for testing and is not stored.
Tenant ID The unique identifier of your Azure Active Directory tenant. Required for all authentication methods. Client ID The application (client) ID of the Azure Active Directory app registration used to access the vault. Required for all authentication methods. -
- If you selected Precisely Agent as the authentication method, install the agent secret before proceeding. See Install Azure vault agent secret.
- Select Test to validate the configuration.
- Once the test succeeds, select Add to complete the key vault setup.
The Azure Key Vault connection is now configured and ready to use with shared connections.
Install Azure vault agent secret
The agent secret is required when using Precisely Agent authentication. Configure it using one of the available methods before completing your key vault setup.
Before you begin:
- You have network access to your Azure Key Vault instance.
- You can run DISCLI commands.
- You have the appropriate Azure credentials: client secret, client certificate, or secret file depending on your chosen authentication method.
- You have your Azure Tenant ID and Client ID available.
- If you are installing the agent for the first time, no additional steps are required. To install the agent, see Install and download agent.
-
If the agent is already installed in your environment, run the following command to turn on the key vault agent secret feature:
./discli updateCli -
After the update completes, configure the vault agent secret using one of the following methods. Replace variables in angle brackets (
< >) with your own values. Do not include the brackets when running commands.Option 1: Client Secret authentication
./discli keyvault deploySecret \ --agent-secret-key <agent secret key> \ --url <hostUrl> \ --vault-type azure \ --authentication-method clientsecret \ --tenant-id <tenant-id> \ --client-id <client-id> \ --client-secret <client-secret>Option 2: Client Certificate authentication
./discli keyvault deploySecret \ --agent-secret-key <agent secret key> \ --url <hostUrl> \ --vault-type azure \ --authentication-method clientcertificate \ --tenant-id <tenant-id> \ --client-id <client-id> \ --tls-cert-file <cert pem file>Option 3: Secret file
./discli keyvault deploySecret \ --agent-secret-key <agent secret key> \ --agent-secret-file <agentSecretFile.json>The JSON file must follow one of these formats:
For Client Secret authentication:
{ "hostname": "<host url>", "authenticationMethod": "clientsecret", "tenantId": "<tenant-id>", "clientId": "<client-id>", "clientSecret": "<client-secret>", "vaultType": "azure" }For Client Certificate authentication:
{ "hostname": "<host url>", "authenticationMethod": "clientcertificate", "tenantId": "<tenant-id>", "clientId": "<client-id>", "tlsCertificate": "<certificate content>", "vaultType": "azure" } -
Verify the agent secret was installed correctly by running:
./discli keyvault deploySecret --listkeysThis command lists all keys available across namespaces. Look for the key name under your relevant namespace. Example output:
Listing keys in 'precisely-keyvault-secret' azureclientsecret SUCCESS: Total keys: 1The key name (for example,
azureclientsecret) must exactly match the value you configure as Agent secret key in the UI key vault connection. -
If no keys are found, the output shows:
INFO: Secret 'precisely-keyvault-secret' missing in <namespace>This indicates that no keys have been deployed. Run the deployment command again with the correct values.
-
To explore additional options for this command, run:
./discli keyvault deploySecret --help
The agent secret is installed and ready to use. Return to the Add Key Vault page, enter the agent secret key you created, and complete the key vault setup.