@azure/app-configuration package

Klasser

AppConfigurationClient

Klient för Azure App Configuration-tjänsten.

Gränssnitt

AddConfigurationSettingOptions	Alternativ som används när du lägger till en ConfigurationSetting.
AddConfigurationSettingResponse	Svar från att lägga till en ConfigurationSetting.
AppConfigurationClientOptions	Tillhandahåller konfigurationsalternativ för AppConfigurationClient.
ConfigurationSettingId	Fält som unikt identifierar en konfigurationsinställning
ConfigurationSettingsFilter	Möjliggör filtrering av nyckelvärden. Syntaxreferens: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot	Information om ögonblicksbilder omfattar namn, filter, expiresOn, sizeInBytes, status, itemCount med mera
CreateSnapshotOptions	Alternativ som används när du skapar en ögonblicksbild.
CreateSnapshotResponse	Svar från uppdatering av en ögonblicksbild.
DeleteConfigurationSettingOptions	Alternativ för att ta bort en ConfigurationSetting.
DeleteConfigurationSettingResponse	Svar från att ta bort en ConfigurationSetting.
EtagEntity	Entitet med etag.
FeatureFlagValue	Värdet för en funktionsflagga
GetConfigurationHeaders	Huvuden från att hämta en ConfigurationSetting.
GetConfigurationSettingOptions	Alternativ för att hämta en ConfigurationSetting.
GetConfigurationSettingResponse	Svar från att hämta en ConfigurationSetting.
GetSnapshotOptions	Alternativ som används när du hämtar en ögonblicksbild.
GetSnapshotResponse	Svar från att hämta en ögonblicksbild.
HttpOnlyIfChangedField	Alternativ som används för att ange if-none-match för en HTTP-begäran
HttpOnlyIfUnchangedField	Alternativ som används för att ange if-match för en HTTP-begäran
HttpResponseField	HTTP-svarsrelaterad information – rubriker och rå brödtext.
HttpResponseFields	Fält som lyfts upp från det _response fältet för objektet Används i de fall där enskilda HTTP-svarsfält är viktiga för användaren att använda i vanliga användningsfall som hantering av http-statuskoder 204 eller 304.
ListConfigurationSettingPage	En sida med konfigurationsinställningar och motsvarande HTTP-svar
ListConfigurationSettingsForSnapshotOptions	Vanliga alternativ för API:er för listformat i AppConfig som används för att ange jokertecken samt sidhuvudet acceptera datumtid.
ListConfigurationSettingsOptions	Alternativ för listConfigurationSettings som tillåter filtrering baserat på nycklar, etiketter och andra fält. Ger också fields som gör att du selektivt kan välja vilka fält som ska fyllas i i resultatet.
ListLabelsOptions	Alternativ för listLabels
ListLabelsPage	En sida med konfigurationsinställningar och motsvarande HTTP-svar
ListRevisionsOptions	Alternativ för listRevisioner som tillåter filtrering baserat på nycklar, etiketter och andra fält. Ger också fields som gör att du selektivt kan välja vilka fält som ska fyllas i i resultatet.
ListRevisionsPage	En sida med konfigurationsinställningar och motsvarande HTTP-svar
ListSettingsOptions	Vanliga alternativ för API:er för listformat i AppConfig som används för att ange jokertecken samt sidhuvudet acceptera datumtid.
ListSnapshots	Vanliga alternativ för API:er för listformat i AppConfig som används för att ange jokertecken samt sidhuvudet acceptera datumtid.
ListSnapshotsOptions	Alternativ för listConfigurationSettings som tillåter filtrering baserat på nycklar, etiketter och andra fält. Ger också fields som gör att du selektivt kan välja vilka fält som ska fyllas i i resultatet.
ListSnapshotsPage	En sida med konfigurationsinställningar och motsvarande HTTP-svar
OptionalFields	Används när API:et stöder selektivt returnerade fält.
OptionalLabelsFields	Används när API:et stöder selektivt returnerade etiketter.
OptionalSnapshotFields	Används när API:et stöder selektivt returnerade fält.
PageSettings	Ett gränssnitt som spårar inställningarna för sidsidig iteration
RetryOptions	Alternativ som styr hur du försöker utföra misslyckade begäranden igen.
SecretReferenceValue	Nödvändiga fält för att uppdatera eller skapa en ny hemlig referens.
SetConfigurationSettingOptions	Alternativ som används när du sparar en ConfigurationSetting.
SetConfigurationSettingResponse	Svar från att ange en ConfigurationSetting.
SetReadOnlyOptions	Alternativ för setReadOnly
SetReadOnlyResponse	Svar när du anger ett värde till skrivskyddat.
SettingLabel	Etikettinformation med namnegenskap som bara kan fyllas i av servern
SnapshotInfo	Fält som unikt identifierar en ögonblicksbild
SnapshotResponse	Svar från att lägga till en ögonblicksbild.
SyncTokenHeaderField	Fält för sidhuvud för synkroniseringstoken
UpdateSnapshotOptions	Alternativ som används vid uppdatering av en ögonblicksbild.
UpdateSnapshotResponse	Svar från uppdatering av en ögonblicksbild.

