The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Azure Key Vault Plugin

View this plugin on the Plugins site

azureKeyVault: azureKeyVault

  • secrets
      Array / List of Nested Object
    • secretType : String
      Key Vault supports two types of secrets
      • Secrets are passwords or any arbitrary text
      • Certificates are X.509 certificates in PKCS12 format (PFX)
    • name : String
      Name of the secret to retrieve from Key Vault
    • envVariable : String
      Environment Variable to which the secret will be assigned
      • For secrets, the variable will contain the value of the secret
      • For certificates, the variable will contain the path to the certificate in pkcs12 format
    • version : String (optional)
      Version of the secret to retrieve from Key Vault
  • credentialID : String (optional)
    Specify the Credential ID used for accessing Key Vault.
    • Must be a Azure Service Principal or Azure Managed Identity
  • keyVaultURL : String (optional)
    OPTIONAL: Override the globally configured Key Vault URL (e.g. https://YOURKEYVAULT.vault.azure.net)

withAzureKeyvault: Bind credentials in Azure Key Vault to variables

  • azureKeyVaultSecrets
      Array / List of Nested Object
    • secretType : String
      Key Vault supports two types of secrets
      • Secrets are passwords or any arbitrary text
      • Certificates are X.509 certificates in PKCS12 format (PFX)
    • name : String
      Name of the secret to retrieve from Key Vault
    • envVariable : String
      Environment Variable to which the secret will be assigned
      • For secrets, the variable will contain the value of the secret
      • For certificates, the variable will contain the path to the certificate in pkcs12 format
    • version : String (optional)
      Version of the secret to retrieve from Key Vault
  • applicationIDOverride : String (optional)
    OPTIONAL: Override the configured application ID to access Key Vault.
  • applicationSecretOverride : String (optional)
    OPTIONAL: Set an Application Secret directly
    It is recommended to use the CredentialID field instead.
  • credentialIDOverride : String (optional)
    Specify the Credential ID used for accessing Key Vault.
    • Must be a Azure Service Principal or Azure Managed Identity
  • keyVaultURLOverride : String (optional)
    OPTIONAL: Override the configured Key Vault URL (e.g. https://YOURKEYVAULT.vault.azure.net)
  • tenantIdOverride : String (optional)
    Override the tenantId, only used if you're explicitly providing an override client ID and secret.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.