語言

ConfigurationManager 類別

定義

表示可變動的組態物件。

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
繼承
ConfigurationManager
實作

備註

它同時是 an IConfigurationBuilder 與 IConfigurationRoot。 隨著來源的加入,它會更新目前的配置視圖。

建構函式

名稱 Description
ConfigurationManager()

建立一個空的可變配置物件,同時是 與 IConfigurationBuilderIConfigurationRoot。

屬性

名稱 Description
Item[String]

取得或設定一個設定值。

Sources

取得用來取得設定值的來源。

方法

名稱 Description
Dispose()

執行與釋放、釋放或重設非受控資源相關聯的應用程式定義工作。

GetChildren()

取得直系後代配置子節。

GetSection(String)

取得帶有指定金鑰的配置子區。

明確介面實作

名稱 Description
IConfiguration.GetReloadToken()

回傳 a IChangeToken 可用來觀察此配置何時重新載入。

IConfigurationBuilder.Add(IConfigurationSource)

新增一個新的設定來源。

IConfigurationBuilder.Build()

從註冊IConfiguration的原始碼集合中,使用鍵值與值建構 。Sources

IConfigurationBuilder.Properties

取得一個鍵值集合,可用於在註冊組態來源與註冊組態來源間 IConfigurationBuilder 分享資料。

IConfigurationRoot.Providers

取得該配置的設定提供者。

IConfigurationRoot.Reload()

強制從底層 IConfigurationProvider 實例重新載入設定值。

擴充方法

名稱 Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)

新增一個新的設定來源。

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)

註冊一個應用程式元資料的設定提供者。

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

新增一個 IConfigurationProvider 從命令列讀取設定值的設定值。

AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)

新增一個 CommandLineConfigurationProviderIConfigurationProvider ,利用指定的交換器映射從命令列讀取設定值。

AddCommandLine(IConfigurationBuilder, String[])

新增一個 CommandLineConfigurationProviderIConfigurationProvider 從命令列讀取設定值的 a。

AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)

將現有配置加入 configurationBuilder。

AddConfiguration(IConfigurationBuilder, IConfiguration)

將現有配置加入 configurationBuilder。

AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)

新增一個 IConfigurationProvider 能從環境變數讀取設定值的設定值。

AddEnvironmentVariables(IConfigurationBuilder, String, Func<String,String>)

新增一個 IConfigurationProvider 能讀取環境變數設定值,並以指定的前綴和變數名稱轉換。

AddEnvironmentVariables(IConfigurationBuilder, String)

新增 IConfigurationProvider 一個能讀取環境變數設定值的指定前綴。

AddEnvironmentVariables(IConfigurationBuilder)

新增一個 IConfigurationProvider 能從環境變數讀取設定值的設定值。

AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)

將 INI 配置來源 builder加入 。

AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

將 INI 配置來源 builder加入 。

AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)

將 INI 配置提供者 加入 pathbuilder。

AddIniFile(IConfigurationBuilder, String, Boolean)

將 INI 配置提供者 加入 pathbuilder。

AddIniFile(IConfigurationBuilder, String)

將 INI 配置提供者 加入 pathbuilder。

AddIniStream(IConfigurationBuilder, Stream)

將 INI 配置來源 builder加入 。

AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)

將記憶體配置提供者 configurationBuilder加入 。

AddInMemoryCollection(IConfigurationBuilder)

將記憶體配置提供者 configurationBuilder加入 。

AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)

將 JSON 配置原始碼加入 builder。

AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

將 JSON 配置原始碼加入 builder。

AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)

將 JSON 配置提供者 加入 pathbuilder。

AddJsonFile(IConfigurationBuilder, String, Boolean)

將 JSON 配置提供者 加入 pathbuilder。

AddJsonFile(IConfigurationBuilder, String)

將 JSON 配置提供者 加入 pathbuilder。

AddJsonStream(IConfigurationBuilder, Stream)

將 JSON 配置原始碼加入 builder。

AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)

透過目錄中的檔案來新增設定。 檔案名稱作為鍵,檔案內容作為值。

AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)

透過目錄中的檔案來新增設定。 檔案名稱作為鍵,檔案內容作為值。

AddKeyPerFile(IConfigurationBuilder, String, Boolean)

透過目錄中的檔案來新增設定。 檔案名稱作為鍵,檔案內容作為值。

AddKeyPerFile(IConfigurationBuilder, String)

透過目錄中的檔案來新增設定。 檔案名稱作為鍵,檔案內容作為值。

AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)