Typalias

AddConfigurationSettingParam	Parametrar för att lägga till en ny konfigurationsinställning
ConfigurationSetting	Konfigurationsinställning med extra metadata från servern, som anger dess etag, om den för närvarande är readOnly och när den senast ändrades.
ConfigurationSettingParam	Nödvändiga fält för att uppdatera eller skapa en ny konfigurationsinställning
ConfigurationSettingResponse	Standardbassvar för att hämta, ta bort eller uppdatera en konfigurationsinställning
ConfigurationSnapshotStatus	Definierar värden för ConfigurationSnapshotStatus. KnownConfigurationSnapshotStatus kan användas utbytbart med ConfigurationSnapshotStatus innehåller den här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten etablering redo arkiverade misslyckades
SetConfigurationSettingParam	Parametrar för att skapa eller uppdatera en ny konfigurationsinställning
SnapshotComposition	Definierar värden för SnapshotComposition. KnownSnapshotComposition kan användas utbytbart med SnapshotComposition innehåller det här uppräkningen de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten nyckel key_label

Uppräkningar

KnownConfigurationSnapshotStatus	Kända värden för ConfigurationSnapshotStatus som tjänsten accepterar.
KnownSnapshotComposition	Kända värden för SnapshotComposition som tjänsten accepterar.

Funktioner

isFeatureFlag(ConfigurationSetting<string>)	Meddelar dig om ConfigurationSetting är en funktionsflagga. [Kontrollerar om innehållstypen är featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)	Meddelar dig om ConfigurationSetting är en hemlig referens. [Kontrollerar om innehållstypen är secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)	Tar ConfigurationSetting som indata och returnerar ConfigurationSetting genom att parsa värdesträngen.
parseSecretReference(ConfigurationSetting<string>)	Tar ConfigurationSetting som indata och returnerar ConfigurationSetting genom att parsa värdesträngen.

Funktionsinformation

isFeatureFlag(ConfigurationSetting<string>)

Meddelar dig om ConfigurationSetting är en funktionsflagga.

[Kontrollerar om innehållstypen är featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

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

Parametrar

setting

ConfigurationSetting<string>

Returer

setting

isSecretReference(ConfigurationSetting<string>)

Meddelar dig om ConfigurationSetting är en hemlig referens.

[Kontrollerar om innehållstypen är secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

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

Parametrar

setting

ConfigurationSetting<string>

Returer

setting

parseFeatureFlag(ConfigurationSetting<string>)

Tar ConfigurationSetting som indata och returnerar ConfigurationSetting genom att parsa värdesträngen.

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

Parametrar

setting

ConfigurationSetting<string>

Returer

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Tar ConfigurationSetting som indata och returnerar ConfigurationSetting genom att parsa värdesträngen.

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

Parametrar

setting

ConfigurationSetting<string>

Returer

ConfigurationSetting<SecretReferenceValue>