AzureKeyVault (version 1.0.0)

key_vault: Azure Key Vault client

Description

Azure Key Vault client

Usage

key_vault(url, tenant = "common", app = .az_cli_app_id, ...,
  domain = "vault.azure.net", token = NULL)

Arguments

url

The location of the vault. This can be a full URL, or the vault name alone; in the latter case, the domain argument is appended to obtain the URL.

tenant, app, ...

Authentication arguments that will be passed to AzureAuth::get_azure_token. The default is to authenticate interactively.

domain

The domain of the vault; for the public Azure cloud, this is vault.azure.net. Also the resource for OAuth authentication.

token

An OAuth token obtained via AzureAuth::get_azure_token. If provided, this overrides the other authentication arguments.

Details

This function creates a new Key Vault client object. It includes the following component objects for working with data in the vault:

  • keys: A sub-object for working with encryption keys stored in the vault. See keys.

  • secrets: A sub-object for working with secrets stored in the vault. See secrets.

  • certificates: A sub-object for working with certificates stored in the vault. See certificates.

  • storage: A sub-object for working with storage accounts managed by the vault. See storage.

See Also

keys, secrets, certificates, storage

Azure Key Vault documentation, Azure Key Vault API reference

Examples

Run this code
# NOT RUN {
key_vault("mykeyvault")
key_vault("https://mykeyvault.vault.azure.net")

# authenticating as a service principal
key_vault("mykeyvault", tenant="myaadtenant", app="app_id", password="password")

# authenticating with an existing token
token <- AzureAuth::get_azure_token("https://vault.azure.net", "myaadtenant",
                                    app="app_id", password="password")
key_vault("mykeyvault", token=token)

# }

Run the code above in your browser using DataCamp Workspace