Freigeben über

@azure/app-configuration package

  • Referenz

Klassen

AppConfigurationClient

Client für den Azure App-Konfigurationsdienst.

Schnittstellen

AddConfigurationSettingOptions

Optionen, die beim Hinzufügen eines ConfigurationSetting verwendet werden.
AddConfigurationSettingResponse

Antwort vom Hinzufügen eines ConfigurationSetting-
AppConfigurationClientOptions

Stellt Konfigurationsoptionen für AppConfigurationClient bereit.
ConfigurationSettingId

Felder, die eine Konfigurationseinstellung eindeutig identifizieren
ConfigurationSettingsFilter

Aktiviert das Filtern von Schlüsselwerten. Syntaxreferenz: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot

Momentaufnahmendetails umfassen Name, Filter, ExpiresOn, sizeInBytes, Status, itemCount und mehr
CreateSnapshotOptions

Optionen, die beim Erstellen einer Momentaufnahme verwendet werden.
CreateSnapshotResponse

Antwort vom Aktualisieren einer Momentaufnahme.
DeleteConfigurationSettingOptions

Optionen zum Löschen eines ConfigurationSetting.
DeleteConfigurationSettingResponse

Antwort vom Löschen eines ConfigurationSettings.
EtagEntity

Entität mit etag.
FeatureFlagValue

Wert eines Featurekennzeichnungs
GetConfigurationHeaders

Kopfzeilen vom Abrufen eines ConfigurationSettings.
GetConfigurationSettingOptions

Optionen zum Abrufen eines ConfigurationSetting-
GetConfigurationSettingResponse

Antwort vom Abrufen eines ConfigurationSetting-
GetSnapshotOptions

Optionen, die beim Abrufen einer Momentaufnahme verwendet werden.
GetSnapshotResponse

Antwort vom Abrufen einer Momentaufnahme.
HttpOnlyIfChangedField

Optionen zum Bereitstellen einer If-None-Übereinstimmung für eine HTTP-Anforderung
HttpOnlyIfUnchangedField

Optionen, die verwendet werden, um eine IF-Übereinstimmung für eine HTTP-Anforderung bereitzustellen
HttpResponseField

HTTP-Antwortbezogene Informationen – Header und unformatierter Text.
HttpResponseFields

Felder, die aus dem _response Feld des Objekts heraufgehäuft werden. In Fällen, in denen einzelne HTTP-Antwortfelder für den Benutzer wichtig sind, in häufig verwendeten Fällen wie der Umgang mit http-Statuscodes 204 oder 304 zu verwenden.
ListConfigurationSettingPage

Eine Seite mit Konfigurationseinstellungen und der entsprechenden HTTP-Antwort
ListConfigurationSettingsForSnapshotOptions

Allgemeine Optionen für APIs im Listenstil in AppConfig, die zum Angeben von Wildcards sowie zum Akzeptieren des Datums-Uhrzeit-Headers verwendet werden.
ListConfigurationSettingsOptions

Optionen für listConfigurationSettings, die das Filtern basierend auf Schlüsseln, Bezeichnungen und anderen Feldern ermöglichen. Bietet außerdem fields, mit denen Sie selektiv auswählen können, welche Felder im Ergebnis aufgefüllt werden.
ListLabelsOptions

Optionen für listLabels
ListLabelsPage

Eine Seite mit Konfigurationseinstellungen und der entsprechenden HTTP-Antwort
ListRevisionsOptions

Optionen für listRevisions, die das Filtern basierend auf Schlüsseln, Bezeichnungen und anderen Feldern ermöglichen. Bietet außerdem fields, mit denen Sie selektiv auswählen können, welche Felder im Ergebnis aufgefüllt werden.
ListRevisionsPage

Eine Seite mit Konfigurationseinstellungen und der entsprechenden HTTP-Antwort
ListSettingsOptions

Allgemeine Optionen für APIs im Listenstil in AppConfig, die zum Angeben von Wildcards sowie zum Akzeptieren des Datums-Uhrzeit-Headers verwendet werden.
ListSnapshots

Allgemeine Optionen für APIs im Listenstil in AppConfig, die zum Angeben von Wildcards sowie zum Akzeptieren des Datums-Uhrzeit-Headers verwendet werden.
ListSnapshotsOptions

Optionen für listConfigurationSettings, die das Filtern basierend auf Schlüsseln, Bezeichnungen und anderen Feldern ermöglichen. Bietet außerdem fields, mit denen Sie selektiv auswählen können, welche Felder im Ergebnis aufgefüllt werden.
ListSnapshotsPage

Eine Seite mit Konfigurationseinstellungen und der entsprechenden HTTP-Antwort
OptionalFields

Wird verwendet, wenn die API selektiv zurückgegebene Felder unterstützt.
OptionalLabelsFields

Wird verwendet, wenn die API das selektive Zurückgeben von Bezeichnungsfeldern unterstützt.
OptionalSnapshotFields

