ConfigurationManager 類別

定義

表示可變動的組態物件。 它同時 IConfigurationBuilder 為 和 IConfigurationRoot。 新增來源時,它會更新其目前的組態檢視。 呼叫之後 IConfigurationBuilder.Build() ,就會凍結組態。

public ref class ConfigurationManager sealed : IDisposable, Microsoft::Extensions::Configuration::IConfigurationBuilder, Microsoft::Extensions::Configuration::IConfigurationRoot
public ref class ConfigurationManager sealed : IDisposable, Microsoft::Extensions::Configuration::IConfigurationManager, Microsoft::Extensions::Configuration::IConfigurationRoot
public sealed class ConfigurationManager : IDisposable, Microsoft.Extensions.Configuration.IConfigurationBuilder, Microsoft.Extensions.Configuration.IConfigurationRoot
public sealed class ConfigurationManager : IDisposable, Microsoft.Extensions.Configuration.IConfigurationManager, Microsoft.Extensions.Configuration.IConfigurationRoot
type ConfigurationManager = class
    interface IConfigurationBuilder
    interface IConfigurationRoot
    interface IConfiguration
    interface IDisposable
type ConfigurationManager = class
    interface IConfigurationManager
    interface IConfiguration
    interface IConfigurationBuilder
    interface IConfigurationRoot
    interface IDisposable
Public NotInheritable Class ConfigurationManager
Implements IConfigurationBuilder, IConfigurationRoot, IDisposable
Public NotInheritable Class ConfigurationManager
Implements IConfigurationManager, IConfigurationRoot, IDisposable
繼承
ConfigurationManager
實作

備註

它同時 IConfigurationBuilder 為 和 IConfigurationRoot。 新增來源時,它會更新其目前的組態檢視。

建構函式

ConfigurationManager()

建立空的可變組態物件,該物件同時 IConfigurationBuilder 為 和 IConfigurationRoot

屬性

Item[String]

取得或設定組態值。

Sources

取得用於取得組態值的來源。

方法

Dispose()

執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。

Equals(Object)

判斷指定的物件是否等於目前的物件。

(繼承來源 Object)
GetChildren()

取得立即子代組態子節。

GetHashCode()

做為預設雜湊函式。

(繼承來源 Object)
GetSection(String)

取得具有指定索引鍵的組態子區段。

GetType()

取得目前執行個體的 Type

(繼承來源 Object)
MemberwiseClone()

建立目前 Object 的淺層複製。

(繼承來源 Object)
ToString()

傳回代表目前物件的字串。

(繼承來源 Object)

明確介面實作

IConfiguration.GetReloadToken()

傳回可用於在重新載入此組態時觀察的 IChangeToken

IConfigurationBuilder.Add(IConfigurationSource)

新增組態來源。

IConfigurationBuilder.Build()

建置 IConfiguration,其中包含在 Sources 中註冊的來源集合索引鍵和值。

IConfigurationBuilder.Properties

取得索引鍵/值集合,可用來在 和已註冊的組態來源之間 IConfigurationBuilder 共享數據。

IConfigurationBuilder.Sources

取得用於取得組態值的來源。

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>)

新增組態來源。

AddUserSecrets(IConfigurationBuilder)

新增使用者祕密組態來源。 從 UserSecretsIdAttribute 執行個體的 GetEntryAssembly() 中搜尋組件。

AddUserSecrets(IConfigurationBuilder, Assembly)

新增使用者祕密組態來源。

AddUserSecrets(IConfigurationBuilder, String)

新增具有指定秘密標識碼的使用者秘密組態來源。

AddUserSecrets<T>(IConfigurationBuilder)

新增使用者祕密組態來源。 搜尋包含 UserSecretsIdAttribute 執行個體之 T 類型的組件。

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)

新增使用者祕密組態來源。 這會搜尋 UserSecretsIdAttribute 執行個體的 assembly,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)

新增使用者祕密組態來源。 這會搜尋 UserSecretsIdAttribute 執行個體的 assembly,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)

新增使用者祕密組態來源。 這會搜尋 UserSecretsIdAttribute 執行個體的 assembly,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets(IConfigurationBuilder, String)

新增具有指定使用者祕密識別碼的使用者祕密組態來源。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets(IConfigurationBuilder, String, Boolean)

新增具有指定使用者祕密識別碼的使用者祕密組態來源。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets<T>(IConfigurationBuilder)

新增使用者祕密組態來源。 搜尋包含類型 T 的組件以取得 UserSecretsIdAttribute 執行個體,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets<T>(IConfigurationBuilder, Boolean)

新增使用者祕密組態來源。 搜尋包含類型 T 的組件以取得 UserSecretsIdAttribute 執行個體,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)

新增使用者祕密組態來源。 搜尋包含類型 T 的組件以取得 UserSecretsIdAttribute 執行個體,其會指定使用者祕密識別碼。

使用者祕密識別碼是用來儲存及識別祕密組態值集合的唯一值。

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

適用於