AppConfigurationClient class

Paket:

@azure/app-configuration

Client für den Azure App-Konfigurationsdienst.

Konstruktoren

AppConfigurationClient(string, AppConfigurationClientOptions)	Initialisiert eine neue Instanz der AppConfigurationClient-Klasse.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)	Initialisiert eine neue Instanz der AppConfigurationClient-Klasse mithilfe eines TokenCredential-Elements.

Methoden

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, AddConfigurationSettingOptions)	Fügen Sie dem Azure App-Konfigurationsdienst eine Einstellung hinzu, wenn sie bereits vorhanden ist. Beispielverwendung: const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });
archiveSnapshot(string, UpdateSnapshotOptions)	Archivieren einer bereiten Momentaufnahme Beispielverwendung: const result = await client.archiveSnapshot({name: "MySnapshot"});
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)	Beginnt mit dem Erstellen einer Momentaufnahme für den Azure App-Konfigurationsdienst, schlägt fehl, wenn er bereits vorhanden ist.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)	Beginnt mit dem Erstellen einer Momentaufnahme für den Azure App-Konfigurationsdienst, wartet, bis er abgeschlossen ist, schlägt fehl, wenn er bereits vorhanden ist.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)	Löschen einer Einstellung aus dem Azure App-Konfigurationsdienst Beispielverwendung: const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)	Ruft eine Einstellung vom Azure App-Konfigurationsdienst ab. Beispielcode: const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
getSnapshot(string, GetSnapshotOptions)	Abrufen einer Momentaufnahme vom Azure App-Konfigurationsdienst Beispielverwendung: const result = await client.getSnapshot("MySnapshot");
listConfigurationSettings(ListConfigurationSettingsOptions)	Listet Einstellungen aus dem Azure App-Konfigurationsdienst auf, optional nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime gefiltert. Beispielcode: const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)	Listet Einstellungen aus dem Azure App-Konfigurationsdienst für Momentaufnahmen auf, die basierend auf dem Namen, optional nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime gefiltert werden. Beispielcode: const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
listLabels(ListLabelsOptions)	Abrufen einer Liste von Bezeichnungen aus dem Azure App-Konfigurationsdienst Beispielcode: const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
listRevisions(ListRevisionsOptions)	Listet Überarbeitungen einer Reihe von Schlüsseln auf, optional gefiltert nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime. Beispielcode: const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
listSnapshots(ListSnapshotsOptions)	Auflisten aller Momentaufnahmen aus dem Azure App-Konfigurationsdienst Beispielverwendung: const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)	Wiederherstellen einer archivierten Momentaufnahme zurück zum bereiten Status Beispielverwendung: const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)	Legt den Wert eines Schlüssels im Azure App-Konfigurationsdienst fest, der ein optionales etag zulässt.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)	Legt den schreibgeschützten Status eines Schlüssels fest oder löscht sie.
updateSyncToken(string)	Fügt ein externes Synchronisierungstoken hinzu, um sicherzustellen, dass Dienstanforderungen up-to-datumswerte empfangen.

Details zum Konstruktor

AppConfigurationClient(string, AppConfigurationClientOptions)

Initialisiert eine neue Instanz der AppConfigurationClient-Klasse.

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

Parameter

connectionString

string

Verbindungszeichenfolge, die für einen Client erforderlich ist, um eine Verbindung mit Azure herzustellen.

options

AppConfigurationClientOptions

Optionen für den AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

Initialisiert eine neue Instanz der AppConfigurationClient-Klasse mithilfe eines TokenCredential-Elements.

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

Parameter

endpoint

string

