AzureKeyVault (version 1.0.0)

secrets: Stored secrets in Key Vault

Description

This class represents the collection of secrets stored in a vault. It provides methods for managing secrets, including creating, importing and deleting secrets, and doing backups and restores.

Value

For get, and create, an object of class stored_secret, representing the secret. The actual value of the secret is in the value field.

For list, a vector of secret names.

For backup, a string representing the backup blob for a secret. If the secret has multiple versions, the blob will contain all versions.

Methods

This class provides the following methods:

create(name, value, content_type=NULL, attributes=vault_object_attrs(), ...)
get(name)
delete(name, confirm=TRUE)
list(include_managed=FALSE)
backup(name)
restore(backup)

Arguments

• name: The name of the secret.

• value: For create, the secret to store. This should be a character string or a raw vector.

• content_type: For create, an optional content type of the secret, such as "application/octet-stream".

• attributes: Optional attributes for the secret, such as the expiry date and activation date. A convenient way to provide this is via the vault_object_attrs helper function.

• ...: For create, other named arguments which will be treated as tags.

• include_managed: For list, whether to include secrets that were created by Key Vault to support a managed certificate.

• backup: For restore, a string representing the backup blob for a secret.

See Also

vault_object_attrs

Azure Key Vault documentation, Azure Key Vault API reference

Examples

# NOT RUN {
vault <- key_vault("mykeyvault")

vault$secrets$create("mysecret", "secret string")

vault$secrets$list()

secret <- vault$secrets$get("mysecret")
secret$value  # 'secret string'

# specifying an expiry date
today <- Sys.date()
vault$secrets$create("mysecret", attributes=vault_object_attrs(expiry_date=today+365))

# setting management tags
vault$secrets$create("mysecret", tag1="a value", othertag="another value")

# }

Run the code above in your browser using DataCamp Workspace