Quickstart: Set and retrieve a secret from Azure Key Vault using Azure CLI
In this quickstart, you create a key vault in Azure Key Vault with Azure CLI. Azure Key Vault is a cloud service that works as a secure secrets store. You can securely store keys, passwords, certificates, and other secrets. For more information on Key Vault you may review the Overview. Azure CLI is used to create and manage Azure resources using commands or scripts. Once that you have completed that, you will store a secret.
If you don't have an Azure subscription, create a free account before you begin.
Use Azure Cloud Shell
Azure hosts Azure Cloud Shell, an interactive shell environment that you can use through your browser. You can use either Bash or PowerShell with Cloud Shell to work with Azure services. You can use the Cloud Shell preinstalled commands to run the code in this article without having to install anything on your local environment.
To start Azure Cloud Shell:
|Select Try It in the upper-right corner of a code block. Selecting Try It doesn't automatically copy the code to Cloud Shell.|
|Go to https://shell.azure.com, or select the Launch Cloud Shell button to open Cloud Shell in your browser.|
|Select the Cloud Shell button on the top-right menu bar in the Azure portal.|
To run the code in this article in Azure Cloud Shell:
Start Cloud Shell.
Select the Copy button on a code block to copy the code.
Paste the code into the Cloud Shell session by selecting Ctrl+Shift+V on Windows and Linux or by selecting Cmd+Shift+V on macOS.
Select Enter to run the code.
If you choose to install and use the CLI locally, this quickstart requires the Azure CLI version 2.0.4 or later. Run
az --version to find the version. If you need to install or upgrade, see Install the Azure CLI.
To sign in to Azure using the CLI you can type:
For more information on login options via the CLI take a look at sign in with Azure CLI
Create a resource group
A resource group is a logical container into which Azure resources are deployed and managed. The following example creates a resource group named ContosoResourceGroup in the eastus location.
az group create --name "ContosoResourceGroup" --location eastus
Create a Key Vault
Next you will create a Key Vault in the resource group created in the previous step. You will need to provide some information:
- For this quickstart we use Contoso-vault2. You must provide a unique name in your testing.
- Resource group name ContosoResourceGroup.
- The location East US.
az keyvault create --name "Contoso-Vault2" --resource-group "ContosoResourceGroup" --location eastus
The output of this cmdlet shows properties of the newly created Key Vault. Take note of the two properties listed below:
- Vault Name: In the example, this is Contoso-Vault2. You will use this name for other Key Vault commands.
- Vault URI: In the example, this is https://contoso-vault2.vault.azure.net/. Applications that use your vault through its REST API must use this URI.
At this point, your Azure account is the only one authorized to perform any operations on this new vault.
Add a secret to Key Vault
To add a secret to the vault, you just need to take a couple of additional steps. This password could be used by an application. The password will be called ExamplePassword and will store the value of hVFkk965BuUv in it.
Type the commands below to create a secret in Key Vault called ExamplePassword that will store the value hVFkk965BuUv :
az keyvault secret set --vault-name "Contoso-Vault2" --name "ExamplePassword" --value "hVFkk965BuUv"
You can now reference this password that you added to Azure Key Vault by using its URI. Use https://ContosoVault.vault.azure.net/secrets/ExamplePassword to get the current version.
To view the value contained in the secret as plain text:
az keyvault secret show --name "ExamplePassword" --vault-name "Contoso-Vault2"
Now, you have created a Key Vault, stored a secret, and retrieved it.
Clean up resources
Other quickstarts and tutorials in this collection build upon this quickstart. If you plan to continue on to work with subsequent quickstarts and tutorials, you may wish to leave these resources in place. When no longer needed, you can use the az group delete command to remove the resource group, and all related resources. You can delete the resources as follows:
az group delete --name ContosoResourceGroup
In this quickstart you created a Key Vault and stored a secret in it. To learn more about Key Vault and how to integrate it with your applications, continue on to the articles below.