Condividi tramite

@azure/app-configuration package

Classi

AppConfigurationClient

Client per il servizio Configurazione app di Azure.

Interfacce

AddConfigurationSettingOptions

Opzioni usate per l'aggiunta di un oggetto ConfigurationSetting.
AddConfigurationSettingResponse

Risposta dall'aggiunta di un oggetto ConfigurationSetting.
AppConfigurationClientOptions

Fornisce opzioni di configurazione per AppConfigurationClient.
ConfigurationSettingId

Campi che identificano in modo univoco un'impostazione di configurazione
ConfigurationSettingsFilter

Abilita il filtro dei valori chiave. Informazioni di riferimento sulla sintassi: https://aka.ms/azconfig/docs/restapisnapshots
ConfigurationSnapshot

I dettagli dello snapshot includono nome, filtri, expiresOn, sizeInBytes, stato, itemCount e altro ancora
CreateSnapshotOptions

Opzioni utilizzate durante la creazione di uno snapshot.
CreateSnapshotResponse

Risposta dall'aggiornamento di uno snapshot.
DeleteConfigurationSettingOptions

Opzioni per l'eliminazione di un oggetto ConfigurationSetting.
DeleteConfigurationSettingResponse

Risposta dall'eliminazione di un oggetto ConfigurationSetting.
EtagEntity

Entità con etag.
FeatureFlagValue

Valore di un flag di funzionalità
GetConfigurationHeaders

Intestazioni dal recupero di un oggetto ConfigurationSetting.
GetConfigurationSettingOptions

Opzioni per ottenere un oggetto ConfigurationSetting.
GetConfigurationSettingResponse

Risposta dal recupero di un oggetto ConfigurationSetting.
GetSnapshotOptions

Opzioni usate per ottenere uno snapshot.
GetSnapshotResponse

Risposta dal recupero di uno snapshot.
HttpOnlyIfChangedField

Opzioni usate per fornire se none-match per una richiesta HTTP
HttpOnlyIfUnchangedField

Opzioni usate per fornire la corrispondenza if per una richiesta HTTP
HttpResponseField

Informazioni correlate alla risposta HTTP: intestazioni e corpo non elaborato.
HttpResponseFields

I campi allineati dal campo _response dell'oggetto Usato nei casi in cui i singoli campi di risposta HTTP sono importanti per l'utente da usare in casi d'uso comuni, ad esempio la gestione dei codici di stato HTTP 204 o 304.
ListConfigurationSettingPage

Pagina delle impostazioni di configurazione e della risposta HTTP corrispondente
ListConfigurationSettingsForSnapshotOptions

Opzioni comuni per le API di stile 'list' in AppConfig usate per specificare caratteri jolly e l'intestazione accept date time.
ListConfigurationSettingsOptions

Opzioni per listConfigurationSettings che consentono di filtrare in base a chiavi, etichette e altri campi. Fornisce anche fields che consente di scegliere in modo selettivo i campi popolati nel risultato.
ListLabelsOptions

Opzioni per listLabels
ListLabelsPage

Pagina delle impostazioni di configurazione e della risposta HTTP corrispondente
ListRevisionsOptions

Opzioni per listRevisions che consentono di filtrare in base a chiavi, etichette e altri campi. Fornisce anche fields che consente di scegliere in modo selettivo i campi popolati nel risultato.
ListRevisionsPage

Pagina delle impostazioni di configurazione e della risposta HTTP corrispondente
ListSettingsOptions

Opzioni comuni per le API di stile 'list' in AppConfig usate per specificare caratteri jolly e l'intestazione accept date time.
ListSnapshots

Opzioni comuni per le API di stile 'list' in AppConfig usate per specificare caratteri jolly e l'intestazione accept date time.
ListSnapshotsOptions

Opzioni per listConfigurationSettings che consentono di filtrare in base a chiavi, etichette e altri campi. Fornisce anche fields che consente di scegliere in modo selettivo i campi popolati nel risultato.
ListSnapshotsPage

Pagina delle impostazioni di configurazione e della risposta HTTP corrispondente
OptionalFields

Usato quando l'API supporta la restituzione selettiva dei campi.
OptionalLabelsFields

Usato quando l'API supporta la restituzione selettiva dei campi delle etichette.
OptionalSnapshotFields

Usato quando l'API supporta la restituzione selettiva dei campi.
PageSettings

Interfaccia che tiene traccia delle impostazioni per l'iterazione di paging
RetryOptions

Opzioni che controllano come ripetere le richieste non riuscite.
SecretReferenceValue