新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例,指定使用者秘密的 ID。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)

新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例,指定使用者秘密的 ID。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets(IConfigurationBuilder, Assembly)

新增使用者秘密的設定來源。 此方法搜尋 assembly 的 UserSecretsIdAttribute實例,指定使用者秘密的 ID。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets(IConfigurationBuilder, String, Boolean)

新增使用者秘密設定來源及指定的使用者秘密 ID。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets(IConfigurationBuilder, String)

新增使用者秘密設定來源及指定的使用者秘密 ID。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)

新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言,尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets<T>(IConfigurationBuilder, Boolean)

新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言,尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddUserSecrets<T>(IConfigurationBuilder)

新增使用者秘密的設定來源。 搜尋包含型態 T 的組合語言,尋找指定使用者秘密 ID 的實例 UserSecretsIdAttribute。

使用者秘密 ID 是用來儲存和識別一組秘密設定值的唯一值。

AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)

新增 XML 設定來源。builder

AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

新增 XML 設定來源。builder

AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)

將 XML 配置提供者 在 pathbuilder。

AddXmlFile(IConfigurationBuilder, String, Boolean)

將 XML 配置提供者 在 pathbuilder。

AddXmlFile(IConfigurationBuilder, String)

將 XML 配置提供者 在 pathbuilder。

AddXmlStream(IConfigurationBuilder, Stream)

新增 XML 設定來源。builder

AsEnumerable(IConfiguration, Boolean)

取得關鍵值對的枚舉 IConfiguration

AsEnumerable(IConfiguration)

取得關鍵值對的枚舉 IConfiguration

Bind(IConfiguration, Object, Action<BinderOptions>)

嘗試透過遞迴地將屬性名稱與配置鍵匹配,將給定物件實例綁定到設定值。

Bind(IConfiguration, Object)

嘗試透過遞迴地將屬性名稱與配置鍵匹配,將給定物件實例綁定到設定值。

Bind(IConfiguration, String, Object)

嘗試透過遞迴地將屬性名稱與配置鍵匹配,將給定物件實例綁定到金鑰指定的配置區段。

Get(IConfiguration, Type, Action<BinderOptions>)

嘗試將配置實例綁定到新的 T 型實例。如果這個配置區段有值,就會被使用。 否則,則是透過將屬性名稱與配置鍵遞迴匹配來綁定。

Get(IConfiguration, Type)

嘗試將配置實例綁定到新的 T 型實例。如果這個配置區段有值,就會被使用。 否則,則是透過將屬性名稱與配置鍵遞迴匹配來綁定。

Get<T>(IConfiguration, Action<BinderOptions>)

嘗試將配置實例綁定到新的 T 型實例。如果這個配置區段有值,就會被使用。 否則,則是透過將屬性名稱與配置鍵遞迴匹配來綁定。

Get<T>(IConfiguration)

嘗試將配置實例綁定到新的 T 型實例。如果這個配置區段有值,就會被使用。 否則,則是透過將屬性名稱與配置鍵遞迴匹配來綁定。

GetConnectionString(IConfiguration, String)

從指定的配置中取得指定的 連接字串。 GetSection("ConnectionStrings")[name] 的簡略版。

GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>)

會產生一個可讀的配置視圖,顯示每個值的來源。

GetDebugView(IConfigurationRoot)

會產生一個可讀的配置視圖,顯示每個值的來源。

GetFileLoadExceptionHandler(IConfigurationBuilder)

當發生錯誤時,會有一個預設動作用於檔案型提供者。

GetFileProvider(IConfigurationBuilder)

預設 IFileProvider 是用於檔案型提供者。

GetRequiredSection(IConfiguration, String)

取得帶有指定金鑰的配置子區。

GetValue(IConfiguration, Type, String, Object)

用指定鍵提取該值並將其轉換為指定型別。

GetValue(IConfiguration, Type, String)

用指定鍵提取該值並將其轉換為指定型別。

GetValue<T>(IConfiguration, String, T)

用指定鍵提取值並轉換成 T 型。

GetValue<T>(IConfiguration, String)

用指定鍵提取值並轉換成 T 型。

SetBasePath(IConfigurationBuilder, String)

將檔案型提供者的 FileProvider 設定為帶有基礎路徑的 PhysicalFileProvider。

SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)

設定一個預設動作,當檔案型提供者發生錯誤時會被呼叫。

SetFileProvider(IConfigurationBuilder, IFileProvider)

預設 IFileProvider 為用於檔案型提供者。

適用於