Udostępnij przez

@azure/app-configuration package

Klasy

AppConfigurationClient

Klient usługi Azure App Configuration.

Interfejsy

AddConfigurationSettingOptions

Opcje używane podczas dodawania elementu ConfigurationSetting.
AddConfigurationSettingResponse

Odpowiedź z dodawania elementu ConfigurationSetting.
AppConfigurationClientOptions

Udostępnia opcje konfiguracji dla klasy AppConfigurationClient.
ConfigurationSettingId

Pola, które jednoznacznie identyfikują ustawienie konfiguracji
ConfigurationSettingsFilter

Umożliwia filtrowanie wartości klucz-wartość. Dokumentacja składni: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot

Szczegóły migawki obejmują nazwę, filtry, wygasanie, rozmiarInBytes, stan, elementCount i inne
CreateSnapshotOptions

Opcje używane podczas tworzenia migawki.
CreateSnapshotResponse

Odpowiedź z aktualizacji migawki.
DeleteConfigurationSettingOptions

Opcje usuwania konfiguracjiUstawienia.
DeleteConfigurationSettingResponse

Odpowiedź z usunięcia konfiguracjiUstawienia.
EtagEntity

Jednostka z tagiem etag.
FeatureFlagValue

Wartość flagi funkcji
GetConfigurationHeaders

Nagłówki z pobierania elementu ConfigurationSetting.
GetConfigurationSettingOptions

Opcje pobierania konfiguracjiUstawienia.
GetConfigurationSettingResponse

Odpowiedź z pobierania konfiguracjiUstawienia.
GetSnapshotOptions

Opcje używane podczas pobierania migawki.
GetSnapshotResponse

Odpowiedź z pobierania migawki.
HttpOnlyIfChangedField

Opcje używane do podawania elementu if-none-match dla żądania HTTP
HttpOnlyIfUnchangedField

Opcje używane do zapewnienia dopasowania if-match dla żądania HTTP
HttpResponseField

Informacje dotyczące odpowiedzi HTTP — nagłówki i nieprzetworzona treść.
HttpResponseFields

Pola, które są wychywane z pola _response obiektu Używane w przypadkach, gdy poszczególne pola odpowiedzi HTTP są ważne dla użytkownika do użycia w typowych przypadkach użycia, takich jak obsługa kodów stanu HTTP 204 lub 304.
ListConfigurationSettingPage

Strona ustawień konfiguracji i odpowiadająca jej odpowiedź HTTP
ListConfigurationSettingsForSnapshotOptions

Typowe opcje interfejsów API stylu "list" w aplikacji AppConfig używane do określania symboli wieloznacznych, a także nagłówka akceptowania daty i godziny.
ListConfigurationSettingsOptions

Opcje listConfigurationSettings, które umożliwiają filtrowanie na podstawie kluczy, etykiet i innych pól. Ponadto udostępnia fields, które umożliwiają selektywne wybieranie pól, które są wypełniane w wyniku.
ListLabelsOptions

Opcje listLabels
ListLabelsPage

Strona ustawień konfiguracji i odpowiadająca jej odpowiedź HTTP
ListRevisionsOptions

Opcje listRevisions, które umożliwiają filtrowanie na podstawie kluczy, etykiet i innych pól. Ponadto udostępnia fields, które umożliwiają selektywne wybieranie pól, które są wypełniane w wyniku.
ListRevisionsPage

Strona ustawień konfiguracji i odpowiadająca jej odpowiedź HTTP
ListSettingsOptions

Typowe opcje interfejsów API stylu "list" w aplikacji AppConfig używane do określania symboli wieloznacznych, a także nagłówka akceptowania daty i godziny.
ListSnapshots

Typowe opcje interfejsów API stylu "list" w aplikacji AppConfig używane do określania symboli wieloznacznych, a także nagłówka akceptowania daty i godziny.
ListSnapshotsOptions

Opcje listConfigurationSettings, które umożliwiają filtrowanie na podstawie kluczy, etykiet i innych pól. Ponadto udostępnia fields, które umożliwiają selektywne wybieranie pól, które są wypełniane w wyniku.
ListSnapshotsPage

Strona ustawień konfiguracji i odpowiadająca jej odpowiedź HTTP
OptionalFields

Używany, gdy interfejs API obsługuje selektywne zwracanie pól.
OptionalLabelsFields

Używany, gdy interfejs API obsługuje selektywne zwracanie pól etykiet.
OptionalSnapshotFields

Używany, gdy interfejs API obsługuje selektywne zwracanie pól.
PageSettings

Interfejs śledzący ustawienia iteracji stronicowanej
RetryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
SecretReferenceValue

Wymagane pola do aktualizowania lub tworzenia nowego odwołania do wpisu tajnego.
SetConfigurationSettingOptions

Opcje używane podczas zapisywania konfiguracjiUstawienia.
SetConfigurationSettingResponse

