Class AppConfigurationClient

Initializes a new instance of the AppConfigurationClient class.

Initializes a new instance of the AppConfigurationClient class using a TokenCredential.

Add a setting into the Azure App Configuration service, failing if it already exists.

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.addConfigurationSetting({
  key: "MyKey",
  label: "MyLabel",
  value: "MyValue",
});
Copy

Archive a ready snapshot

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.archiveSnapshot({ name: "MySnapshot" });
Copy

Begins creating a snapshot for Azure App Configuration service, fails if it already exists.

Begins creating a snapshot for Azure App Configuration service, waits until it is done, fails if it already exists.

Delete a setting from the Azure App Configuration service

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const deletedSetting = await client.deleteConfigurationSetting({
  key: "MyKey",
  label: "MyLabel",
});
Copy

Gets a setting from the Azure App Configuration service.

Example code:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
Copy

Get a snapshot from Azure App Configuration service

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const retrievedSnapshot = await client.getSnapshot("testsnapshot");
console.log("Retrieved snapshot:", retrievedSnapshot);
Copy

Lists settings from the Azure App Configuration service, optionally filtered by key names, labels and accept datetime.

Example code:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
Copy

Lists settings from the Azure App Configuration service for snapshots based on name, optionally filtered by key names, labels and accept datetime.

Example code:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({
  snapshotName: "MySnapshot",
});
Copy

Get a list of labels from the Azure App Configuration service

Example code:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
Copy

Lists revisions of a set of keys, optionally filtered by key names, labels and accept datetime.

Example code:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
Copy

List all snapshots from Azure App Configuration service

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const snapshots = await client.listSnapshots();

for await (const snapshot of snapshots) {
  console.log(`Found snapshot: ${snapshot.name}`);
}
Copy

Recover an archived snapshot back to ready status

Example usage:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.recoverSnapshot("MySnapshot");
Copy

Sets the value of a key in the Azure App Configuration service, allowing for an optional etag.

Sets or clears a key's read-only status.

Adds an external synchronization token to ensure service requests receive up-to-date values.