Snapshot interface

Package:

@azure/arm-appconfiguration

The snapshot resource.

Extends

ProxyResource

Properties

compositionType	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.
created	The time that the snapshot was created.
etag	A value representing the current state of the snapshot.
expires	The time that the snapshot will expire.
filters	A list of filters used to filter the key-values included in the snapshot.
itemsCount	The amount of key-values in the snapshot.
provisioningState	The provisioning state of the snapshot.
retentionPeriod	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	The size in bytes of the snapshot.
status	The current status of the snapshot.
tags	The tags of the snapshot. NOTE: These are data plane tags, not ARM tags.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

compositionType

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.

compositionType?: string

Property Value

string

created

The time that the snapshot was created.

created?: Date

Property Value

Date

etag

A value representing the current state of the snapshot.

etag?: string

Property Value

string

expires

The time that the snapshot will expire.

expires?: Date

Property Value

Date

filters

A list of filters used to filter the key-values included in the snapshot.

filters: KeyValueFilter[]

Property Value

KeyValueFilter[]

itemsCount

The amount of key-values in the snapshot.

itemsCount?: number

Property Value

number

provisioningState

The provisioning state of the snapshot.

provisioningState?: string

Property Value

string

retentionPeriod

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.

retentionPeriod?: number

Property Value

number

size

The size in bytes of the snapshot.

size?: number

Property Value

number

status

The current status of the snapshot.

status?: string

Property Value

string

tags

The tags of the snapshot. NOTE: These are data plane tags, not ARM tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type