Der Endpunkt des App-Konfigurationsdiensts (z. B. https://sample.azconfig.io).

tokenCredential

TokenCredential

Ein Objekt, das die TokenCredential Schnittstelle implementiert, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird. Verwenden Sie das @azure/identity-Paket, um eine Anmeldeinformation zu erstellen, die Ihren Anforderungen entspricht.

options

AppConfigurationClientOptions

Optionen für den AppConfigurationClient.

Details zur Methode

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

Fügen Sie dem Azure App-Konfigurationsdienst eine Einstellung hinzu, wenn sie bereits vorhanden ist.

Beispielverwendung:

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

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

Parameter

configurationSetting

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

Eine Konfigurationseinstellung.

options

AddConfigurationSettingOptions

Optionale Parameter für die Anforderung.

Gibt zurück

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

Archivieren einer bereiten Momentaufnahme

Beispielverwendung:

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

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

Parameter

name

string

Der Name der Momentaufnahme.

options

UpdateSnapshotOptions

Optionale Parameter für die Anforderung.

Gibt zurück

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Beginnt mit dem Erstellen einer Momentaufnahme für den Azure App-Konfigurationsdienst, schlägt fehl, wenn er bereits vorhanden ist.

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

Parameter

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Gibt zurück

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Beginnt mit dem Erstellen einer Momentaufnahme für den Azure App-Konfigurationsdienst, wartet, bis er abgeschlossen ist, schlägt fehl, wenn er bereits vorhanden ist.

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

Parameter

snapshot

SnapshotInfo

options

CreateSnapshotOptions

Gibt zurück

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Löschen einer Einstellung aus dem Azure App-Konfigurationsdienst

Beispielverwendung:

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

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

Parameter

id

ConfigurationSettingId

Die ID der zu löschenden Konfigurationseinstellung.

options

DeleteConfigurationSettingOptions

Optionale Parameter für die Anforderung (z. B. etag, Label)

Gibt zurück

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Ruft eine Einstellung vom Azure App-Konfigurationsdienst ab.

Beispielcode:

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

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

Parameter

id

ConfigurationSettingId

Die ID der abzurufenden Konfigurationseinstellung.

options

GetConfigurationSettingOptions

Optionale Parameter für die Anforderung.

Gibt zurück

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Abrufen einer Momentaufnahme vom Azure App-Konfigurationsdienst

Beispielverwendung:

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

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

Parameter

name

string

Der Name der Momentaufnahme.

options

GetSnapshotOptions

Optionale Parameter für die Anforderung.

Gibt zurück

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

Listet Einstellungen aus dem Azure App-Konfigurationsdienst auf, optional nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime gefiltert.

Beispielcode:

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

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

Parameter

options

ListConfigurationSettingsOptions

Optionale Parameter für die Anforderung.

Gibt zurück

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

Listet Einstellungen aus dem Azure App-Konfigurationsdienst für Momentaufnahmen auf, die basierend auf dem Namen, optional nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime gefiltert werden.

Beispielcode:

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

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

Parameter

snapshotName

string

options

ListConfigurationSettingsForSnapshotOptions

Optionale Parameter für die Anforderung.

Gibt zurück

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Abrufen einer Liste von Bezeichnungen aus dem Azure App-Konfigurationsdienst

Beispielcode:

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

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

Parameter

options

ListLabelsOptions

Optionale Parameter für die Anforderung.

Gibt zurück

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

Listet Überarbeitungen einer Reihe von Schlüsseln auf, optional gefiltert nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime.

Beispielcode:

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

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

Parameter

options

ListRevisionsOptions

Optionale Parameter für die Anforderung.

Gibt zurück

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Auflisten aller Momentaufnahmen aus dem Azure App-Konfigurationsdienst

Beispielverwendung:

const result = await client.listSnapshots();

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

Parameter

options

ListSnapshotsOptions

Optionale Parameter für die Anforderung.

Gibt zurück

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

Wiederherstellen einer archivierten Momentaufnahme zurück zum bereiten Status

Beispielverwendung:

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

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

Parameter

name

string

Der Name der Momentaufnahme.

options

UpdateSnapshotOptions

Optionale Parameter für die Anforderung.

Gibt zurück

Promise<UpdateSnapshotResponse>

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

Legt den Wert eines Schlüssels im Azure App-Konfigurationsdienst fest, der ein optionales etag zulässt.

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

Parameter

configurationSetting

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

Ein Konfigurationswert.

options

SetConfigurationSettingOptions

Optionale Parameter für die Anforderung.

Beispielcode:

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

Gibt zurück

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Legt den schreibgeschützten Status eines Schlüssels fest oder löscht sie.

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

Parameter

id

ConfigurationSettingId

Die ID der zu ändernden Konfigurationseinstellung.

readOnly

boolean

options

SetReadOnlyOptions

Gibt zurück

Promise<SetReadOnlyResponse>

updateSyncToken(string)

Fügt ein externes Synchronisierungstoken hinzu, um sicherzustellen, dass Dienstanforderungen up-to-datumswerte empfangen.

function updateSyncToken(syncToken: string)

Parameter

syncToken

string

Der Wert des Synchronisierungstokens.