Sdílet prostřednictvím

AppConfigurationClient class

  • Reference
Balíček:
@azure/app-configuration

Klient pro službu Azure App Configuration.

Konstruktory

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicializuje novou instanci třídy AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Inicializuje novou instanci třídy AppConfigurationClient pomocí TokenCredential.

Metody

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

Přidání nastavení do služby Azure App Configuration Service selhává, pokud už existuje.

Příklad použití:

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

Archivace připraveného snímku

Příklad použití:

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

Začne vytvářet snímek pro službu Azure App Configuration, pokud už existuje, selže.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Začne vytvářet snímek pro službu Azure App Configuration Service, počká, až se dokončí, selže, pokud už existuje.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Odstranění nastavení ze služby Azure App Configuration Service

Příklad použití:

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

Získá nastavení ze služby Azure App Configuration.

Příklad kódu:

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

Získání snímku ze služby Azure App Configuration Service

Příklad použití:

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

Zobrazí seznam nastavení ze služby Azure App Configuration, volitelně filtrované podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Zobrazí seznam nastavení ze služby Azure App Configuration pro snímky na základě názvu, volitelně filtrovaného podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

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

Získání seznamu popisků ze služby Azure App Configuration Service

Příklad kódu:

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

Zobrazí revize sady klíčů, volitelně filtrované podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

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

Výpis všech snímků ze služby Azure App Configuration Service

Příklad použití:

const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)

Obnovení archivovaného snímku zpět do stavu připraveno

Příklad použití:

const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)

Nastaví hodnotu klíče ve službě Azure App Configuration, což umožňuje volitelnou etag.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Nastaví nebo vymaže stav klíče jen pro čtení.
updateSyncToken(string)

Přidá token externí synchronizace, který zajistí, že požadavky služby přijímají hodnoty up-to-date.

Podrobnosti konstruktoru

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicializuje novou instanci třídy AppConfigurationClient.

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

Parametry

connectionString

string

Připojovací řetězec potřebný pro připojení klienta k Azure.

options
AppConfigurationClientOptions

Možnosti pro AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Inicializuje novou instanci třídy AppConfigurationClient pomocí TokenCredential.

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

Parametry

endpoint

string

Koncový bod služby App Configuration Service (např. https://sample.azconfig.io).

tokenCredential
TokenCredential

Objekt, který implementuje rozhraní TokenCredential použité k ověřování požadavků na službu. Pomocí balíčku @azure/identity vytvořte přihlašovací údaje, které vyhovují vašim potřebám.

options
AppConfigurationClientOptions

Možnosti pro AppConfigurationClient.

Podrobnosti metody

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

Přidání nastavení do služby Azure App Configuration Service selhává, pokud už existuje.

Příklad použití:

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>

Nastavení konfigurace.

options
AddConfigurationSettingOptions

Volitelné parametry požadavku.

Návraty

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Archivace připraveného snímku

Příklad použití:

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

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

Parametry

name

string

Název snímku

options
UpdateSnapshotOptions

Volitelné parametry požadavku.

Návraty

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Začne vytvářet snímek pro službu Azure App Configuration, pokud už existuje, selže.

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

Parametry

snapshot
SnapshotInfo
options
CreateSnapshotOptions

Návraty

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Začne vytvářet snímek pro službu Azure App Configuration Service, počká, až se dokončí, selže, pokud už existuje.

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

Parametry

snapshot
SnapshotInfo
options
CreateSnapshotOptions

Návraty

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Odstranění nastavení ze služby Azure App Configuration Service

Příklad použití:

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

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

Parametry

id
ConfigurationSettingId

ID nastavení konfigurace, které se má odstranit.

options
DeleteConfigurationSettingOptions

Volitelné parametry požadavku (např. značka etag, popisek)

Návraty

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Získá nastavení ze služby Azure App Configuration.

Příklad kódu:

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

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

Parametry

id
ConfigurationSettingId

ID nastavení konfigurace, které se má získat.

options
GetConfigurationSettingOptions

Volitelné parametry požadavku.

Návraty

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Získání snímku ze služby Azure App Configuration Service

Příklad použití:

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

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

Parametry

name

string

Název snímku

options
GetSnapshotOptions

Volitelné parametry požadavku.

Návraty

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Zobrazí seznam nastavení ze služby Azure App Configuration, volitelně filtrované podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

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

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

Parametry

options
ListConfigurationSettingsOptions

Volitelné parametry požadavku.

Návraty

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Zobrazí seznam nastavení ze služby Azure App Configuration pro snímky na základě názvu, volitelně filtrovaného podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

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

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

Parametry

snapshotName

string

options
ListConfigurationSettingsForSnapshotOptions

Volitelné parametry požadavku.

Návraty

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Získání seznamu popisků ze služby Azure App Configuration Service

Příklad kódu:

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

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

Parametry

options
ListLabelsOptions

Volitelné parametry požadavku.

Návraty

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Zobrazí revize sady klíčů, volitelně filtrované podle názvů klíčů, popisků a přijetí data a času.

Příklad kódu:

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

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

Parametry

options
ListRevisionsOptions

Volitelné parametry požadavku.

Návraty

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Výpis všech snímků ze služby Azure App Configuration Service

Příklad použití:

const result = await client.listSnapshots();

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

Parametry

options
ListSnapshotsOptions

Volitelné parametry požadavku.

Návraty

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Obnovení archivovaného snímku zpět do stavu připraveno

Příklad použití:

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

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

Parametry

name

string

Název snímku

options
UpdateSnapshotOptions

Volitelné parametry požadavku.

Návraty

Promise<UpdateSnapshotResponse>

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

Nastaví hodnotu klíče ve službě Azure App Configuration, což umožňuje volitelnou etag.

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

Parametry

configurationSetting

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

Hodnota konfigurace.

options
SetConfigurationSettingOptions

Volitelné parametry požadavku.

Příklad kódu:

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

Návraty

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Nastaví nebo vymaže stav klíče jen pro čtení.

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

Parametry

id
ConfigurationSettingId

ID nastavení konfigurace, které chcete upravit.

readOnly

boolean

options
SetReadOnlyOptions

Návraty

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Přidá token externí synchronizace, který zajistí, že požadavky služby přijímají hodnoty up-to-date.

function updateSyncToken(syncToken: string)

Parametry

syncToken

string

Hodnota synchronizačního tokenu.