Wird verwendet, wenn die API selektiv zurückgegebene Felder unterstützt.
PageSettings

Eine Schnittstelle, die die Einstellungen für die seitenseitige Iteration nachverfolgt
RetryOptions

Optionen, die steuern, wie fehlgeschlagene Anforderungen wiederholt werden.
SecretReferenceValue

Erforderliche Felder zum Aktualisieren oder Erstellen eines neuen geheimen Verweises.
SetConfigurationSettingOptions

Optionen, die beim Speichern eines ConfigurationSetting verwendet werden.
SetConfigurationSettingResponse

Antwort vom Festlegen eines ConfigurationSetting-
SetReadOnlyOptions

Optionen für setReadOnly
SetReadOnlyResponse

Antwort beim Festlegen eines Werts auf schreibgeschützt.
SettingLabel

Bezeichnungsdetails mit Name-Eigenschaft, die nur vom Server aufgefüllt werden kann
SnapshotInfo

Felder, die eine Momentaufnahme eindeutig identifizieren
SnapshotResponse

Antwort vom Hinzufügen einer Momentaufnahme.
SyncTokenHeaderField

Synchronisierungstokenkopffeld
UpdateSnapshotOptions

Optionen, die beim Aktualisieren einer Momentaufnahme verwendet werden.
UpdateSnapshotResponse

Antwort vom Aktualisieren einer Momentaufnahme.

Typaliase

AddConfigurationSettingParam

Parameter zum Hinzufügen einer neuen Konfigurationseinstellung
ConfigurationSetting

Konfigurationseinstellung mit zusätzlichen Metadaten vom Server, die angibt, ob es aktuell gelesen Und wann sie zuletzt geändert wurde.
ConfigurationSettingParam

Erforderliche Felder zum Aktualisieren oder Erstellen einer neuen Konfigurationseinstellung
ConfigurationSettingResponse

Standardbasisantwort zum Abrufen, Löschen oder Aktualisieren einer Konfigurationseinstellung
ConfigurationSnapshotStatus

Definiert Werte für ConfigurationSnapshotStatus.
KnownConfigurationSnapshotStatus- austauschbar mit ConfigurationSnapshotStatus verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Bereitstellungs-
bereit
archivierte
fehler beim

SetConfigurationSettingParam

Parameter zum Erstellen oder Aktualisieren einer neuen Konfigurationseinstellung
SnapshotComposition

Definiert Werte für SnapshotComposition.
KnownSnapshotComposition austauschbar mit SnapshotComposition verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

-Taste
key_label

Enumerationen

KnownConfigurationSnapshotStatus

Bekannte Werte von ConfigurationSnapshotStatus, die der Dienst akzeptiert.
KnownSnapshotComposition

Bekannte Werte von SnapshotComposition, die der Dienst akzeptiert.

Functions

isFeatureFlag(ConfigurationSetting<string>)

Teilt Ihnen mit, ob ConfigurationSetting ein Feature-Flag ist.

[Überprüft, ob der Inhaltstyp featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)

Teilt Ihnen mit, ob configurationSetting ein geheimer Verweis ist.

[Überprüft, ob der Inhaltstyp secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)

Verwendet ConfigurationSetting als Eingabe und gibt das ConfigurationSetting zurück, indem die Wertzeichenfolge analysiert wird.
parseSecretReference(ConfigurationSetting<string>)

Verwendet ConfigurationSetting als Eingabe und gibt das ConfigurationSetting zurück, indem die Wertzeichenfolge analysiert wird.

Details zur Funktion

isFeatureFlag(ConfigurationSetting<string>)

Teilt Ihnen mit, ob ConfigurationSetting ein Feature-Flag ist.

[Überprüft, ob der Inhaltstyp featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

function isFeatureFlag(setting: ConfigurationSetting<string>): setting

Parameter

setting

ConfigurationSetting<string>

Gibt zurück

setting

isSecretReference(ConfigurationSetting<string>)

Teilt Ihnen mit, ob configurationSetting ein geheimer Verweis ist.

[Überprüft, ob der Inhaltstyp secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

function isSecretReference(setting: ConfigurationSetting<string>): setting

Parameter

setting

ConfigurationSetting<string>

Gibt zurück

setting

parseFeatureFlag(ConfigurationSetting<string>)

Verwendet ConfigurationSetting als Eingabe und gibt das ConfigurationSetting zurück, indem die Wertzeichenfolge analysiert wird.

function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>

Parameter

setting

ConfigurationSetting<string>

Gibt zurück

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Verwendet ConfigurationSetting als Eingabe und gibt das ConfigurationSetting zurück, indem die Wertzeichenfolge analysiert wird.

function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>

Parameter

setting

ConfigurationSetting<string>

Gibt zurück

ConfigurationSetting<SecretReferenceValue>