key_values

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

Overview

Name	key_values
Type	Resource
Id	azure.app_configuration.key_values

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	All key-value properties.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, configStoreName, keyValueName		Gets the properties of the specified 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.
create_or_update	insert	subscriptionId, resourceGroupName, configStoreName, keyValueName		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.
delete	delete	subscriptionId, resourceGroupName, configStoreName, keyValueName		Deletes 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.

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
configStoreName	string	The name of the configuration store.
keyValueName	string	Identifier of key and label combination. Key and label are joined by $ character. Label is optional.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the properties of the specified 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.

SELECT
id,
name,
properties,
type
FROM azure.app_configuration.key_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND configStoreName = '{{ configStoreName }}' -- required
AND keyValueName = '{{ keyValueName }}' -- required
;

INSERT examples

create_or_update

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.

INSERT INTO azure.app_configuration.key_values (
data__properties,
subscriptionId,
resourceGroupName,
configStoreName,
keyValueName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ configStoreName }}',
'{{ keyValueName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: key_values
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the key_values resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the key_values resource.
    - name: configStoreName
      value: string
      description: Required parameter for the key_values resource.
    - name: keyValueName
      value: string
      description: Required parameter for the key_values resource.
    - name: properties
      value: object
      description: |
        All key-value properties.

DELETE examples

delete

Deletes 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.

DELETE FROM azure.app_configuration.key_values
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND configStoreName = '{{ configStoreName }}' --required
AND keyValueName = '{{ keyValueName }}' --required
;