snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure.app_configuration_dataplane.snapshots

Fields

The following fields are returned by SELECT queries:

get_snapshot

Name	Datatype	Description
name	string	The name of the snapshot. Required.
composition_type	string	The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. Known values are: "key" and "key_label". (key, key_label)
created	string (date-time)	The time that the snapshot was created.
description	string	The description of the snapshot.
etag	string	A value representing the current state of the snapshot.
expires	string (date-time)	The time that the snapshot will expire.
filters	array	A list of filters used to filter the key-values included in the snapshot. Required.
items_count	integer	The amount of key-values in the snapshot.
retention_period	integer	The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.
size	integer	The size in bytes of the snapshot.
status	string	The current status of the snapshot. Known values are: "provisioning", "ready", "archived", and "failed". (provisioning, ready, archived, failed)
tags	object	The tags of the snapshot.

get_snapshots

Name	Datatype	Description
name	string	The name of the snapshot. Required.
composition_type	string	The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. Known values are: "key" and "key_label". (key, key_label)
created	string (date-time)	The time that the snapshot was created.
description	string	The description of the snapshot.
etag	string	A value representing the current state of the snapshot.
expires	string (date-time)	The time that the snapshot will expire.
filters	array	A list of filters used to filter the key-values included in the snapshot. Required.
items_count	integer	The amount of key-values in the snapshot.
retention_period	integer	The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.
size	integer	The size in bytes of the snapshot.
status	string	The current status of the snapshot. Known values are: "provisioning", "ready", "archived", and "failed". (provisioning, ready, archived, failed)
tags	object	The tags of the snapshot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_snapshot	select	name, config_store_name	$Select, Sync-Token	Gets a single key-value snapshot. Gets a single key-value snapshot.
get_snapshots	select	config_store_name	name, After, $Select, status, Sync-Token	Gets a list of key-value snapshots. Gets a list of key-value snapshots.
create_snapshot	insert	name, config_store_name, filters	Sync-Token	Creates a key-value snapshot. Creates a key-value snapshot.

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: )
name	string	The name of the key-value snapshot to create. Required.
$Select	array	Used to select what fields are present in the returned resource(s). 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.
name	string	A filter for the name of the returned snapshots. Default value is None.
status	array	Used to filter returned snapshots by their status property. Default value is None.

SELECT examples

get_snapshot

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

SELECT
name,
composition_type,
created,
description,
etag,
expires,
filters,
items_count,
retention_period,
size,
status,
tags
FROM azure.app_configuration_dataplane.snapshots
WHERE name = '{{ name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND $Select = '{{ $Select }}'
AND Sync-Token = '{{ Sync-Token }}'
;

get_snapshots

Gets a list of key-value snapshots. Gets a list of key-value snapshots.

SELECT
name,
composition_type,
created,
description,
etag,
expires,
filters,
items_count,
retention_period,
size,
status,
tags
FROM azure.app_configuration_dataplane.snapshots
WHERE config_store_name = '{{ config_store_name }}' -- required
AND name = '{{ name }}'
AND After = '{{ After }}'
AND $Select = '{{ $Select }}'
AND status = '{{ status }}'
AND Sync-Token = '{{ Sync-Token }}'
;

INSERT examples

create_snapshot

Creates a key-value snapshot. Creates a key-value snapshot.

INSERT INTO azure.app_configuration_dataplane.snapshots (
filters,
composition_type,
retention_period,
tags,
description,
name,
config_store_name,
Sync-Token
)
SELECT 
'{{ filters }}' /* required */,
'{{ composition_type }}',
{{ retention_period }},
'{{ tags }}',
'{{ description }}',
'{{ name }}',
'{{ config_store_name }}',
'{{ Sync-Token }}'
RETURNING
name,
composition_type,
created,
description,
etag,
expires,
filters,
items_count,
retention_period,
size,
status,
tags
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the snapshots resource.
  - name: config_store_name
    value: "{{ config_store_name }}"
    description: Required parameter for the snapshots resource.
  - name: filters
    description: |
      A list of filters used to filter the key-values included in the snapshot. Required.
    value:
      - key: "{{ key }}"
        label: "{{ label }}"
        tags: "{{ tags }}"
  - name: composition_type
    value: "{{ composition_type }}"
    description: |
      The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. Known values are: "key" and "key_label".
    valid_values: ['key', 'key_label']
  - name: retention_period
    value: {{ retention_period }}
    description: |
      The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used.
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the snapshot.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the snapshot.
  - name: Sync-Token
    value: "{{ Sync-Token }}"
    description: Used to guarantee real-time consistency between requests. Default value is None.
    description: Used to guarantee real-time consistency between requests. Default value is None.