ConfigurationBuilder Classe

Définition

Espace de noms:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.dll

Paquet:

Microsoft.Extensions.Configuration v9.0.0-preview.3.24172.9

Source:

ConfigurationBuilder.cs

Utilisé pour générer des paramètres de configuration basés sur les clés/valeurs à utiliser dans une application.

public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder

public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder

type ConfigurationBuilder = class
    interface IConfigurationBuilder

Public Class ConfigurationBuilder
Implements IConfigurationBuilder

Héritage

Object

ConfigurationBuilder

Implémente

IConfigurationBuilder

Remarques

En utilisant cette classe, vous pouvez stocker des valeurs de configuration dans un fichier JSON, par exemple, puis les récupérer au moment de l’exécution. Pour plus d’informations, consultez Configuration - Exemple de base.

Si vous migrez une application vers .NET Core 3.1 ou une version ultérieure, vous pouvez utiliser cette classe pour remplacer la fonctionnalité de fichier app.config que vous avez peut-être utilisée précédemment pour configurer votre application.

Exemple

L’extrait de code suivant montre une application simplifiée qui crée un ConfigurationBuilder objet pour récupérer une valeur de chaîne à partir d’un fichier JSON au moment de l’exécution.

using Microsoft.Extensions.Configuration;

IConfigurationBuilder builder = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true);
IConfigurationRoot root = builder.Build();

Console.WriteLine($"Hello, { root["weather"] } world!");

/* This program outputs the following text:
 * 
 * Hello, stormy world!
 */

Le contenu du fichier JSON est affiché ici.

{
  "weather": "stormy"
}

Constructeurs

ConfigurationBuilder()

Initialise une nouvelle instance de la classe ConfigurationBuilder.

Propriétés

Properties	Obtient une collection clé/valeur qui peut être utilisée pour partager des données entre les fournisseurs de IConfigurationBuilder configuration inscrits et.
Sources	Obtient les sources utilisées pour obtenir les valeurs de configuration.

Méthodes

Add(IConfigurationSource)	Ajoute une nouvelle source de configuration.
Build()	Crée une IConfiguration avec des clés et des valeurs de l’ensemble de fournisseurs inscrits dans Sources.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Méthodes d’extension

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Inscrit un fournisseur de configuration pour les métadonnées d’application.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Ajoute une configuration existante à configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Ajoute une configuration existante à configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[])	Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Ajoute un CommandLineConfigurationProvider qui lit les valeurs de configuration à partir de la ligne de commande en utilisant les mappages de commutateur spécifiés.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Ajoute une nouvelle source de configuration.
AddEnvironmentVariables(IConfigurationBuilder)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir des variables d’environnement.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir des variables d’environnement.
AddEnvironmentVariables(IConfigurationBuilder, String)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir des variables d’environnement avec un préfixe spécifié.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtient le IFileProvider par défaut à utiliser pour les fournisseurs basés sur des fichiers.
GetFileProvider(IConfigurationBuilder)	Obtient le IFileProvider par défaut à utiliser pour les fournisseurs basés sur des fichiers.
SetBasePath(IConfigurationBuilder, String)	Définit le FileProvider pour les fournisseurs basés sur des fichiers sur un PhysicalFileProvider avec le chemin de base.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Définit une action par défaut à appeler pour les fournisseurs basés sur des fichiers lorsqu’une erreur se produit.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Définit le IFileProvider par défaut à utiliser pour les fournisseurs basés sur des fichiers.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration INI à builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Ajoute une source de configuration INI à builder.
AddIniFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration INI au path vers builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration INI au path vers builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration INI au path vers builder.
AddIniStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration INI à builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration JSON à builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Ajoute une source de configuration JSON à builder.
AddJsonFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration JSON au path vers builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration JSON au path vers builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration JSON au path vers builder.
AddJsonStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration JSON à builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Ajoute une configuration en utilisant les fichiers d’un répertoire. Les noms de fichier sont utilisés comme clé, les contenus de fichier sont utilisés comme valeur.
AddKeyPerFile(IConfigurationBuilder, String)	Ajoute une configuration en utilisant les fichiers d’un répertoire. Les noms de fichier sont utilisés comme clé, les contenus de fichier sont utilisés comme valeur.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Ajoute une configuration en utilisant les fichiers d’un répertoire. Les noms de fichier sont utilisés comme clé, les contenus de fichier sont utilisés comme valeur.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute une configuration en utilisant les fichiers d’un répertoire. Les noms de fichier sont utilisés comme clé, les contenus de fichier sont utilisés comme valeur.
AddInMemoryCollection(IConfigurationBuilder)	Ajoute le fournisseur de configuration de mémoire à configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Ajoute le fournisseur de configuration de mémoire à configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Ajoute la source de configuration des secrets utilisateur. Ceci recherche dans l’assembly une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Ajoute la source de configuration des secrets utilisateur. Ceci recherche dans l’assembly une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Ajoute la source de configuration des secrets utilisateur. Ceci recherche dans l’assembly une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets(IConfigurationBuilder, String)	Ajoute la source de configuration des secrets utilisateur avec l’ID de secrets utilisateur spécifié. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Ajoute la source de configuration des secrets utilisateur avec l’ID de secrets utilisateur spécifié. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets<T>(IConfigurationBuilder)	Ajoute la source de configuration des secrets utilisateur. Recherche dans l’assembly qui contient le T de type, une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Ajoute la source de configuration des secrets utilisateur. Recherche dans l’assembly qui contient le T de type, une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Ajoute la source de configuration des secrets utilisateur. Recherche dans l’assembly qui contient le T de type, une instance de UserSecretsIdAttribute qui spécifie un ID de secrets utilisateur. Un ID de secrets utilisateur est une valeur unique utilisée pour stocker et identifier une collection de valeurs de configuration de secret.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration XML à builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Ajoute une source de configuration XML à builder.
AddXmlFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration XML au path vers builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration XML au path vers builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration XML au path vers builder.
AddXmlStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration XML à builder.

Voir aussi

• Configuration dans .NET