Key Values - Create Or Update

Service:

App Configuration

API Version:

2024-05-01

Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
configStoreName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9_-]*$	The name of the configuration store.
keyValueName	path	True	string	Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
resourceGroupName	path	True	string	The name of the resource group to which the container registry belongs.
subscriptionId	path	True	string	The Microsoft Azure subscription ID.
api-version	query	True	string	The client API version.

Request Body

Name	Type	Description
properties.contentType	string	The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.
properties.tags	object	A dictionary of tags that can help identify what a key-value may be applicable for.
properties.value	string	The value of the key-value.

Responses

Name	Type	Description
200 OK	KeyValue	The request was successful; the request was well-formed and received properly.
Other Status Codes	ErrorResponse	Error response describing why the operation failed

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

KeyValues_CreateOrUpdate

Sample request

HTTP

PUT https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/keyValues/myKey$myLabel?api-version=2024-05-01

{
  "properties": {
    "value": "myValue",
    "tags": {
      "tag1": "tagValue1",
      "tag2": "tagValue2"
    }
  }
}

Java

import java.util.HashMap;
import java.util.Map;

/**
 * Samples for KeyValues CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-05-01/examples/
     * ConfigurationStoresCreateKeyValue.json
     */
    /**
     * Sample code: KeyValues_CreateOrUpdate.
     * 
     * @param manager Entry point to AppConfigurationManager.
     */
    public static void
        keyValuesCreateOrUpdate(com.azure.resourcemanager.appconfiguration.AppConfigurationManager manager) {
        manager.keyValues().define("myKey$myLabel").withExistingConfigurationStore("myResourceGroup", "contoso")
            .withTags(mapOf("tag1", "tagValue1", "tag2", "tagValue2")).withValue("myValue").create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appconfiguration import AppConfigurationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appconfiguration
# USAGE
    python configuration_stores_create_key_value.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AppConfigurationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="c80fb759-c965-4c6a-9110-9b2b2d038882",
    )

    response = client.key_values.create_or_update(
        resource_group_name="myResourceGroup",
        config_store_name="contoso",
        key_value_name="myKey$myLabel",
    )
    print(response)


# x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-05-01/examples/ConfigurationStoresCreateKeyValue.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappconfiguration_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appconfiguration/armappconfiguration/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d477c7caa09bf82e22c419be0a99d170552b5892/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-05-01/examples/ConfigurationStoresCreateKeyValue.json
func ExampleKeyValuesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappconfiguration.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewKeyValuesClient().CreateOrUpdate(ctx, "myResourceGroup", "contoso", "myKey$myLabel", &armappconfiguration.KeyValuesClientCreateOrUpdateOptions{KeyValueParameters: &armappconfiguration.KeyValue{
		Properties: &armappconfiguration.KeyValueProperties{
			Tags: map[string]*string{
				"tag1": to.Ptr("tagValue1"),
				"tag2": to.Ptr("tagValue2"),
			},
			Value: to.Ptr("myValue"),
		},
	},
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.KeyValue = armappconfiguration.KeyValue{
	// 	Name: to.Ptr("myKey$myLabel"),
	// 	Type: to.Ptr("Microsoft.AppConfiguration/configurationStores/keyValues"),
	// 	ID: to.Ptr("/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/keyValues/myKey$myLabel"),
	// 	Properties: &armappconfiguration.KeyValueProperties{
	// 		ContentType: to.Ptr(""),
	// 		ETag: to.Ptr("IhDxoa8VkXxPsYsemBlxvV0d5fp"),
	// 		Key: to.Ptr("myKey"),
	// 		Label: to.Ptr("myLabel"),
	// 		LastModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:42:24.000Z"); return t}()),
	// 		Locked: to.Ptr(false),
	// 		Tags: map[string]*string{
	// 			"tag1": to.Ptr("tagValue1"),
	// 			"tag2": to.Ptr("tagValue2"),
	// 		},
	// 		Value: to.Ptr("myValue"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AppConfigurationManagementClient } = require("@azure/arm-appconfiguration");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
 *
 * @summary Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.
 * x-ms-original-file: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-05-01/examples/ConfigurationStoresCreateKeyValue.json
 */
async function keyValuesCreateOrUpdate() {
  const subscriptionId =
    process.env["APPCONFIGURATION_SUBSCRIPTION_ID"] || "c80fb759-c965-4c6a-9110-9b2b2d038882";
  const resourceGroupName = process.env["APPCONFIGURATION_RESOURCE_GROUP"] || "myResourceGroup";
  const configStoreName = "contoso";
  const keyValueName = "myKey$myLabel";
  const keyValueParameters = {
    tags: { tag1: "tagValue1", tag2: "tagValue2" },
    value: "myValue",
  };
  const options = { keyValueParameters };
  const credential = new DefaultAzureCredential();
  const client = new AppConfigurationManagementClient(credential, subscriptionId);
  const result = await client.keyValues.createOrUpdate(
    resourceGroupName,
    configStoreName,
    keyValueName,
    options,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppConfiguration;

// Generated from example definition: specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2024-05-01/examples/ConfigurationStoresCreateKeyValue.json
// this example is just showing the usage of "KeyValues_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this AppConfigurationStoreResource created on azure
// for more information of creating AppConfigurationStoreResource, please refer to the document of AppConfigurationStoreResource
string subscriptionId = "c80fb759-c965-4c6a-9110-9b2b2d038882";
string resourceGroupName = "myResourceGroup";
string configStoreName = "contoso";
ResourceIdentifier appConfigurationStoreResourceId = AppConfigurationStoreResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, configStoreName);
AppConfigurationStoreResource appConfigurationStore = client.GetAppConfigurationStoreResource(appConfigurationStoreResourceId);

// get the collection of this AppConfigurationKeyValueResource
AppConfigurationKeyValueCollection collection = appConfigurationStore.GetAppConfigurationKeyValues();

// invoke the operation
string keyValueName = "myKey$myLabel";
AppConfigurationKeyValueData data = new AppConfigurationKeyValueData
{
    Value = "myValue",
    Tags =
    {
    ["tag1"] = "tagValue1",
    ["tag2"] = "tagValue2"
    },
};
ArmOperation<AppConfigurationKeyValueResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, keyValueName, data);
AppConfigurationKeyValueResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppConfigurationKeyValueData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "type": "Microsoft.AppConfiguration/configurationStores/keyValues",
  "properties": {
    "key": "myKey",
    "label": "myLabel",
    "value": "myValue",
    "contentType": "",
    "eTag": "IhDxoa8VkXxPsYsemBlxvV0d5fp",
    "lastModified": "2020-06-23T06:42:24+00:00",
    "locked": false,
    "tags": {
      "tag1": "tagValue1",
      "tag2": "tagValue2"
    }
  },
  "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/keyValues/myKey$myLabel",
  "name": "myKey$myLabel"
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
KeyValue	The key-value resource along with all resource properties.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetails

Object

The details of the error.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Object

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
error	ErrorDetails	The details of the error.

KeyValue

Object

The key-value resource along with all resource properties.

Name	Type	Description
id	string	The resource ID.
name	string	The name of the resource.
properties.contentType	string	The content type of the key-value's value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.
properties.eTag	string	An ETag indicating the state of a key-value within a configuration store.
properties.key	string	The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
properties.label	string	A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
properties.lastModified	string (date-time)	The last time a modifying operation was performed on the given key-value.
properties.locked	boolean	A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
properties.tags	object	A dictionary of tags that can help identify what a key-value may be applicable for.
properties.value	string	The value of the key-value.
type	string	The type of the resource.