Azure Key Vault

Retrieve secrets from Azure Key Vault.

Examples

azure_key_vault_config.yaml

vault:
  azure_key_vault:
    vault_name: my-vault-name

azure_key_vault_retrieve_secret.yaml

vault:
  azure_key_vault:
    vault_name: my-vault-name

azure_key_vault_setup.yaml

vault:
  azure_key_vault:
    vault_name: my-vault-name

AzureKeyVault

info

AzureKeyVault is defined beneath the following ancestor nodes in the YAML structure:

• Vault

Below are the properties for the AzureKeyVault. Each property links to the specific details section further down in this page.

Property	Default	Type	Required	Description
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
name		string	Yes	The name of the model
azure_key_vault		AzureKeyVaultOptions	Yes

Property Details

Vault

A way of storing secrets for use in your project and associating it with the desired service account

Property	Default	Type	Required	Description
vault		One of:   EnvironmentVariablesVault   LocalFileVault   CredstashVault   GcpSecretManagerVault   AwsSecretsManagerVault   AzureKeyVault   AscendEnvironmentVault	Yes

AzureKeyVaultOptions

Options for reading secrets from Azure Key Vault.

Property	Default	Type	Required	Description
vault_name		string	Yes	The name of the Azure Key Vault. Used to generate the vault URL.

ResourceMetadata

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.