bibliothèque cliente Azure App Configuration pour .NET - version 1.2.1

Azure App Configuration est un service managé qui permet aux développeurs de centraliser les paramètres de leurs applications et de leurs fonctionnalités de façon simple et sécurisée.

Utilisez la bibliothèque cliente pour App Configuration pour :

• Créer et gérer des paramètres de configuration d’application stockés de manière centralisée

| Code sourcePackage (NuGet) | Documentation de référence sur les | API | Documentation produitÉchantillons

Prise en main

Installer le package

Installez la bibliothèque cliente Azure App Configuration pour .NET avec NuGet :

dotnet add package Azure.Data.AppConfiguration

Prérequis

• Un abonnement Azure.
• Un magasin de configuration existant.

Si vous devez créer un magasin de configuration, vous pouvez utiliser le portail Azure ou Azure CLI.

Vous pouvez utiliser Azure CLI pour créer le magasin de configuration avec la commande suivante :

az appconfig create --name <config-store-name> --resource-group <resource-group-name> --location eastus

Authentifier le client

Pour interagir avec le service App Configuration, vous devez créer un instance de la classe Configuration Client. Pour ce faire, vous aurez besoin de la chaîne de connexion du Magasin de configuration.

Récupérer les informations d’identification

Utilisez l’extrait de code Azure CLI ci-dessous pour obtenir la chaîne de connexion à partir du Magasin de configuration.

az appconfig credential list --name <config-store-name>

Vous pouvez également obtenir la chaîne de connexion à partir du portail Azure.

Créer ConfigurationClient

Une fois que vous avez la valeur de la chaîne de connexion, vous pouvez créer configurationClient :

string connectionString = "<connection_string>";
var client = new ConfigurationClient(connectionString);

Créer ConfigurationClient avec les informations d’identification Azure Active Directory

L’authentification par clé d’abonnement client est utilisée dans la plupart des exemples de ce guide de prise en main, mais vous pouvez également vous authentifier auprès d’Azure Active Directory à l’aide de la bibliothèque Azure Identity. Pour utiliser le fournisseur DefaultAzureCredential indiqué ci-dessous ou d’autres fournisseurs d’informations d’identification fournis avec le Kit de développement logiciel (SDK) Azure, installez le package Azure.Identity :

dotnet add package Azure.Identity

Vous devez également inscrire une nouvelle application AAD et accorder l’accès au Magasin de configuration en affectant le "App Configuration Data Reader" rôle ou "App Configuration Data Owner" à votre principal de service.

Définissez les valeurs de l’ID client, de l’ID de locataire et de la clé secrète client de l’application AAD en tant que variables d’environnement : AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

string endpoint = "<endpoint>";
var client = new ConfigurationClient(new Uri(endpoint), new DefaultAzureCredential());

Concepts clés

Paramètre de configuration

Un paramètre de configuration est la ressource fondamentale dans un magasin de configuration. Dans sa forme la plus simple, il s’agit d’une clé et d’une valeur. Toutefois, il existe des propriétés supplémentaires telles que le type de contenu modifiable et les champs d’étiquettes qui permettent d’interpréter ou d’associer la valeur de différentes manières.

La propriété Label d’un paramètre de configuration permet de séparer les paramètres de configuration en différentes dimensions. Ces dimensions sont définies par l’utilisateur et peuvent prendre n’importe quelle forme. Parmi les exemples courants de dimensions à utiliser pour une étiquette, citons les régions, les versions sémantiques ou les environnements. De nombreuses applications disposent d’un ensemble obligatoire de clés de configuration qui ont des valeurs variables en fonction de l’existence de l’application sur différentes dimensions.

Par exemple, MaxRequests peut être 100 dans « NorthAmerica » et 200 dans « WestEurope ». En créant un paramètre de configuration nommé MaxRequests avec une étiquette « NorthAmerica » et un autre, uniquement avec une valeur différente, avec une étiquette « WestEurope », une application peut récupérer en toute transparence les paramètres de configuration au fur et à mesure de son exécution dans ces deux dimensions.

Sécurité des threads

