Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2 KB

plugin-azure-key-vault.adoc

File metadata and controls

51 lines (37 loc) · 2 KB

Azure Key Vault Plugin

The plugin provides functionality to interact with Azure Key Vault.

Key Vault management

Steps

Retrieve the Key Vault properties

Warning

The step is deprecated and will be removed in VIVIDUS 0.6.0. The replacement is the generic step retrieving information about Azure resources. The replacement pattern is:

When I get Azure resource with identifier `resourceGroups/<resourceGroupName>/providers/Microsoft.KeyVault/vaults/<keyVaultName>` using API version `2021-10-01` and save it to <scopes> variable `<variableName>`

Retrieves the properties of the specified Azure key vault and saves them as JSON to a variable. For more information, see the Azure Docs.

When I retrieve properties of key vault with name `$keyVaultName` from resource group `$resourceGroupName` and save them as JSON to $scopes variable `$variableName`
  • $keyVaultName - The name of the key vault within the specified resource group.

  • $resourceGroupName - The name of the resource group within the user’s subscription to retrieve the key vault from. The name is case-insensitive.

  • $scopes - The comma-separated set of the variables scopes.

  • $variableName - The variable name to store the key vault properties as JSON.

Retrieve the Key Vault properties
When I retrieve properties of key vault with name `KEY-VAULT-NAME` from resource group `TEST-SA` and save them as JSON to scenario variable `key-vault-properties`