Azure Key Vault API

List of Functions

vault_get_secret(scope, key[, databricks])	Get a secret from an Azure Key Vault
_vault_set_dbutils(dbutils_var)	Allows the vault functions to use the dbutils variable
_is_running_on_devops_pipeline()	Tests if a script is running on an Azure DevOps pipeline
_is_running_on_databricks()	Tests if a script is running locally or on Databricks

Definition of Functions

aio.vault_get_secret(scope: str, key: str, databricks=None) → str

Get a secret from an Azure Key Vault

This function takes a secret by using either Databricks dbutils or Azure Python API libraries

Parameters

scopestr

The scope used to get the key. If the function is running on Databricks, it is a Databricks Secret Scope, otherwise it is an Azure Key Vault name.

keystr

The name of the secret in a Databricks Secret Scope or Azure Key Vault

Returns

str

Returns the secret as a string

aio._vault_set_dbutils(dbutils_var: str)

Allows the vault functions to use the dbutils variable

Parameters

dbutils_var

dbutils variable from Databricks should be passed here

This function sets the variable ``dbutils`` to be used when running Databricks scripts.

aio._is_running_on_devops_pipeline()

Tests if a script is running on an Azure DevOps pipeline

Returns

resbool

True, if program is running on an Azure DevOps pipeline, False otherwise.

aio._is_running_on_databricks()

Tests if a script is running locally or on Databricks

Returns

resbool

True, if program is running on Databricks, False otherwise.

AIO Supply Chain Analytics Read and Write