@azure/app-configuration package
Classes
AppConfigurationClient |
Client pour le service Azure App Configuration. |
Interfaces
AddConfigurationSettingOptions |
Options utilisées lors de l’ajout d’une configurationSetting. |
AddConfigurationSettingResponse |
Réponse de l’ajout d’une configurationSetting. |
AppConfigurationClientOptions |
Fournit des options de configuration pour AppConfigurationClient. |
ConfigurationSettingId |
Champs qui identifient de façon unique un paramètre de configuration |
ConfigurationSettingsFilter |
Active le filtrage des valeurs de clé. Référence de syntaxe : https://aka.ms/azconfig/docs/restapisnapshots |
ConfigurationSnapshot |
Les détails de l’instantané incluent le nom, les filtres, expiresOn, sizeInBytes, l’état, itemCount, etc. |
CreateSnapshotOptions |
Options utilisées lors de la création d’un instantané. |
CreateSnapshotResponse |
Réponse de la mise à jour d’un instantané. |
DeleteConfigurationSettingOptions |
Options de suppression d’un ConfigurationSetting. |
DeleteConfigurationSettingResponse |
Réponse de la suppression d’un ConfigurationSetting. |
EtagEntity |
Entité avec etag. |
FeatureFlagValue |
Valeur d’un indicateur de fonctionnalité |
GetConfigurationHeaders |
En-têtes de l’obtention d’une configurationSetting. |
GetConfigurationSettingOptions |
Options d’obtention d’une configurationSetting. |
GetConfigurationSettingResponse |
Réponse de la récupération d’un ConfigurationSetting. |
GetSnapshotOptions |
Options utilisées lors de l’obtention d’un instantané. |
GetSnapshotResponse |
Réponse de l’obtention d’un instantané. |
HttpOnlyIfChangedField |
Options utilisées pour fournir une correspondance if-none pour une requête HTTP |
HttpOnlyIfUnchangedField |
Options utilisées pour fournir une correspondance si pour une requête HTTP |
HttpResponseField |
Informations relatives à la réponse HTTP : en-têtes et corps brut. |
HttpResponseFields |
Les champs qui sont hissés à partir du champ _response de l’objet Utilisé dans les cas où des champs de réponse HTTP individuels sont importants pour l’utilisateur à utiliser dans des cas d’usage courants tels que la gestion des codes d’état HTTP 204 ou 304. |
ListConfigurationSettingPage |
Page des paramètres de configuration et réponse HTTP correspondante |
ListConfigurationSettingsForSnapshotOptions |
Options courantes pour les API de style « list » dans AppConfig utilisées pour spécifier des caractères génériques ainsi que l’en-tête d’heure de date d’acceptation. |
ListConfigurationSettingsOptions |
Options pour listConfigurationSettings qui permettent de filtrer en fonction des clés, des étiquettes et d’autres champs.
Fournit également |
ListLabelsOptions |
Options pour listLabels |
ListLabelsPage |
Page des paramètres de configuration et réponse HTTP correspondante |
ListRevisionsOptions |
Options pour listRevisions qui permettent de filtrer en fonction des clés, des étiquettes et d’autres champs.
Fournit également |
ListRevisionsPage |
Page des paramètres de configuration et réponse HTTP correspondante |
ListSettingsOptions |
Options courantes pour les API de style « list » dans AppConfig utilisées pour spécifier des caractères génériques ainsi que l’en-tête d’heure de date d’acceptation. |
ListSnapshots |
Options courantes pour les API de style « list » dans AppConfig utilisées pour spécifier des caractères génériques ainsi que l’en-tête d’heure de date d’acceptation. |
ListSnapshotsOptions |
Options pour listConfigurationSettings qui permettent de filtrer en fonction des clés, des étiquettes et d’autres champs.
Fournit également |
ListSnapshotsPage |
Page des paramètres de configuration et réponse HTTP correspondante |
OptionalFields |
Utilisé lorsque l’API prend en charge le retour sélectif de champs. |
OptionalLabelsFields |
Utilisé lorsque l’API prend en charge le retour sélectif des champs d’étiquettes. |
OptionalSnapshotFields |
Utilisé lorsque l’API prend en charge le retour sélectif de champs. |
PageSettings |
Interface qui suit les paramètres de l’itération paginée |
RetryOptions |
Options qui contrôlent la façon de réessayer les demandes ayant échoué. |
SecretReferenceValue |
Champs nécessaires à la mise à jour ou à la création d’une référence de secret. |
SetConfigurationSettingOptions |
Options utilisées lors de l’enregistrement d’une configurationSetting. |
SetConfigurationSettingResponse |
Réponse de la définition d’une configurationSetting. |
SetReadOnlyOptions |
Options pour setReadOnly |
SetReadOnlyResponse |
Réponse lors de la définition d’une valeur en lecture seule. |
SettingLabel |
Détails de l’étiquette, avec la propriété name qui ne peut être renseignée que par le serveur |
SnapshotInfo |
Champs qui identifient de façon unique un instantané |
SnapshotResponse |
Réponse de l’ajout d’un instantané. |
SyncTokenHeaderField |
Champ d’en-tête de jeton de synchronisation |
UpdateSnapshotOptions |
Options utilisées lors de la mise à jour d’un instantané. |
UpdateSnapshotResponse |
Réponse de la mise à jour d’un instantané. |
Alias de type
AddConfigurationSettingParam |
Paramètres d’ajout d’un nouveau paramètre de configuration |
ConfigurationSetting |
Paramètre de configuration avec des métadonnées supplémentaires du serveur, indiquant son etag, s’il est actuellement luOnly et quand il a été modifié pour la dernière fois. |
ConfigurationSettingParam |
Champs nécessaires à la mise à jour ou à la création d’un paramètre de configuration |
ConfigurationSettingResponse |
Réponse de base standard pour obtenir, supprimer ou mettre à jour un paramètre de configuration |
ConfigurationSnapshotStatus |
Définit des valeurs pour ConfigurationSnapshotStatus. Valeurs connues prises en charge par le service
de provisionnement |
SetConfigurationSettingParam |
Paramètres de création ou de mise à jour d’un nouveau paramètre de configuration |
SnapshotComposition |
Définit des valeurs pour SnapshotComposition. Valeurs connues prises en charge par le service
clé |
Énumérations
KnownConfigurationSnapshotStatus |
Valeurs connues de ConfigurationSnapshotStatus que le service accepte. |
KnownSnapshotComposition |
Valeurs connues de SnapshotComposition que le service accepte. |
Functions
is |
Indique si ConfigurationSetting est un indicateur de fonctionnalité. [Vérifie si le type de contenu est featureFlagContentType |
is |
Indique si ConfigurationSetting est une référence secrète. [Vérifie si le type de contenu est secretReferenceContentType |
parse |
Prend ConfigurationSetting en tant qu’entrée et retourne ConfigurationSetting en analysant la chaîne de valeur. |
parse |
Prend ConfigurationSetting en tant qu’entrée et retourne ConfigurationSetting en analysant la chaîne de valeur. |
Informations relatives à la fonction
isFeatureFlag(ConfigurationSetting<string>)
Indique si ConfigurationSetting est un indicateur de fonctionnalité.
[Vérifie si le type de contenu est featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"
]
function isFeatureFlag(setting: ConfigurationSetting<string>): setting
Paramètres
- setting
-
ConfigurationSetting<string>
Retours
setting
isSecretReference(ConfigurationSetting<string>)
Indique si ConfigurationSetting est une référence secrète.
[Vérifie si le type de contenu est secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"
]
function isSecretReference(setting: ConfigurationSetting<string>): setting
Paramètres
- setting
-
ConfigurationSetting<string>
Retours
setting
parseFeatureFlag(ConfigurationSetting<string>)
Prend ConfigurationSetting en tant qu’entrée et retourne ConfigurationSetting en analysant la chaîne de valeur.
function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>
Paramètres
- setting
-
ConfigurationSetting<string>
Retours
parseSecretReference(ConfigurationSetting<string>)
Prend ConfigurationSetting en tant qu’entrée et retourne ConfigurationSetting en analysant la chaîne de valeur.
function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>
Paramètres
- setting
-
ConfigurationSetting<string>