@azure/app-configuration 1.4.1 → 1.5.0-alpha.20230717.2

package/README.md

@@ -7,6 +7,7 @@ Use the client library for App Configuration to:
 - Create flexible key representations and mappings
 - Tag keys with labels
 - Replay settings from any point in time
+- Manage snapshots of an app's configuration
 
 Key links:
 
@@ -143,9 +144,11 @@ let setting = await client.getConfigurationSetting({
 setting = await client.getConfigurationSetting(setting);
 ```
 
+The `2022-11-01-preview` API version supports configuration snapshots: immutable, point-in-time copies of a configuration store. Snapshots can be created with filters that determine which key-value pairs are contained within the snapshot, creating an immutable, composed view of the configuration store. This feature enables applications to hold a consistent view of configuration, ensuring that there are no version mismatches to individual settings due to reading as updates were made. For example, this feature can be used to create "release configuration snapshots" within an App Configuration. See [the _create and get a snapshot_ section](#create-and-get-a-setting) in the example below. 
+
 ## Examples
 
-#### Create and get a setting
+### Create and get a setting
 
 ```javascript
 const appConfig = require("@azure/app-configuration");
@@ -175,6 +178,81 @@ async function run() {
 run().catch((err) => console.log("ERROR:", err));
 ```
 
+### Create a snapshot
+
+`beginCreateSnapshot` gives you the poller to poll for the snapshot creation. 
+
+```javascript
+const { AppConfigurationClient } = require("@azure/app-configuration");
+
+const client = new AppConfigurationClient(
+  "<App Configuration connection string goes here>"
+);
+
+const key = "testkey";
+const value = "testvalue";
+const label = "optional-label";
+
+await client.addConfigurationSetting({
+  key,
+  value,
+  label
+});
+
+const poller = await this.beginCreateSnapshot({
+  name:"testsnapshot",
+  retentionPeriod: 2592000,
+  filters: [{key, label}],
+});
+const snapshot = await poller.pollUntilDone();
+```
+
+You can also use `beginCreateSnapshotAndWait` to have the result of the creation directly after the polling is done.
+```js
+const snapshot  = await client.beginCreateSnapshotAndWait({
+  name:"testsnapshot",
+  retentionPeriod: 2592000,
+  filters: [{key, label}],
+});
+```
+
+### Get a snapshot
+
+```js
+const retrievedSnapshot = await client.getSnapshot("testsnapshot");
+console.log("Retrieved snapshot:", retrievedSnapshot);
+```
+
+### List the `ConfigurationSetting` in the snapshot
+```javascript
+let retrievedSnapshotSettings = await client.listConfigurationSettings({
+  snapshotFilter: "testsnapshot"
+});
+
+for await (const setting of retrievedSnapshotSettings) {
+  console.log(`Found key: ${setting.key}, label: ${setting.label}`);
+}
+```
+
+### List all snapshots from the service
+```javascript
+let snapshots = await client.listSnapshots();
+
+for await (const snapshot of snapshots) {
+  console.log(`Found snapshot: ${snapshot.name}`);
+}
+```
+
+### Recover and archive the snapshot
+```javascript
+// Snapshot is in ready status
+let archivedSnapshot = await client.archiveSnapshot("testsnapshot");
+console.log("Snapshot updated status is:", archivedSnapshot.status);
+
+// Snapshot is in archive status
+let recoverSnapshot = await client.recoverSnapshot("testsnapshot");
+console.log("Snapshot updated status is:", recoverSnapshot.status);
+```
 ## Troubleshooting
 
 ### Logging