@azure/app-configuration package
Třídy
| AppConfigurationClient |
Klient pro službu Azure App Configuration. |
Rozhraní
| AddConfigurationSettingOptions |
Možnosti používané při přidávání konfiguračního nastavení |
| AddConfigurationSettingResponse |
Odpověď z přidání konfiguračního nastavení |
| AppConfigurationClientOptions |
Poskytuje možnosti konfigurace pro AppConfigurationClient. |
| ConfigurationSettingId |
Pole, která jednoznačně identifikují nastavení konfigurace |
| ConfigurationSettingsFilter |
Umožňuje filtrování hodnot klíče. Referenční dokumentace syntaxe: https://aka.ms/azconfig/docs/restapisnapshots |
| ConfigurationSnapshot |
Podrobnosti o snímku zahrnují název, filtry, vypršení platnosti, velikostInBytes, stav, itemCount a další |
| CreateSnapshotOptions |
Možnosti používané při vytváření snímku |
| CreateSnapshotResponse |
Odpověď z aktualizace snímku |
| DeleteConfigurationSettingOptions |
Možnosti pro odstranění konfiguračního nastavení |
| DeleteConfigurationSettingResponse |
Odpověď z odstranění konfiguračního nastavení |
| EtagEntity |
Entita se značkou etag |
| FeatureFlagValue |
Hodnota příznaku funkce |
| GetConfigurationHeaders |
Hlavičky ze získání konfiguračního nastavení |
| GetConfigurationSettingOptions |
Možnosti získání konfiguračního nastavení |
| GetConfigurationSettingResponse |
Odpověď z načtení konfiguračního nastavení |
| GetSnapshotOptions |
Možnosti používané při získávání snímku |
| GetSnapshotResponse |
Odpověď z získání snímku |
| HttpOnlyIfChangedField |
Možnosti použité k zadání shody typu if-none-match pro požadavek HTTP |
| HttpOnlyIfUnchangedField |
Možnosti používané k zadání shody if-match pro požadavek HTTP |
| HttpResponseField |
Informace související s odpovědí HTTP – hlavičky a nezpracované tělo |
| HttpResponseFields |
Pole, která jsou vychytána z pole _response objektu Použité v případech, kdy jsou jednotlivá pole odpovědí HTTP důležitá pro uživatele, aby používal v běžných případech použití, jako je zpracování stavových kódů HTTP 204 nebo 304. |
| ListConfigurationSettingPage |
Stránka nastavení konfigurace a odpovídající odpověď HTTP |
| ListConfigurationSettingsForSnapshotOptions |
Běžné možnosti rozhraní API stylu "list" v AppConfig, která slouží k zadání zástupných znaků a hlavičky pro přijetí data a času. |
| ListConfigurationSettingsOptions |
Možnosti pro listConfigurationSettings, které umožňují filtrování na základě klíčů, popisků a dalších polí.
Poskytuje také |
| ListLabelsOptions |
Možnosti pro listLabels |
| ListLabelsPage |
Stránka nastavení konfigurace a odpovídající odpověď HTTP |
| ListRevisionsOptions |
Možnosti pro listRevisions, které umožňují filtrování na základě klíčů, popisků a dalších polí.
Poskytuje také |
| ListRevisionsPage |
Stránka nastavení konfigurace a odpovídající odpověď HTTP |
| ListSettingsOptions |
Běžné možnosti rozhraní API stylu "list" v AppConfig, která slouží k zadání zástupných znaků a hlavičky pro přijetí data a času. |
| ListSnapshots |
Běžné možnosti rozhraní API stylu "list" v AppConfig, která slouží k zadání zástupných znaků a hlavičky pro přijetí data a času. |
| ListSnapshotsOptions |
Možnosti pro listConfigurationSettings, které umožňují filtrování na základě klíčů, popisků a dalších polí.
Poskytuje také |
| ListSnapshotsPage |
Stránka nastavení konfigurace a odpovídající odpověď HTTP |
| OptionalFields |
Používá se, když rozhraní API podporuje selektivně vracející pole. |
| OptionalLabelsFields |
Používá se, když rozhraní API podporuje selektivně vracející pole popisků. |
| OptionalSnapshotFields |
Používá se, když rozhraní API podporuje selektivně vracející pole. |
| PageSettings |
Rozhraní, které sleduje nastavení stránkované iterace |
| RetryOptions |
Možnosti, které řídí, jak opakovat neúspěšné požadavky. |
| SecretReferenceValue |
Potřebná pole pro aktualizaci nebo vytvoření nového odkazu na tajný kód |
| SetConfigurationSettingOptions |
Možnosti používané při ukládání konfiguračního nastavení |
| SetConfigurationSettingResponse |
Odpověď z nastavení ConfigurationSetting. |
| SetReadOnlyOptions |
Možnosti pro setReadOnly |
| SetReadOnlyResponse |
Odpověď při nastavování hodnoty jen pro čtení |
| SettingLabel |
Podrobnosti popisku s vlastností názvu, která se dá naplnit pouze serverem |
| SnapshotInfo |
Pole, která jednoznačně identifikují snímek |
| SnapshotResponse |
Odpověď od přidání snímku |
| SyncTokenHeaderField |
Pole záhlaví tokenu synchronizace |
| UpdateSnapshotOptions |
Možnosti používané při aktualizaci snímku |
| UpdateSnapshotResponse |
Odpověď z aktualizace snímku |
Aliasy typu
| AddConfigurationSettingParam |
Parametry pro přidání nového nastavení konfigurace |
| ConfigurationSetting |
Nastavení konfigurace s dalšími metadaty ze serveru, které označuje jeho značku, zda je aktuálně jen pro čtení a kdy byla naposledy změněna. |
| ConfigurationSettingParam |
Potřebná pole pro aktualizaci nebo vytvoření nového nastavení konfigurace |
| ConfigurationSettingResponse |
Standardní základní odpověď pro získání, odstranění nebo aktualizaci nastavení konfigurace |
| ConfigurationSnapshotStatus |
Definuje hodnoty pro ConfigurationSnapshotStatus. Známé hodnoty podporované službou
zřizování |
| SetConfigurationSettingParam |
Parametry pro vytvoření nebo aktualizaci nového nastavení konfigurace |
| SnapshotComposition |
Definuje hodnoty pro SnapshotComposition. Známé hodnoty podporované službou
klíč |
Výčty
| KnownConfigurationSnapshotStatus |
Známé hodnoty ConfigurationSnapshotStatus, které služba přijímá. |
| KnownSnapshotComposition |
Známé hodnoty SnapshotComposition, které služba přijímá. |
Funkce
| is |
Dáte vědět, jestli je ConfigurationSetting příznakem funkce. [Zkontroluje, jestli je typ obsahu featureFlagContentType |
| is |
Dáte vědět, jestli je ConfigurationSetting odkazem na tajný kód. [Zkontroluje, jestli je typ obsahu secretReferenceContentType |
| parse |
Vezme ConfigurationSetting jako vstup a vrátí ConfigurationSetting parsováním řetězce hodnoty. |
| parse |
Vezme ConfigurationSetting jako vstup a vrátí ConfigurationSetting parsováním řetězce hodnoty. |
Podrobnosti funkce
isFeatureFlag(ConfigurationSetting<string>)
Dáte vědět, jestli je ConfigurationSetting příznakem funkce.
[Zkontroluje, jestli je typ obsahu featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
function isFeatureFlag(setting: ConfigurationSetting<string>): settingParametry
- setting
-
ConfigurationSetting<string>
Návraty
setting
isSecretReference(ConfigurationSetting<string>)
Dáte vědět, jestli je ConfigurationSetting odkazem na tajný kód.
[Zkontroluje, jestli je typ obsahu secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
function isSecretReference(setting: ConfigurationSetting<string>): settingParametry
- setting
-
ConfigurationSetting<string>
Návraty
setting
parseFeatureFlag(ConfigurationSetting<string>)
Vezme ConfigurationSetting jako vstup a vrátí ConfigurationSetting parsováním řetězce hodnoty.
function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>Parametry
- setting
-
ConfigurationSetting<string>
Návraty
parseSecretReference(ConfigurationSetting<string>)
Vezme ConfigurationSetting jako vstup a vrátí ConfigurationSetting parsováním řetězce hodnoty.
function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>Parametry
- setting
-
ConfigurationSetting<string>