snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure.app_configuration.snapshots

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.
compositionType	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.
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.
itemsCount	integer	The amount of key-values in the snapshot.
provisioningState	string	The provisioning state of the snapshot. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
retentionPeriod	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)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	The tags of the snapshot. NOTE: These are data plane tags, not ARM tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, snapshot_name, subscription_id		Gets the properties of the specified snapshot. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.
create	insert	resource_group_name, config_store_name, snapshot_name, subscription_id, properties		Creates a snapshot. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration snapshots 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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
snapshot_name	string	The name of the snapshot. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the specified snapshot. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration snapshots the data plane API should be used instead.

SELECT
id,
name,
compositionType,
created,
etag,
expires,
filters,
itemsCount,
provisioningState,
retentionPeriod,
size,
status,
systemData,
tags,
type
FROM azure.app_configuration.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND config_store_name = '{{ config_store_name }}' -- required
AND snapshot_name = '{{ snapshot_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.app_configuration.snapshots (
properties,
resource_group_name,
config_store_name,
snapshot_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ config_store_name }}',
'{{ snapshot_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the snapshots resource.
  - name: config_store_name
    value: "{{ config_store_name }}"
    description: Required parameter for the snapshots resource.
  - name: snapshot_name
    value: "{{ snapshot_name }}"
    description: Required parameter for the snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the snapshots resource.
  - name: properties
    description: |
      All snapshot properties. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      filters:
        - key: "{{ key }}"
          label: "{{ label }}"
      compositionType: "{{ compositionType }}"
      created: "{{ created }}"
      expires: "{{ expires }}"
      retentionPeriod: {{ retentionPeriod }}
      size: {{ size }}
      itemsCount: {{ itemsCount }}
      tags: "{{ tags }}"
      etag: "{{ etag }}"