AppConfigurationClient class

Pakiet:

@azure/app-configuration

Klient usługi Azure App Configuration.

Konstruktory

AppConfigurationClient(string, AppConfigurationClientOptions)	Inicjuje nowe wystąpienie klasy AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Inicjuje nowe wystąpienie klasy AppConfigurationClient przy użyciu tokenuCredential.

Metody

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Dodaj ustawienie do usługi Azure App Configuration, które kończy się niepowodzeniem, jeśli już istnieje. Przykładowe użycie: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Archiwizowanie gotowej migawki Przykładowe użycie: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Rozpoczyna tworzenie migawki dla usługi Azure App Configuration, jeśli już istnieje.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Rozpoczyna tworzenie migawki dla usługi Azure App Configuration, czeka na zakończenie, kończy się niepowodzeniem, jeśli już istnieje.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Usuwanie ustawienia z usługi Azure App Configuration Przykładowe użycie: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Pobiera ustawienie z usługi Azure App Configuration. Przykładowy kod: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Pobieranie migawki z usługi Azure App Configuration Service Przykładowe użycie: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Wyświetla ustawienia z usługi Azure App Configuration, opcjonalnie filtrowane według nazw kluczy, etykiet i akceptowania daty/godziny. Przykładowy kod: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Wyświetla ustawienia z usługi Azure App Configuration dla migawek na podstawie nazwy, opcjonalnie filtrowane według nazw kluczy, etykiet i akceptowania daty/godziny. Przykładowy kod: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Pobieranie listy etykiet z usługi Azure App Configuration Przykładowy kod: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Wyświetla listę poprawek zestawu kluczy, opcjonalnie filtrowanych według nazw kluczy, etykiet i akceptowania daty/godziny. Przykładowy kod: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Wyświetlanie listy wszystkich migawek z usługi Azure App Configuration Przykładowe użycie: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Odzyskiwanie zarchiwizowanej migawki z powrotem do stanu gotowego Przykładowe użycie: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Ustawia wartość klucza w usłudze Azure App Configuration, co pozwala na opcjonalny element etag.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Ustawia lub czyści stan tylko do odczytu klucza.
updateSyncToken(string)	Dodaje zewnętrzny token synchronizacji w celu zapewnienia, że żądania obsługi otrzymają up-to-date wartości.

Szczegóły konstruktora

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicjuje nowe wystąpienie klasy AppConfigurationClient.

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

Parametry

connectionString

string

Parametry połączenia potrzebne klientowi do nawiązania połączenia z platformą Azure.

options

AppConfigurationClientOptions

Opcje elementu AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Inicjuje nowe wystąpienie klasy AppConfigurationClient przy użyciu tokenuCredential.

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

Parametry

endpoint

string

Punkt końcowy usługi App Configuration Service (np. https://sample.azconfig.io).

tokenCredential

TokenCredential

Obiekt, który implementuje interfejs TokenCredential używany do uwierzytelniania żądań w usłudze. Użyj pakietu @azure/identity, aby utworzyć poświadczenia odpowiadające Twoim potrzebom.

options

AppConfigurationClientOptions

Opcje elementu AppConfigurationClient.

Szczegóły metody

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)

Dodaj ustawienie do usługi Azure App Configuration, które kończy się niepowodzeniem, jeśli już istnieje.

Przykładowe użycie:

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

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

Parametry

configurationSetting

AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>

Ustawienie konfiguracji.

options

AddConfigurationSettingOptions

Opcjonalne parametry żądania.

Zwraca

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Archiwizowanie gotowej migawki

Przykładowe użycie:

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

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

Parametry

name

string

Nazwa migawki.

options

UpdateSnapshotOptions

Opcjonalne parametry żądania.

Zwraca

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Rozpoczyna tworzenie migawki dla usługi Azure App Configuration, jeśli już istnieje.

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

Parametry

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Zwraca

Promise<@azure/core-lro.SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Rozpoczyna tworzenie migawki dla usługi Azure App Configuration, czeka na zakończenie, kończy się niepowodzeniem, jeśli już istnieje.

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

Parametry

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Zwraca

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Usuwanie ustawienia z usługi Azure App Configuration

Przykładowe użycie:

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

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

Parametry

id

ConfigurationSettingId

Identyfikator ustawienia konfiguracji do usunięcia.

options

DeleteConfigurationSettingOptions

Opcjonalne parametry żądania (np. etag, etykieta)

Zwraca

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Pobiera ustawienie z usługi Azure App Configuration.

Przykładowy kod:

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

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

Parametry

id

ConfigurationSettingId

Identyfikator ustawienia konfiguracji do pobrania.

options

GetConfigurationSettingOptions

Opcjonalne parametry żądania.

Zwraca

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Pobieranie migawki z usługi Azure App Configuration Service

Przykładowe użycie:

const result = await client.getSnapshot("MySnapshot");

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

Parametry

name

string

Nazwa migawki.

options

GetSnapshotOptions

Opcjonalne parametry żądania.

Zwraca

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Wyświetla ustawienia z usługi Azure App Configuration, opcjonalnie filtrowane według nazw kluczy, etykiet i akceptowania daty/godziny.

Przykładowy kod:

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

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

Parametry

options

ListConfigurationSettingsOptions

Opcjonalne parametry żądania.

Zwraca

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Wyświetla ustawienia z usługi Azure App Configuration dla migawek na podstawie nazwy, opcjonalnie filtrowane według nazw kluczy, etykiet i akceptowania daty/godziny.

Przykładowy kod:

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

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

Parametry

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Opcjonalne parametry żądania.

Zwraca

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Pobieranie listy etykiet z usługi Azure App Configuration

Przykładowy kod:

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

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

Parametry

options

ListLabelsOptions

Opcjonalne parametry żądania.

Zwraca

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Wyświetla listę poprawek zestawu kluczy, opcjonalnie filtrowanych według nazw kluczy, etykiet i akceptowania daty/godziny.

Przykładowy kod:

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

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

Parametry

options

ListRevisionsOptions

Opcjonalne parametry żądania.

Zwraca

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Wyświetlanie listy wszystkich migawek z usługi Azure App Configuration

Przykładowe użycie:

const result = await client.listSnapshots();

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

Parametry

options

ListSnapshotsOptions

Opcjonalne parametry żądania.

Zwraca

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Odzyskiwanie zarchiwizowanej migawki z powrotem do stanu gotowego

Przykładowe użycie:

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

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

Parametry

name

string

Nazwa migawki.

options

UpdateSnapshotOptions

Opcjonalne parametry żądania.

Zwraca

Promise<UpdateSnapshotResponse>

setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

Ustawia wartość klucza w usłudze Azure App Configuration, co pozwala na opcjonalny element etag.

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

Parametry

configurationSetting

SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>

Wartość konfiguracji.

options

SetConfigurationSettingOptions

Opcjonalne parametry żądania.

Przykładowy kod:

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

Zwraca

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Ustawia lub czyści stan tylko do odczytu klucza.

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

Parametry

id

ConfigurationSettingId

Identyfikator ustawienia konfiguracji do zmodyfikowania.

readOnly

boolean

options

SetReadOnlyOptions

Zwraca

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Dodaje zewnętrzny token synchronizacji w celu zapewnienia, że żądania obsługi otrzymają up-to-date wartości.

function updateSyncToken(syncToken: string)

Parametry

syncToken

string

Wartość tokenu synchronizacji.