Freigeben über

ConfigurationModelFactory.ConfigurationSnapshot Method

Definition

Namespace:
Azure.Data.AppConfiguration
Assembly:
Azure.Data.AppConfiguration.dll
Package:
Azure.Data.AppConfiguration v1.7.0
Source:
ConfigurationModelFactory.cs

A snapshot is a named, immutable subset of an App Configuration store's key-values.

public static Azure.Data.AppConfiguration.ConfigurationSnapshot ConfigurationSnapshot(string name = default, Azure.Data.AppConfiguration.ConfigurationSnapshotStatus? status = default, System.Collections.Generic.IEnumerable<Azure.Data.AppConfiguration.ConfigurationSettingsFilter> filters = default, Azure.Data.AppConfiguration.SnapshotComposition? snapshotComposition = default, DateTimeOffset? createdOn = default, DateTimeOffset? expiresOn = default, TimeSpan? retentionPeriod = default, long? sizeInBytes = default, long? itemCount = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.ETag eTag = default);
static member ConfigurationSnapshot : string * Nullable<Azure.Data.AppConfiguration.ConfigurationSnapshotStatus> * seq<Azure.Data.AppConfiguration.ConfigurationSettingsFilter> * Nullable<Azure.Data.AppConfiguration.SnapshotComposition> * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * Nullable<TimeSpan> * Nullable<int64> * Nullable<int64> * System.Collections.Generic.IDictionary<string, string> * Azure.ETag -> Azure.Data.AppConfiguration.ConfigurationSnapshot
Public Shared Function ConfigurationSnapshot (Optional name As String = Nothing, Optional status As Nullable(Of ConfigurationSnapshotStatus) = Nothing, Optional filters As IEnumerable(Of ConfigurationSettingsFilter) = Nothing, Optional snapshotComposition As Nullable(Of SnapshotComposition) = Nothing, Optional createdOn As Nullable(Of DateTimeOffset) = Nothing, Optional expiresOn As Nullable(Of DateTimeOffset) = Nothing, Optional retentionPeriod As Nullable(Of TimeSpan) = Nothing, Optional sizeInBytes As Nullable(Of Long) = Nothing, Optional itemCount As Nullable(Of Long) = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional eTag As ETag = Nothing) As ConfigurationSnapshot

Parameters

name
String

The name of the snapshot.

status
Nullable<ConfigurationSnapshotStatus>

The current status of the snapshot.

filters
IEnumerable<ConfigurationSettingsFilter>

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

snapshotComposition
Nullable<SnapshotComposition>

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
Nullable<DateTimeOffset>

The time that the snapshot was created.

expiresOn
Nullable<DateTimeOffset>

The time that the snapshot will expire.

retentionPeriod
Nullable<TimeSpan>

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
Nullable<Int64>

The size in bytes of the snapshot.

itemCount
Nullable<Int64>

The amount of key-values in the snapshot.

tags
IDictionary<String,String>

The tags of the snapshot.

eTag
ETag

A value representing the current state of the snapshot.

Returns

ConfigurationSnapshot

A new ConfigurationSnapshot instance for mocking.

Applies to