Odpowiedź z ustawienia configurationSetting.
SetReadOnlyOptions

Opcje setReadOnly
SetReadOnlyResponse

Odpowiedź podczas ustawiania wartości tylko do odczytu.
SettingLabel

Szczegóły etykiety z właściwością nazwy, którą można wypełnić tylko przez serwer
SnapshotInfo

Pola, które jednoznacznie identyfikują migawkę
SnapshotReferenceValue

Pola niezbędne do aktualizowania lub tworzenia nowego odniesienia do migawki.
SnapshotResponse

Odpowiedź z dodawania migawki.
SyncTokenHeaderField

Synchronizowanie pola nagłówka tokenu
UpdateSnapshotOptions

Opcje używane podczas aktualizowania migawki.
UpdateSnapshotResponse

Odpowiedź z aktualizacji migawki.

Aliasy typu

AddConfigurationSettingParam

Parametry dodawania nowego ustawienia konfiguracji
ConfigurationSetting

Ustawienie konfiguracji z dodatkowymi metadanymi z serwera, wskazujące jego element etag, czy jest on obecnie readOnly i kiedy został ostatnio zmodyfikowany.
ConfigurationSettingParam

Wymagane pola do aktualizowania lub tworzenia nowego ustawienia konfiguracji
ConfigurationSettingResponse

Standardowa odpowiedź podstawowa na potrzeby pobierania, usuwania lub aktualizowania ustawienia konfiguracji
ConfigurationSnapshotStatus

Definiuje wartości configurationSnapshotStatus.
KnownConfigurationSnapshotStatus można używać zamiennie z parametrem ConfigurationSnapshotStatus. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

aprowizacja
gotowe
zarchiwizowane
nie powiodło się
SetConfigurationSettingParam

Parametry tworzenia lub aktualizowania nowego ustawienia konfiguracji
SnapshotComposition

Definiuje wartości snapshotComposition.
KnownSnapshotComposition można używać zamiennie z elementem SnapshotComposition, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

klucz
key_label

Wyliczenia

KnownAppConfigAudience

Znane wartości odbiorców usługi Azure App Configuration
KnownConfigurationSnapshotStatus

Znane wartości ConfigurationSnapshotStatus, które akceptuje usługa.
KnownSnapshotComposition

Znane wartości SnapshotComposition akceptowane przez usługę.

Funkcje

isFeatureFlag(ConfigurationSetting<string>)

Informuje, czy ustawienie ConfigurationSetting jest flagą funkcji.

[Sprawdza, czy typ zawartości to featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)

Informuje o tym, czy element ConfigurationSetting jest odwołaniem tajnym.

[Sprawdza, czy typ zawartości to secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
isSnapshotReference(ConfigurationSetting<string>)

Informuje o tym, czy ConfigurationSetting jest odwołaniem do migawki.

[Sprawdza, czy typ zawartości to snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<FeatureFlagValue> przez przeanalizowanie ciągu wartości.
parseSecretReference(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<SecretReferenceValue> przez przeanalizowanie ciągu wartości.
parseSnapshotReference(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<SnapshotReferenceValue> przez przeanalizowanie ciągu wartości.

Szczegóły funkcji

isFeatureFlag(ConfigurationSetting<string>)

Informuje, czy ustawienie ConfigurationSetting jest flagą funkcji.

[Sprawdza, czy typ zawartości to featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

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

Parametry

setting

ConfigurationSetting<string>

Zwraca

setting

isSecretReference(ConfigurationSetting<string>)

Informuje o tym, czy element ConfigurationSetting jest odwołaniem tajnym.

[Sprawdza, czy typ zawartości to secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

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

Parametry

setting

ConfigurationSetting<string>

Zwraca

setting

isSnapshotReference(ConfigurationSetting<string>)

Informuje o tym, czy ConfigurationSetting jest odwołaniem do migawki.

[Sprawdza, czy typ zawartości to snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]

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

Parametry

setting

ConfigurationSetting<string>

Zwraca

setting

parseFeatureFlag(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<FeatureFlagValue> przez przeanalizowanie ciągu wartości.

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

Parametry

setting

ConfigurationSetting<string>

Zwraca

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<SecretReferenceValue> przez przeanalizowanie ciągu wartości.

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

Parametry

setting

ConfigurationSetting<string>

Zwraca

ConfigurationSetting<SecretReferenceValue>

parseSnapshotReference(ConfigurationSetting<string>)

Przyjmuje ConfigurationSetting jako dane wejściowe i zwraca ConfigurationSetting<SnapshotReferenceValue> przez przeanalizowanie ciągu wartości.

function parseSnapshotReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SnapshotReferenceValue>

Parametry

setting

ConfigurationSetting<string>

Zwraca

ConfigurationSetting<SnapshotReferenceValue>