Share via

Snapshot interface

Package:
@azure/arm-appconfiguration

The snapshot resource.

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. 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.
expires

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.
id

The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
itemsCount

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.
provisioningState

The provisioning state of the snapshot. NOTE: This property will not be serialized. It can only be populated by the server.
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. 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.
tags

The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags.
type

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

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

expires

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

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[]

id

The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

itemsCount

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

itemsCount?: number

Property Value

number

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

provisioningState

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

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. NOTE: This property will not be serialized. It can only be populated by the server.

size?: number

Property Value

number

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

tags

The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags.

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

Property Value

{[propertyName: string]: string}

type

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

type?: string

Property Value

string