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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
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.
eTag	string	An ETag indicating the state of a key-value within a configuration store.
key	string	The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
label	string	A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
lastModified	string (date-time)	The last time a modifying operation was performed on the given key-value.
locked	boolean	A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	A dictionary of tags that can help identify what a key-value may be applicable for.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
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	select	resource_group_name, config_store_name, key_value_name, subscription_id		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	resource_group_name, config_store_name, key_value_name, subscription_id		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.
create_or_update	replace	resource_group_name, config_store_name, key_value_name, subscription_id		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	resource_group_name, config_store_name, key_value_name, subscription_id		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
config_store_name	string	The name of the configuration store. Required.
key_value_name	string	Identifier of key and label combination. Key and label are joined by $ character. Label is optional. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

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,
contentType,
eTag,
key,
label,
lastModified,
locked,
systemData,
tags,
type,
value
FROM azure.app_configuration.key_values
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND key_value_name = '{{ key_value_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
resource_group_name,
config_store_name,
key_value_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ config_store_name }}',
'{{ key_value_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: key_values
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the key_values resource.
  - name: config_store_name
    value: "{{ config_store_name }}"
    description: Required parameter for the key_values resource.
  - name: key_value_name
    value: "{{ key_value_name }}"
    description: Required parameter for the key_values resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the key_values resource.
  - name: properties
    description: |
      All key-value properties.
    value:
      key: "{{ key }}"
      label: "{{ label }}"
      value: "{{ value }}"
      contentType: "{{ contentType }}"
      eTag: "{{ eTag }}"
      lastModified: "{{ lastModified }}"
      locked: {{ locked }}
      tags: "{{ tags }}"

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

REPLACE azure.app_configuration.key_values
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND key_value_name = '{{ key_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND config_store_name = '{{ config_store_name }}' --required
AND key_value_name = '{{ key_value_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;