ConfigurationManager 类

定义

命名空间:

Microsoft.Extensions.Configuration

程序集:

Microsoft.Extensions.Configuration.dll

包:

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

Source:

ConfigurationManager.cs

表示可变配置对象。 既是 IConfigurationBuilder，也是 IConfigurationRoot。 添加源后，它会更新其配置的当前视图。 调用 IConfigurationBuilder.Build() 后，配置将冻结。

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

继承

Object

ConfigurationManager

实现

IConfiguration IConfigurationBuilder IConfigurationManager IConfigurationRoot IDisposable

注解

既是 IConfigurationBuilder，也是 IConfigurationRoot。 添加源后，它会更新其当前配置视图。 调用 IConfigurationBuilder.Build() 后，配置将冻结。

构造函数

ConfigurationManager()

创建一个空的可变配置对象，该对象既是 IConfigurationBuilder，又是 IConfigurationRoot。

属性

Item[String]	获取或设置配置值。
Sources	获取用于获取配置值的源。

方法

Dispose()	执行与释放、释放或重置非托管资源关联的应用程序定义任务。
Equals(Object)	确定指定的对象是否等于当前对象。 (继承自 Object)
GetChildren()	获取即时后代配置子节。
GetHashCode()	用作默认哈希函数。 (继承自 Object)
GetSection(String)	获取具有指定键的配置子节。
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object的浅表副本。 (继承自 Object)
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)

显式接口实现

IConfiguration.GetReloadToken()	返回一个 IChangeToken，该 IChangeToken 可用于观察何时重新加载此配置。
IConfigurationBuilder.Add(IConfigurationSource)	添加新的配置源。
IConfigurationBuilder.Build()	使用 Sources中注册的源集中的键和值生成 IConfiguration。
IConfigurationBuilder.Properties	获取一个键值集合，该集合可用于在 IConfigurationBuilder 和已注册的配置源之间共享数据。
IConfigurationRoot.Providers	获取此配置的配置提供程序。
IConfigurationRoot.Reload()	强制从基础 IConfigurationProvider 实例重新加载配置值。

