AppConfigurationClient class

Paket:

@azure/app-configuration

Klient för Azure App Configuration-tjänsten.

Konstruktorer

AppConfigurationClient(string, AppConfigurationClientOptions)	Initierar en ny instans av klassen AppConfigurationClient.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Initierar en ny instans av klassen AppConfigurationClient med hjälp av en TokenCredential.

Metoder

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Lägg till en inställning i Azure App Configuration-tjänsten, om den inte redan finns. Exempel på användning: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Arkivera en klar ögonblicksbild Exempel på användning: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Börjar skapa en ögonblicksbild för Azure App Configuration Service, misslyckas om den redan finns.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Börjar skapa en ögonblicksbild för Azure App Configuration Service, väntar tills den är klar, misslyckas om den redan finns.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Ta bort en inställning från Azure App Configuration Service Exempel på användning: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Hämtar en inställning från Azure App Configuration Service. Exempelkod: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Hämta en ögonblicksbild från Azure App Configuration Service Exempel på användning: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Visar en lista med inställningar från Azure App Configuration-tjänsten, som eventuellt filtreras efter nyckelnamn, etiketter och accepterar datetime. Exempelkod: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Visar inställningar från Azure App Configuration Service för ögonblicksbilder baserat på namn, eventuellt filtrerat efter nyckelnamn, etiketter och acceptera datetime. Exempelkod: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Hämta en lista med etiketter från Azure App Configuration-tjänsten Exempelkod: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Visar en lista över revideringar av en uppsättning nycklar, eventuellt filtrerade efter nyckelnamn, etiketter och acceptera datetime. Exempelkod: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Visa en lista över alla ögonblicksbilder från Azure App Configuration Service Exempel på användning: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Återställa en arkiverad ögonblicksbild till klar status Exempel på användning: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Anger värdet för en nyckel i Azure App Configuration Service, vilket möjliggör en valfri etag.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Anger eller rensar en nyckels skrivskyddade status.
updateSyncToken(string)	Lägger till en extern synkroniseringstoken för att säkerställa att tjänstbegäranden tar emot up-to-date-värden.

Konstruktorinformation

AppConfigurationClient(string, AppConfigurationClientOptions)

Initierar en ny instans av klassen AppConfigurationClient.

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

Parametrar

connectionString

string

Anslutningssträng som krävs för att en klient ska kunna ansluta till Azure.

options

AppConfigurationClientOptions

Alternativ för AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Initierar en ny instans av klassen AppConfigurationClient med hjälp av en TokenCredential.

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

Parametrar

endpoint

string

Slutpunkten för appkonfigurationstjänsten (till exempel https://sample.azconfig.io).

tokenCredential

TokenCredential

Ett objekt som implementerar det TokenCredential gränssnitt som används för att autentisera begäranden till tjänsten. Använd @azure/identity-paketet för att skapa en autentiseringsuppgift som passar dina behov.

options

AppConfigurationClientOptions

Alternativ för AppConfigurationClient.

Metodinformation

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

Lägg till en inställning i Azure App Configuration-tjänsten, om den inte redan finns.

Exempel på användning:

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

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

Parametrar

configurationSetting

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

En konfigurationsinställning.

options

AddConfigurationSettingOptions

Valfria parametrar för begäran.

Returer

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Arkivera en klar ögonblicksbild

Exempel på användning:

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

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

Parametrar

name

string

Namnet på ögonblicksbilden.

options

UpdateSnapshotOptions

Valfria parametrar för begäran.

Returer

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Börjar skapa en ögonblicksbild för Azure App Configuration Service, misslyckas om den redan finns.

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

Parametrar

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Returer

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Börjar skapa en ögonblicksbild för Azure App Configuration Service, väntar tills den är klar, misslyckas om den redan finns.

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

Parametrar

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Returer

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Ta bort en inställning från Azure App Configuration Service

Exempel på användning:

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

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

Parametrar

id

ConfigurationSettingId

ID:t för konfigurationsinställningen som ska tas bort.

options

DeleteConfigurationSettingOptions

Valfria parametrar för begäran (t.ex. etag, etikett)

Returer

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Hämtar en inställning från Azure App Configuration Service.

Exempelkod:

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

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

Parametrar

id

ConfigurationSettingId

ID:t för konfigurationsinställningen som ska hämtas.

options

GetConfigurationSettingOptions

Valfria parametrar för begäran.

Returer

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Hämta en ögonblicksbild från Azure App Configuration Service

Exempel på användning:

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

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

Parametrar

name

string

Namnet på ögonblicksbilden.

options

GetSnapshotOptions

Valfria parametrar för begäran.

Returer

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Visar en lista med inställningar från Azure App Configuration-tjänsten, som eventuellt filtreras efter nyckelnamn, etiketter och accepterar datetime.

Exempelkod:

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

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

Parametrar

options

ListConfigurationSettingsOptions

Valfria parametrar för begäran.

Returer

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Visar inställningar från Azure App Configuration Service för ögonblicksbilder baserat på namn, eventuellt filtrerat efter nyckelnamn, etiketter och acceptera datetime.

Exempelkod:

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

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

Parametrar

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Valfria parametrar för begäran.

Returer

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Hämta en lista med etiketter från Azure App Configuration-tjänsten

Exempelkod:

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

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

Parametrar

options

ListLabelsOptions

Valfria parametrar för begäran.

Returer

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Visar en lista över revideringar av en uppsättning nycklar, eventuellt filtrerade efter nyckelnamn, etiketter och acceptera datetime.

Exempelkod:

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

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

Parametrar

options

ListRevisionsOptions

Valfria parametrar för begäran.

Returer

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Visa en lista över alla ögonblicksbilder från Azure App Configuration Service

Exempel på användning:

const result = await client.listSnapshots();

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

Parametrar

options

ListSnapshotsOptions

Valfria parametrar för begäran.

Returer

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Återställa en arkiverad ögonblicksbild till klar status

Exempel på användning:

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

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

Parametrar

name

string

Namnet på ögonblicksbilden.

options

UpdateSnapshotOptions

Valfria parametrar för begäran.

Returer

Promise<UpdateSnapshotResponse>

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

Anger värdet för en nyckel i Azure App Configuration Service, vilket möjliggör en valfri etag.

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

Parametrar

configurationSetting

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

Ett konfigurationsvärde.

options

SetConfigurationSettingOptions

Valfria parametrar för begäran.

Exempelkod:

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

Returer

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Anger eller rensar en nyckels skrivskyddade status.

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

Parametrar

id

ConfigurationSettingId

ID:t för konfigurationsinställningen som ska ändras.

readOnly

boolean

options

SetReadOnlyOptions

Returer

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Lägger till en extern synkroniseringstoken för att säkerställa att tjänstbegäranden tar emot up-to-date-värden.

function updateSyncToken(syncToken: string)

Parametrar

syncToken

string

Värdet för synkroniseringstoken.