AppConfigurationClient class

Initializes a new instance of the AppConfigurationClient class.

new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)

Parameters

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

new AppConfigurationClient(endpoint: string, tokenCredential: TokenCredential, options?: AppConfigurationClientOptions)

Parameters

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",
});

function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>

Parameters

Returns

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" });

function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parameters

Returns

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

function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

Parameters

Returns

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

function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>

Parameters

Returns

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",
});

function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>

Parameters

Returns

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" });

function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>

Parameters

Returns

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);

function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>

Parameters

Returns

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" });

function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parameters

Returns

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",
});

function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parameters

Returns

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*" });

function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

Parameters

Returns

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"] });

function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

Parameters

Returns

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}`);
}

function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

Parameters

Returns

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");

function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parameters

Returns

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

function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>

Parameters

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);

await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });

Returns

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

function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>

Parameters

Returns

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

function updateSyncToken(syncToken: string)

Parameters