AppConfigurationClient class
Client für den Azure App-Konfigurationsdienst.
Konstruktoren
| App |
Initialisiert eine neue Instanz der AppConfigurationClient-Klasse. |
| App |
Initialisiert eine neue Instanz der AppConfigurationClient-Klasse mithilfe eines TokenCredential-Elements. |
Methoden
| add |
Fügen Sie dem Azure App-Konfigurationsdienst eine Einstellung hinzu, wenn sie bereits vorhanden ist. Beispielverwendung:
|
| archive |
Archivieren einer bereiten Momentaufnahme Beispielverwendung:
|
| begin |
Beginnt mit dem Erstellen einer Momentaufnahme für den Azure App-Konfigurationsdienst, schlägt fehl, wenn er bereits vorhanden ist. |
| begin |
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. |
| check |
Überprüft die Einstellungen des Azure App Configuration Service mittels einer HEAD-Anfrage und gibt nur Header ohne Antwortkörper zurück. Dies ist nützlich, um effizient zu überprüfen, ob sich die Einstellungen geändert haben, indem ETags verglichen werden. Beispielcode:
|
| delete |
Löschen einer Einstellung aus dem Azure App-Konfigurationsdienst Beispielverwendung:
|
| get |
Ruft eine Einstellung vom Azure App-Konfigurationsdienst ab. Beispielcode:
|
| get |
Abrufen einer Momentaufnahme vom Azure App-Konfigurationsdienst Beispielverwendung:
|
| list |
Listet Einstellungen aus dem Azure App-Konfigurationsdienst auf, optional nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime gefiltert. Beispielcode:
|
| list |
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:
|
| list |
Abrufen einer Liste von Bezeichnungen aus dem Azure App-Konfigurationsdienst Beispielcode:
|
| list |
Listet Überarbeitungen einer Reihe von Schlüsseln auf, optional gefiltert nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime. Beispielcode:
|
| list |
Auflisten aller Momentaufnahmen aus dem Azure App-Konfigurationsdienst Beispielverwendung:
|
| recover |
Wiederherstellen einer archivierten Momentaufnahme zurück zum bereiten Status Beispielverwendung:
|
| set |
Legt den Wert eines Schlüssels im Azure App-Konfigurationsdienst fest, der ein optionales etag zulässt. |
| set |
Legt den schreibgeschützten Status eines Schlüssels fest oder löscht sie. |
| update |
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
- 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> | AddConfigurationSettingParam<SnapshotReferenceValue>, AddConfigurationSettingOptions)
Fügen Sie dem Azure App-Konfigurationsdienst eine Einstellung hinzu, wenn sie bereits vorhanden ist.
Beispielverwendung:
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> | AddConfigurationSettingParam<SnapshotReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>
Parameter
- configurationSetting
-
AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>
Eine Konfigurationseinstellung.
- options
- AddConfigurationSettingOptions
Optionale Parameter für die Anforderung.
Gibt zurück
Promise<AddConfigurationSettingResponse>
archiveSnapshot(string, UpdateSnapshotOptions)
Archivieren einer bereiten Momentaufnahme
Beispielverwendung:
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>
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>
checkConfigurationSettings(CheckConfigurationSettingsOptions)
Überprüft die Einstellungen des Azure App Configuration Service mittels einer HEAD-Anfrage und gibt nur Header ohne Antwortkörper zurück. Dies ist nützlich, um effizient zu überprüfen, ob sich die Einstellungen geändert haben, indem ETags verglichen werden.
Beispielcode:
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 pageIterator = client.checkConfigurationSettings({ keyFilter: "MyKey" }).byPage();
function checkConfigurationSettings(options?: CheckConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>
Parameter
Optionale Parameter für die Anforderung.
Gibt zurück
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)
Löschen einer Einstellung aus dem Azure App-Konfigurationsdienst
Beispielverwendung:
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>
Parameter
Die ID der zu löschenden Konfigurationseinstellung.
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:
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>
Parameter
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:
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>
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:
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>
Parameter
- options
- ListConfigurationSettingsOptions
Optionale Parameter für die Anforderung.
Gibt zurück
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:
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>
Parameter
- snapshotName
-
string
Optionale Parameter für die Anforderung.
Gibt zurück
listLabels(ListLabelsOptions)
Abrufen einer Liste von Bezeichnungen aus dem Azure App-Konfigurationsdienst
Beispielcode:
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>
Parameter
- options
- ListLabelsOptions
Optionale Parameter für die Anforderung.
Gibt zurück
listRevisions(ListRevisionsOptions)
Listet Überarbeitungen einer Reihe von Schlüsseln auf, optional gefiltert nach Schlüsselnamen, Bezeichnungen und Akzeptieren von Datetime.
Beispielcode:
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>
Parameter
- options
- ListRevisionsOptions
Optionale Parameter für die Anforderung.
Gibt zurück
listSnapshots(ListSnapshotsOptions)
Auflisten aller Momentaufnahmen aus dem Azure App-Konfigurationsdienst
Beispielverwendung:
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>
Parameter
- options
- ListSnapshotsOptions
Optionale Parameter für die Anforderung.
Gibt zurück
recoverSnapshot(string, UpdateSnapshotOptions)
Wiederherstellen einer archivierten Momentaufnahme zurück zum bereiten Status
Beispielverwendung:
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>
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> | SetConfigurationSettingParam<SnapshotReferenceValue>, 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> | SetConfigurationSettingParam<SnapshotReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>
Parameter
- configurationSetting
-
SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue> | SetConfigurationSettingParam<SnapshotReferenceValue>
Ein Konfigurationswert.
- options
- SetConfigurationSettingOptions
Optionale Parameter für die Anforderung.
Beispielcode:
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" });
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
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.