Campi necessari per l'aggiornamento o la creazione di un nuovo riferimento segreto.
SetConfigurationSettingOptions

Opzioni utilizzate durante il salvataggio di un oggetto ConfigurationSetting.
SetConfigurationSettingResponse

Risposta dall'impostazione di ConfigurationSetting.
SetReadOnlyOptions

Opzioni per setReadOnly
SetReadOnlyResponse

Risposta quando si imposta un valore di sola lettura.
SettingLabel

Dettagli etichetta, con proprietà name che può essere popolata solo dal server
SnapshotInfo

Campi che identificano in modo univoco uno snapshot
SnapshotReferenceValue

Campi necessari per l'aggiornamento o la creazione di un nuovo riferimento snapshot.
SnapshotResponse

Risposta dall'aggiunta di uno snapshot.
SyncTokenHeaderField

Campo intestazione token di sincronizzazione
UpdateSnapshotOptions

Opzioni utilizzate durante l'aggiornamento di uno snapshot.
UpdateSnapshotResponse

Risposta dall'aggiornamento di uno snapshot.

Alias tipo

AddConfigurationSettingParam

Parametri per l'aggiunta di una nuova impostazione di configurazione
ConfigurationSetting

Impostazione di configurazione con metadati aggiuntivi dal server, che indica il relativo etag, se è attualmente readOnly e quando è stata modificata per l'ultima volta.
ConfigurationSettingParam

Campi necessari per l'aggiornamento o la creazione di una nuova impostazione di configurazione
ConfigurationSettingResponse

Risposta di base standard per ottenere, eliminare o aggiornare un'impostazione di configurazione
ConfigurationSnapshotStatus

Definisce i valori per ConfigurationSnapshotStatus.
KnownConfigurationSnapshotStatus può essere usato in modo intercambiabile con ConfigurationSnapshotStatus, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

di provisioning
pronto
archiviato
non riuscito
SetConfigurationSettingParam

Parametri per la creazione o l'aggiornamento di una nuova impostazione di configurazione
SnapshotComposition

Definisce i valori per SnapshotComposition.
KnownSnapshotComposition può essere usato in modo intercambiabile con SnapshotComposition, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

chiave
key_label

Enumerazioni

KnownAppConfigAudience

Valori noti per destinatari di Configurazione app di Azure
KnownConfigurationSnapshotStatus

Valori noti di ConfigurationSnapshotStatus accettati dal servizio.
KnownSnapshotComposition

Valori noti di SnapshotComposition accettati dal servizio.

Funzioni

isFeatureFlag(ConfigurationSetting<string>)

Indica se ConfigurationSetting è un flag di funzionalità.

[Controlla se il tipo di contenuto è featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]
isSecretReference(ConfigurationSetting<string>)

Indica se ConfigurationSetting è un riferimento segreto.

[Controlla se il tipo di contenuto è secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]
isSnapshotReference(ConfigurationSetting<string>)

Consente di sapere se ConfigurationSetting è un riferimento snapshot.

[Controlla se il tipo di contenuto è snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]
parseFeatureFlag(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<FeatureFlagValue> analizzando la stringa del valore.
parseSecretReference(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<SecretReferenceValue> analizzando la stringa del valore.
parseSnapshotReference(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<SnapshotReferenceValue> analizzando la stringa del valore.

Dettagli funzione

isFeatureFlag(ConfigurationSetting<string>)

Indica se ConfigurationSetting è un flag di funzionalità.

[Controlla se il tipo di contenuto è featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

setting

isSecretReference(ConfigurationSetting<string>)

Indica se ConfigurationSetting è un riferimento segreto.

[Controlla se il tipo di contenuto è secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

setting

isSnapshotReference(ConfigurationSetting<string>)

Consente di sapere se ConfigurationSetting è un riferimento snapshot.

[Controlla se il tipo di contenuto è snapshotReferenceContentType "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"]

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

setting

parseFeatureFlag(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<FeatureFlagValue> analizzando la stringa del valore.

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

ConfigurationSetting<FeatureFlagValue>

parseSecretReference(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<SecretReferenceValue> analizzando la stringa del valore.

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

ConfigurationSetting<SecretReferenceValue>

parseSnapshotReference(ConfigurationSetting<string>)

Accetta ConfigurationSetting come input e restituisce ConfigurationSetting<SnapshotReferenceValue> analizzando la stringa del valore.

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

Parametri

setting

ConfigurationSetting<string>

Restituisce

ConfigurationSetting<SnapshotReferenceValue>