Skip to content

cli-work-with-keys.md

Latest commit

 

History

History
90 lines (64 loc) · 2.96 KB

cli-work-with-keys.md

File metadata and controls

90 lines (64 loc) · 2.96 KB
title Azure CLI Script Sample - Work with key-values in App Configuration Store
titleSuffix Azure App Configuration
description Use Azure CLI script to create, view, update and delete key-values from App Configuration store
services azure-app-configuration
author maud-lv
ms.service azure-app-configuration
ms.devlang azurecli
ms.topic sample
ms.date 04/12/2024
ms.author malev
ms.custom devx-track-azurecli

Work with key-values in an Azure App Configuration store

This sample script shows how to:

  • Create a new key-value pair
  • List all existing key-value pairs
  • Update the value of a newly created key
  • Delete the new key-value pair

[!INCLUDE quickstarts-free-trial-note]

[!INCLUDE azure-cli-prepare-your-environment.md]

  • This tutorial requires version 2.0 or later of the Azure CLI. If using Azure Cloud Shell, the latest version is already installed.

Sample script

#!/bin/bash

appConfigName=myTestAppConfigStore
newKey="TestKey"
refKey="KeyVaultReferenceTestKey"
uri="[URL to value stored in Key Vault]"
uri2="[URL to another value stored in Key Vault]"

# Create a new key-value 
az appconfig kv set --name $appConfigName --key $newKey --value "Value 1"

# List current key-values
az appconfig kv list --name $appConfigName

# Update new key's value
az appconfig kv set --name $appConfigName --key $newKey --value "Value 2"

# List current key-values
az appconfig kv list --name $appConfigName

# Create a new key-value referencing a value stored in Azure Key Vault
az appconfig kv set-keyvault  --name $appConfigName --key $refKey --secret-identifier $uri

# List current key-values
az appconfig kv list --name $appConfigName

# Update Key Vault reference
az appconfig kv set-keyvault --name $appConfigName --key $refKey --secret-identifier $uri2

# List current key-values
az appconfig kv list --name $appConfigName

# Delete new key
az appconfig kv delete  --name $appConfigName --key $newKey

# Delete Key Vault reference
az appconfig kv delete --name $appConfigName --key $refKey

# List current key-values
az appconfig kv list --name $appConfigName

[!INCLUDE cli-script-cleanup]

Script explanation

This table lists the commands used in our sample script.

Command Notes
az appconfig kv set Create or update a key-value pair.
az appconfig kv list List key-value pairs in an App Configuration store.
az appconfig kv delete Delete a key-value pair.

Next steps

For more information on the Azure CLI, see Azure CLI documentation.

Additional App Configuration CLI script samples can be found in the Azure App Configuration CLI samples.