ConfigurationManager Classe

Définition

Espace de noms:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.dll

Paquet:

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

Source:

ConfigurationManager.cs

Représente un objet de configuration mutable. C’est à la fois une IConfigurationBuilder et une IConfigurationRoot. À mesure que des sources sont ajoutées, elle met à jour son affichage actuel de la configuration. Une fois IConfigurationBuilder.Build() est appelée, la configuration est figée.

public ref class ConfigurationManager sealed : IDisposable, Microsoft::Extensions::Configuration::IConfigurationManager, Microsoft::Extensions::Configuration::IConfigurationRoot

public sealed class ConfigurationManager : IDisposable, Microsoft.Extensions.Configuration.IConfigurationManager, Microsoft.Extensions.Configuration.IConfigurationRoot

type ConfigurationManager = class
    interface IConfigurationManager
    interface IConfiguration
    interface IConfigurationBuilder
    interface IConfigurationRoot
    interface IDisposable

Public NotInheritable Class ConfigurationManager
Implements IConfigurationManager, IConfigurationRoot, IDisposable

Héritage

Object

ConfigurationManager

Implémente

IConfiguration IConfigurationBuilder IConfigurationManager IConfigurationRoot IDisposable

Remarques

C’est à la fois une IConfigurationBuilder et une IConfigurationRoot. À mesure que des sources sont ajoutées, elle met à jour son affichage actuel de la configuration. Une fois IConfigurationBuilder.Build() est appelée, la configuration est figée.

Constructeurs

ConfigurationManager()

Crée un objet de configuration mutable vide qui est à la fois un IConfigurationBuilder et un IConfigurationRoot.

Propriétés

Item[String]	Obtient ou définit une valeur de configuration.
Sources	Obtient les sources utilisées pour obtenir des valeurs de configuration.

Méthodes

Dispose()	Effectue des tâches définies par l’application associées à la libération, à la libération ou à la réinitialisation des ressources non managées.
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
GetChildren()	Obtient les sous-sections de configuration descendante immédiate.
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetSection(String)	Obtient une sous-section de configuration avec la clé spécifiée.
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

IConfiguration.GetReloadToken()	Retourne une IChangeToken qui peut être utilisée pour observer quand cette configuration est rechargée.
IConfigurationBuilder.Add(IConfigurationSource)	Ajoute une nouvelle source de configuration.
IConfigurationBuilder.Build()	Génère une IConfiguration avec des clés et des valeurs à partir de l’ensemble de sources inscrites dans Sources.
IConfigurationBuilder.Properties	Obtient une collection clé-valeur qui peut être utilisée pour partager des données entre les IConfigurationBuilder et les sources de configuration inscrites.
IConfigurationRoot.Providers	Obtient les fournisseurs de configuration pour cette configuration.
IConfigurationRoot.Reload()	Force le rechargement des valeurs de configuration à partir des instances de IConfigurationProvider sous-jacentes.

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 à l’aide des mappages de commutateur spécifiés.
Bind(IConfiguration, Object)	Tente de lier l’instance d’objet donnée aux valeurs de configuration en correspondant aux noms de propriétés par rapport aux clés de configuration de manière récursive.
Bind(IConfiguration, Object, Action<BinderOptions>)	Tente de lier l’instance d’objet donnée aux valeurs de configuration en correspondant aux noms de propriétés par rapport aux clés de configuration de manière récursive.
Bind(IConfiguration, String, Object)	Tente de lier l’instance d’objet donnée à la section de configuration spécifiée par la clé en correspondant aux noms de propriétés par rapport aux clés de configuration de manière récursive.
Get(IConfiguration, Type)	Tente de lier l’instance de configuration à une nouvelle instance de type T. Si cette section de configuration a une valeur, elle sera utilisée. Sinon, liaison en faisant correspondre les noms de propriétés par rapport aux clés de configuration de manière récursive.
Get(IConfiguration, Type, Action<BinderOptions>)	Tente de lier l’instance de configuration à une nouvelle instance de type T. Si cette section de configuration a une valeur, elle sera utilisée. Sinon, liaison en faisant correspondre les noms de propriétés par rapport aux clés de configuration de manière récursive.
Get<T>(IConfiguration)	Tente de lier l’instance de configuration à une nouvelle instance de type T. Si cette section de configuration a une valeur, elle sera utilisée. Sinon, liaison en faisant correspondre les noms de propriétés par rapport aux clés de configuration de manière récursive.
Get<T>(IConfiguration, Action<BinderOptions>)	Tente de lier l’instance de configuration à une nouvelle instance de type T. Si cette section de configuration a une valeur, elle sera utilisée. Sinon, liaison en faisant correspondre les noms de propriétés par rapport aux clés de configuration de manière récursive.
GetValue(IConfiguration, Type, String)	Extrait la valeur avec la clé spécifiée et la convertit en type spécifié.
GetValue(IConfiguration, Type, String, Object)	Extrait la valeur avec la clé spécifiée et la convertit en type spécifié.
GetValue<T>(IConfiguration, String)	Extrait la valeur avec la clé spécifiée et la convertit en type T.
GetValue<T>(IConfiguration, String, T)	Extrait la valeur avec la clé spécifiée et la convertit en type T.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Ajoute une nouvelle source de configuration.
AsEnumerable(IConfiguration)	Obtenir l’énumération des paires clé-valeur dans le IConfiguration.
AsEnumerable(IConfiguration, Boolean)	Obtient l’énumération des paires clé-valeur dans le IConfiguration.
GetConnectionString(IConfiguration, String)	Récupère la valeur avec la clé spécifiée à partir de la section ConnectionStrings de la source de configuration. L’appel de cette méthode est abrégé pour GetSection("ConnectionStrings")[name].
GetRequiredSection(IConfiguration, String)	Obtient la sous-section de configuration qui a la clé spécifiée.
GetDebugView(IConfigurationRoot)	Génère une vue lisible par l’homme de la configuration montrant l’origine de chaque valeur.
GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>)	Génère une vue lisible par l’homme de la configuration montrant l’origine de chaque valeur.
AddEnvironmentVariables(IConfigurationBuilder)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de variables d’environnement.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de variables d’environnement.
AddEnvironmentVariables(IConfigurationBuilder, String)	Ajoute un IConfigurationProvider qui lit les valeurs de configuration à partir de variables d’environnement avec un préfixe spécifié.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtient la IFileProvider par défaut à utiliser pour les fournisseurs basés sur des fichiers.
GetFileProvider(IConfigurationBuilder)	Obtient la IFileProvider par défaut à 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 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 à path à builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration INI à path à builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration INI à path à 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 à path à builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration JSON à path à builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration JSON à path à builder.
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)	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, 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.
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. 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, 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, 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(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<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.
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, 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.
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 à path à builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Ajoute le fournisseur de configuration XML à path à builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Ajoute le fournisseur de configuration XML à path à builder.
AddXmlStream(IConfigurationBuilder, Stream)	Ajoute une source de configuration XML à builder.