key_values

Creates, updates, deletes, gets or lists a key_values resource.

Overview

Name	key_values
Type	Resource
Id	azure.app_configuration_dataplane.key_values

Fields

The following fields are returned by SELECT queries:

get_key_value

Name	Datatype	Description
content_type	string	The content type of the value stored within the key-value.
description	string	The description of the key-value.
etag	string	A value representing the current state of the resource.
key	string	The key of the key-value. Required.
label	string	The label the key-value belongs to.
last_modified	string (date-time)	A date representing the last time the key-value was modified.
locked	boolean	Indicates whether the key-value is locked.
tags	object	The tags of the key-value.
value	string	The value of the key-value.

get_key_values

Name	Datatype	Description
content_type	string	The content type of the value stored within the key-value.
description	string	The description of the key-value.
etag	string	A value representing the current state of the resource.
key	string	The key of the key-value. Required.
label	string	The label the key-value belongs to.
last_modified	string (date-time)	A date representing the last time the key-value was modified.
locked	boolean	Indicates whether the key-value is locked.
tags	object	The tags of the key-value.
value	string	The value of the key-value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_key_value	select	key_name, config_store_name	label, $Select, Sync-Token, Accept-Datetime	Gets a single key-value. Gets a single key-value.
get_key_values	select	config_store_name	key, label, Sync-Token, After, Accept-Datetime, $Select, snapshot	Gets a list of key-values. Gets a list of key-values.
delete_key_value	delete	key_name, config_store_name	label, Sync-Token	Deletes a key-value. Deletes a key-value.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
config_store_name	string	App Configuration store name. (default: )
key_name	string	The key of the key-value to delete. Required.
$Select	array	Used to select what fields are present in the returned resource(s). Default value is None.
Accept-Datetime	string	Requests the server to respond with the state of the resource at the specified time. Default value is None.
After	string	Instructs the server to return elements that appear after the element referred to by the specified token. Default value is None.
Sync-Token	string	Used to guarantee real-time consistency between requests. Default value is None.
key	string	A filter used to match keys. Syntax reference: https://aka.ms/azconfig/docs/keyvaluefiltering _. Default value is None.
label	string	The label of the key-value to delete. Default value is None.
snapshot	string	A filter used get key-values for a snapshot. The value should be the name of the snapshot. Not valid when used with 'key' and 'label' filters. Default value is None.

SELECT examples

get_key_value

Gets a single key-value. Gets a single key-value.

SELECT
content_type,
description,
etag,
key,
label,
last_modified,
locked,
tags,
value
FROM azure.app_configuration_dataplane.key_values
WHERE key_name = '{{ key_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND label = '{{ label }}'
AND $Select = '{{ $Select }}'
AND Sync-Token = '{{ Sync-Token }}'
AND Accept-Datetime = '{{ Accept-Datetime }}'
;

get_key_values

Gets a list of key-values. Gets a list of key-values.

SELECT
content_type,
description,
etag,
key,
label,
last_modified,
locked,
tags,
value
FROM azure.app_configuration_dataplane.key_values
WHERE config_store_name = '{{ config_store_name }}' -- required
AND key = '{{ key }}'
AND label = '{{ label }}'
AND Sync-Token = '{{ Sync-Token }}'
AND After = '{{ After }}'
AND Accept-Datetime = '{{ Accept-Datetime }}'
AND $Select = '{{ $Select }}'
AND snapshot = '{{ snapshot }}'
;

DELETE examples

delete_key_value

Deletes a key-value. Deletes a key-value.

DELETE FROM azure.app_configuration_dataplane.key_values
WHERE key_name = '{{ key_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND label = '{{ label }}'
AND Sync-Token = '{{ Sync-Token }}'
;