Azure Key Vault
- 05 Sep 2023
- 1 Minute to read
- Print
- DarkLight
Azure Key Vault
- Updated on 05 Sep 2023
- 1 Minute to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
| Step Details | |
| Introduced in Version | 5.15 |
| Last Modified in Version | - |
| Location | Integration > Azure Key Vault. |
Azure Key Vault is a cloud service that securely stores and manages sensitive information such as keys, secrets, and certificates. Integrating the application with Azure Key Vault allows the retrieval of these sensitive data securely.
Currently, there are 2 steps under the Azure Key Vault:
| Sr. No. | Step Name | Description |
|---|---|---|
| 1 | Get Secret Value | The "Get Secret Value" step retrieves a secret value from Azure Key Vault. Secrets stored in Azure Key Vault can include connection strings, API keys, or any other sensitive information. |
| 2 | Get Secret Value Async | The "Get Secret Value Async" step is similar to the "Get Secret Value" step but operates asynchronously. This means it retrieves the secret value from Azure Key Vault without blocking the primary Flow or process it is used in. |
Prerequisites
- This step requires the Azure Services module to be installed before it will be available in the toolbox.
- Admin users must configure an Environment Variable for "AzureServicesAuthConnectionString" at the System level. This configuration ensures seamless access to Azure services, including Azure Key Vault.
Properties
Inputs
| Property | Description | Data Type |
|---|---|---|
| Key Vault Name | This setting specifies the name of the Azure Key Vault from which you want to retrieve the secret. You must provide the exact name of the Azure Key Vault that contains the secret you wish to access. | String |
| Secret Name | Identifies the specific secret you want to retrieve from the Azure Key Vault. Enter the secret's name as it's stored in Azure Key Vault. Ensure the secret exists within the specified vault. | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| SecretValue | The retrieved secret value from the Azure Key Vault. | String |
Common Errors
- Error: Error running step Get Secret Value 1[GetSecretValue] in Flow [FlowName]: Exception invoking method GetSecretValue on class AzureKeyVaultAccessor.
Solution: The following error occurs if the connection string for Azure Key Vault is missing or improperly configured. Ensure the correct Azure Key Vault connection string is specified at the System level.
Related Information
Articles:
Was this article helpful?