Nous garantissons que toutes les méthodes de instance client sont sécurisées pour les threads et indépendantes les unes des autres (recommandations). Cela garantit que la recommandation de réutilisation des instances clientes est toujours sécurisée, même entre les threads.

Concepts supplémentaires

Options clientes | Accès à la réponse | Opérations de longue durée | Gestion des défaillances | Diagnostics | Moqueur | Durée de vie du client

Exemples

Les sections suivantes fournissent plusieurs extraits de code couvrant certaines des tâches les plus courantes de Configuration Service. Notez qu’il existe des méthodes de synchronisation et asynchrones disponibles pour les deux.

• Créer un paramètre de configuration
• Récupérer un paramètre de configuration
• Mettre à jour un paramètre de configuration existant
• Supprimer un paramètre de configuration

Créer un paramètre de configuration

Créez un paramètre de configuration à stocker dans le magasin de configuration. Il existe deux façons de stocker un paramètre de configuration :

• AddConfigurationSetting crée un paramètre uniquement si le paramètre n’existe pas déjà dans le magasin.
• SetConfigurationSetting crée un paramètre s’il n’existe pas ou remplace un paramètre existant.

string connectionString = "<connection_string>";
var client = new ConfigurationClient(connectionString);
var settingToCreate = new ConfigurationSetting("some_key", "some_value");
ConfigurationSetting setting = client.SetConfigurationSetting(settingToCreate);

Récupérer un paramètre de configuration

Récupérez un paramètre de configuration précédemment stocké en appelant GetConfigurationSetting. Cet extrait de code suppose que le paramètre « some_key » existe dans le magasin de configuration.

string connectionString = "<connection_string>";
var client = new ConfigurationClient(connectionString);
ConfigurationSetting setting = client.GetConfigurationSetting("some_key");

Mettre à jour un paramètre de configuration existant

Mettez à jour un paramètre de configuration existant en appelant SetConfigurationSetting. Cet extrait de code suppose que le paramètre « some_key » existe dans le magasin de configuration.

string connectionString = "<connection_string>";
var client = new ConfigurationClient(connectionString);
ConfigurationSetting setting = client.SetConfigurationSetting("some_key", "new_value");

Supprimer un paramètre de configuration

Supprimez un paramètre de configuration existant en appelant DeleteConfigurationSetting. Cet extrait de code suppose que le paramètre « some_key » existe dans le magasin de configuration.

string connectionString = "<connection_string>";
var client = new ConfigurationClient(connectionString);
client.DeleteConfigurationSetting("some_key");

Dépannage

Consultez notre guide de résolution des problèmes pour plus d’informations sur la façon de diagnostiquer différents scénarios d’échec.

Étapes suivantes

Autres exemples de code

Plusieurs exemples de bibliothèque cliente App Configuration sont disponibles dans ce dépôt GitHub. Il s’agit notamment des paramètres suivants :

• Hello world : créez et supprimez un paramètre de configuration.
• Hello world async avec des étiquettes : créez, mettez à jour et supprimez de manière asynchrone les paramètres de configuration avec des étiquettes.
• Rendre un paramètre de configuration en lecture seule : définissez un paramètre de configuration en lecture seule, puis retournez-le à un état lecture-écriture.
• Lire l’historique des révisions : lisez l’historique des révisions d’un paramètre de configuration qui a été modifié.
• Obtenir un paramètre si modifié : enregistrez la bande passante à l’aide d’une demande conditionnelle pour récupérer un paramètre uniquement s’il est différent de votre copie locale.
• Mettre à jour un paramètre s’il n’a pas changé : empêchez les mises à jour perdues en utilisant la concurrence optimiste pour mettre à jour un paramètre uniquement si vos mises à jour locales ont été appliquées à la même version que la ressource dans le magasin de configuration.
• Créer un client fictif : simuler un client à des fins de test.

Pour plus d’informations, consultez les exemples README.

Contribution

Consultez le App Configuration CONTRIBUTING.md pour plus d’informations sur la création, le test et la contribution à cette bibliothèque.

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, consultez cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez les Questions fréquentes (FAQ) sur le code de conduite ou envoyez vos questions ou vos commentaires à opencode@microsoft.com.