ConfigurationManager 类

定义

命名空间:

Microsoft.Extensions.Configuration

程序集:

Microsoft.Extensions.Configuration.dll

包:

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

Source:

ConfigurationManager.cs

表示可变配置对象。 它既是 和 IConfigurationBuilderIConfigurationRoot。 添加源时，它会更新其配置的当前视图。 调用 后 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 IConfigurationRoot IDisposable IConfigurationManager

注解

它既是 和 IConfigurationBuilderIConfigurationRoot。 添加源时，它会更新其当前配置视图。

构造函数

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。
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。
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。
AddInMemoryCollection(IConfigurationBuilder)	将内存配置提供程序添加到 configurationBuilder。
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	将内存配置提供程序添加到 configurationBuilder。
AddUserSecrets(IConfigurationBuilder, Assembly)	添加用户机密配置源。 这会在 assembly 中搜索 UserSecretsIdAttribute 实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	添加用户机密配置源。 这会在 assembly 中搜索 UserSecretsIdAttribute 实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	添加用户机密配置源。 这会在 assembly 中搜索 UserSecretsIdAttribute 实例，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String)	添加具有指定用户机密 ID 的用户机密配置源。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets(IConfigurationBuilder, String, Boolean)	添加具有指定用户机密 ID 的用户机密配置源。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder)	添加用户机密配置源。 搜索包含 UserSecretsIdAttribute 实例的类型 T 的程序集，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	添加用户机密配置源。 搜索包含 UserSecretsIdAttribute 实例的类型 T 的程序集，该实例指定用户机密 ID。 用户机密 ID 是用于存储和标识机密配置值集合的唯一值。
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	添加用户机密配置源。 搜索包含 UserSecretsIdAttribute 实例的类型 T 的程序集，该实例指定用户机密 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。