Package version:

Interface GetSnapshotResponse

Response from getting a Snapshot.

interface GetSnapshotResponse {
    compositionType?: string;
    createdOn?: any;
    etag?: string;
    expiresOn?: any;
    filters: ConfigurationSettingsFilter[];
    itemCount?: number;
    name: string;
    retentionPeriodInSeconds?: number;
    sizeInBytes?: number;
    status?: string;
    syncToken?: string;
    tags?: {
        [propertyName: string]: string;
    };
}

Hierarchy (view full)

Properties

compositionType? createdOn? etag? expiresOn? filters itemCount? name retentionPeriodInSeconds? sizeInBytes? status? syncToken? tags?

Properties

OptionalcompositionType

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.

Optional ReadonlycreatedOn

createdOn?: any

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

Optional Readonlyetag

etag?: string

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

Optional ReadonlyexpiresOn

expiresOn?: any

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

filters

filters: ConfigurationSettingsFilter[]

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

Optional ReadonlyitemCount

itemCount?: number

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

Readonlyname

name: string

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

OptionalretentionPeriodInSeconds

retentionPeriodInSeconds?: number

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.

Optional ReadonlysizeInBytes

sizeInBytes?: number

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

Optional Readonlystatus

status?: string

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

OptionalsyncToken

syncToken?: string

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

Optionaltags

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

The tags of the snapshot.

Settings

Member Visibility