GetSnapshotResponse interface

Package:

@azure/app-configuration

Response from getting a Snapshot.

Extends

SnapshotResponse

Inherited 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.
createdOn	The time that the snapshot was created. NOTE: This property will not be serialized. It can only be populated by the server.
etag	A value representing the current state of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
expiresOn	The time that the snapshot will expire. NOTE: This property will not be serialized. It can only be populated by the server.
filters	A list of filters used to filter the key-values included in the snapshot.
itemCount	The amount of key-values in the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
retentionPeriodInSeconds	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.
sizeInBytes	The size in bytes of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
status	The current status of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
syncToken	Enables real-time consistency between requests by providing the returned value in the next request made to the server.
tags	The tags of the snapshot.

Inherited 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

Inherited From SnapshotResponse.compositionType

createdOn

The time that the snapshot was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn?: Date

Property Value

Date

Inherited From SnapshotResponse.createdOn

etag

A value representing the current state of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

etag?: string

Property Value

string

Inherited From SnapshotResponse.etag

expiresOn

The time that the snapshot will expire. NOTE: This property will not be serialized. It can only be populated by the server.

expiresOn?: Date

Property Value

Date

Inherited From SnapshotResponse.expiresOn

filters

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

filters: ConfigurationSettingsFilter[]

Property Value

ConfigurationSettingsFilter[]

Inherited From SnapshotResponse.filters

itemCount

The amount of key-values in the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

itemCount?: number

Property Value

number

Inherited From SnapshotResponse.itemCount

name

The name of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

name: string

Property Value

string

Inherited From SnapshotResponse.name

retentionPeriodInSeconds

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.

retentionPeriodInSeconds?: number

Property Value

number

Inherited From SnapshotResponse.retentionPeriodInSeconds

sizeInBytes

The size in bytes of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

sizeInBytes?: number

Property Value

number

Inherited From SnapshotResponse.sizeInBytes

status

The current status of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

Inherited From SnapshotResponse.status

syncToken

Enables real-time consistency between requests by providing the returned value in the next request made to the server.

syncToken?: string

Property Value

string

Inherited From SnapshotResponse.syncToken

tags

The tags of the snapshot.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From SnapshotResponse.tags