ConfigurationBuilder Classe

Définition

Espace de noms:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.dll

Paquet:

Microsoft.Extensions.Configuration v11.0.0-preview.4.26230.115

Source:

ConfigurationBuilder.cs

Génère des paramètres de configuration de clé/valeur à 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

À l’aide de 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 déjà utilisée pour configurer votre application.

Example

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

Nom	Description
ConfigurationBuilder()	Initialise une nouvelle instance de la classe ConfigurationBuilder.

Propriétés

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

Méthodes

Nom	Description
Add(IConfigurationSource)	Ajoute une nouvelle source de configuration.
Build()	Génère un IConfiguration avec des clés et des valeurs à partir de l’ensemble de fournisseurs inscrits dans Sources.

Méthodes d’extension

Nom	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Ajoute une nouvelle source de configuration.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Inscrit un fournisseur de configuration pour les métadonnées d’application.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Ajoute une IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Ajoute une CommandLineConfigurationProviderIConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande à l’aide des mappages de commutateur spécifiés.
AddCommandLine(IConfigurationBuilder, String[])	Ajoute une CommandLineConfigurationProviderIConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de la ligne de commande.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Ajoute une configuration existante à configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Ajoute une configuration existante à configurationBuilder.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Ajoute une IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de variables d’environnement.
AddEnvironmentVariables(IConfigurationBuilder, String)	Ajoute une IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de variables d’environnement avec un préfixe spécifié.
AddEnvironmentVariables(IConfigurationBuilder)	Ajoute une IConfigurationProvider valeur de configuration qui lit les valeurs de configuration à partir de variables d’environnement.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Ajoute une source de configuration INI à builder.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration INI à builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration INI à path .builder
AddIniFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration INI à path .builder
AddIniFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration INI à path .builder
AddIniStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration INI à builder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Ajoute le fournisseur de configuration de mémoire à configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder)	Ajoute le fournisseur de configuration de mémoire à configurationBuilder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Ajoute une source de configuration JSON à builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration JSON à builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration JSON à pathbuilder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration JSON à pathbuilder.
AddJsonFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration JSON à pathbuilder.
AddJsonStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration JSON à builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Ajoute la configuration à l’aide de fichiers à partir d’un répertoire. Les noms de fichiers sont utilisés comme clé, le contenu du fichier est utilisé comme valeur.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute la configuration à l’aide de fichiers à partir d’un répertoire. Les noms de fichiers sont utilisés comme clé, le contenu du fichier est utilisé comme valeur.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Ajoute la configuration à l’aide de fichiers à partir d’un répertoire. Les noms de fichiers sont utilisés comme clé, le contenu du fichier est utilisé comme valeur.
AddKeyPerFile(IConfigurationBuilder, String)	Ajoute la configuration à l’aide de fichiers à partir d’un répertoire. Les noms de fichiers sont utilisés comme clé, le contenu du fichier est utilisé comme valeur.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Ajoute la source de configuration des secrets utilisateur. Cela recherche 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 secrets.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Ajoute la source de configuration des secrets utilisateur. Cela recherche 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 secrets.
AddUserSecrets(IConfigurationBuilder, Assembly)	Ajoute la source de configuration des secrets utilisateur. Cela recherche 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 secrets.
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 secrets.
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 secrets.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Ajoute la source de configuration des secrets utilisateur. Recherche l’assembly qui contient le type T d’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 secrets.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Ajoute la source de configuration des secrets utilisateur. Recherche l’assembly qui contient le type T d’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 secrets.
AddUserSecrets<T>(IConfigurationBuilder)	Ajoute la source de configuration des secrets utilisateur. Recherche l’assembly qui contient le type T d’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 secrets.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Ajoute une source de configuration XML à builder.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Ajoute une source de configuration XML à builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration XML à path .builder
AddXmlFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration XML à path .builder
AddXmlFile(IConfigurationBuilder, String)	Ajoute le fournisseur de configuration XML à path .builder
AddXmlStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration XML à builder.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtient une action par défaut à appeler pour les fournisseurs basés sur des fichiers lorsqu’une erreur se produit.
GetFileProvider(IConfigurationBuilder)	Obtient la valeur par défaut IFileProvider à utiliser pour les fournisseurs basés sur des fichiers.
SetBasePath(IConfigurationBuilder, String)	Définit FileProvider pour les fournisseurs basés sur des fichiers sur un PhysicalFileProvider avec le chemin d’accès 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 la valeur par défaut IFileProvider à utiliser pour les fournisseurs basés sur des fichiers.

Voir aussi

• Configuration dans .NET