Azure Key Vault Properties Provider 2.0 Reference - Mule 4
Azure Key Vault Properties Provider is a configuration that enables you to retrieve your secrets from a secure Azure cloud service before your Mule app runs.
Configuration
Default Configuration for Azure Key Vault Properties Provider.
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Client Id |
String |
Client ID of your app. |
x |
|
Tenant Id |
String |
Tenant ID of your app. |
x |
|
Client Secret |
String |
Client secret of your app. |
x |
|
Key Vault Name |
String |
Name of the vault that you want to connect. |
x |
|
Uri Override |
String |
The URI override for the key vault. |
Requirements
You must add the following repository and its associated credentials in the Maven settings:
<repository>
<id>MuleRepository2</id>
<name>MuleRepository2</name>
<url>https://repository.mulesoft.org/nexus/content/repositories/releases-ee/</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>Limitations
Azure Key Vault Properties Provider doesn’t support the use of property files for the configuration of the properties provider.
Environment Variables
For authenticating to Azure Key Vault using environment variables, set the following environment variables AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, and AZURE_TENANT_ID. Refer to Setting Environment Variables for details.
After setting the environment variables, in the XML connector configuration, set the following attributes with an empty string: tenantId="", clientId="", and clientSecret="".
In the XML configuration, the attributes look like these:
<azure-key-vault-properties-provider:config name="Azure_Key_Vault_Properties_Provider_Config"
keyVaultName="connectors-vault"
tenantId=""
clientId=""
clientSecret=""/>