扩展方法

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	注册应用程序元数据的配置提供程序。
AddConfiguration(IConfigurationBuilder, IConfiguration)	将现有配置添加到 configurationBuilder。
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	将现有配置添加到 configurationBuilder。
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	添加从命令行读取配置值的 IConfigurationProvider。
AddCommandLine(IConfigurationBuilder, String[])	添加从命令行读取配置值的 CommandLineConfigurationProvider。
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	添加一个 CommandLineConfigurationProvider，该 CommandLineConfigurationProvider 使用指定的交换机映射从命令行读取配置值。
Bind(IConfiguration, Object)	通过以递归方式将属性名称与配置键匹配，尝试将给定的对象实例绑定到配置值。
Bind(IConfiguration, Object, Action<BinderOptions>)	通过以递归方式将属性名称与配置键匹配，尝试将给定的对象实例绑定到配置值。
Bind(IConfiguration, String, Object)	尝试将给定的对象实例以递归方式将属性名称与配置键匹配，将给定的对象实例绑定到键指定的配置节。
Get(IConfiguration, Type)	尝试将配置实例绑定到 T 类型的新实例。如果此配置节具有一个值，将使用该值。 否则，通过以递归方式将属性名称与配置键匹配来绑定。
Get(IConfiguration, Type, Action<BinderOptions>)	尝试将配置实例绑定到 T 类型的新实例。如果此配置节具有一个值，将使用该值。 否则，通过以递归方式将属性名称与配置键匹配来绑定。
Get<T>(IConfiguration)	尝试将配置实例绑定到 T 类型的新实例。如果此配置节具有一个值，将使用该值。 否则，通过以递归方式将属性名称与配置键匹配来绑定。
Get<T>(IConfiguration, Action<BinderOptions>)	尝试将配置实例绑定到 T 类型的新实例。如果此配置节具有一个值，将使用该值。 否则，通过以递归方式将属性名称与配置键匹配来绑定。
GetValue(IConfiguration, Type, String)	提取具有指定键的值，并将其转换为指定类型。
GetValue(IConfiguration, Type, String, Object)	提取具有指定键的值，并将其转换为指定类型。
GetValue<T>(IConfiguration, String)	提取具有指定键的值，并将其转换为 T 类型。
GetValue<T>(IConfiguration, String, T)	提取具有指定键的值，并将其转换为 T 类型。
Add<TSource>(IConfigurationBuilder, Action<TSource>)	添加新的配置源。
AsEnumerable(IConfiguration)	获取 IConfiguration中的键值对的枚举。
AsEnumerable(IConfiguration, Boolean)	获取 IConfiguration中的键值对的枚举。
GetConnectionString(IConfiguration, String)	从配置源的 ConnectionStrings 节检索具有指定键的值。 调用此方法是 GetSection("ConnectionStrings")[name]的速记。
GetRequiredSection(IConfiguration, String)	获取具有指定键的配置子节。
GetDebugView(IConfigurationRoot)	生成配置的人可读视图，其中显示了每个值来自何处。
GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>)	生成配置的人可读视图，其中显示了每个值来自何处。
AddEnvironmentVariables(IConfigurationBuilder)	添加从环境变量读取配置值的 IConfigurationProvider。
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	添加从环境变量读取配置值的 IConfigurationProvider。
AddEnvironmentVariables(IConfigurationBuilder, String)	添加一个从具有指定前缀的环境变量读取配置值的 IConfigurationProvider。
GetFileLoadExceptionHandler(IConfigurationBuilder)	获取要用于基于文件的提供程序的默认 IFileProvider。
GetFileProvider(IConfigurationBuilder)	获取要用于基于文件的提供程序的默认 IFileProvider。
SetBasePath(IConfigurationBuilder, String)	使用基本路径将基于文件的提供程序的 FileProvider 设置为 PhysicalFileProvider。
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	设置在发生错误时要为基于文件的提供程序调用的默认操作。
SetFileProvider(IConfigurationBuilder, IFileProvider)	设置要用于基于文件的提供程序的默认 IFileProvider。
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	将 INI 配置源添加到 builder。
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	将 INI 配置源添加到 builder。
AddIniFile(IConfigurationBuilder, String)	将 path 处的 INI 配置提供程序添加到 builder。
AddIniFile(IConfigurationBuilder, String, Boolean)	将 path 处的 INI 配置提供程序添加到 builder。
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	将 path 处的 INI 配置提供程序添加到 builder。
AddIniStream(IConfigurationBuilder, Stream)	将 INI 配置源添加到 builder。
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	将 JSON 配置源添加到 builder。
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	将 JSON 配置源添加到 builder。
AddJsonFile(IConfigurationBuilder, String)	将 path 的 JSON 配置提供程序添加到 builder。
AddJsonFile(IConfigurationBuilder, String, Boolean)	将 path 的 JSON 配置提供程序添加到 builder。
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	将 path 的 JSON 配置提供程序添加到 builder。
AddJsonStream(IConfigurationBuilder, Stream)	将 JSON 配置源添加到 builder。
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	使用目录中的文件添加配置。 文件名用作键，文件内容用作值。
AddKeyPerFile(IConfigurationBuilder, String)	使用目录中的文件添加配置。 文件名用作键，文件内容用作值。
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	使用目录中的文件添加配置。 文件名用作键，文件内容用作值。
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	使用目录中的文件添加配置。 文件名用作键，文件内容用作值。
AddInMemoryCollection(IConfigurationBuilder)	将内存配置提供程序添加到 configurationBuilder。
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	将内存配置提供程序添加到 configurationBuilder。
AddUserSecrets(IConfigurationBuilder, Assembly)	添加用户机密配置源。 这会搜索 assemblyUserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	添加用户机密配置源。 这会搜索 assemblyUserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	添加用户机密配置源。 这会搜索 assemblyUserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String)	添加具有指定用户机密 ID 的用户机密配置源。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String, Boolean)	添加具有指定用户机密 ID 的用户机密配置源。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder)	添加用户机密配置源。 在包含类型 T 的程序集中搜索 UserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	添加用户机密配置源。 在包含类型 T 的程序集中搜索 UserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	添加用户机密配置源。 在包含类型 T 的程序集中搜索 UserSecretsIdAttribute实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值的集合的唯一值。
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	将 XML 配置源添加到 builder。
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	将 XML 配置源添加到 builder。
AddXmlFile(IConfigurationBuilder, String)	将 path 的 XML 配置提供程序添加到 builder。
AddXmlFile(IConfigurationBuilder, String, Boolean)	将 path 的 XML 配置提供程序添加到 builder。
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	将 path 的 XML 配置提供程序添加到 builder。
AddXmlStream(IConfigurationBuilder, Stream)	将 XML 配置源添加到 builder。