ConfigurationManager クラス

リファレンス

定義

名前空間:: Microsoft.Extensions.Configuration

アセンブリ:: Microsoft.Extensions.Configuration.dll

パッケージ:: Microsoft.Extensions.Configuration v8.0.0

パッケージ:: Microsoft.Extensions.Configuration v9.0.0-preview.7.24405.7

ソース:: ConfigurationManager.cs

ソース:: ConfigurationManager.cs

ソース:: ConfigurationManager.cs

ソース:: ConfigurationManager.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

変更可能な構成オブジェクトを表します。それは 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 を返します。
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)	`builder`に INI 構成ソースを追加します。
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	`builder`に INI 構成ソースを追加します。
AddIniFile(IConfigurationBuilder, String)	`path` で INI 構成プロバイダーを `builder`に追加します。
AddIniFile(IConfigurationBuilder, String, Boolean)	`path` で INI 構成プロバイダーを `builder`に追加します。
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	`path` で INI 構成プロバイダーを `builder`に追加します。
AddIniStream(IConfigurationBuilder, Stream)	`builder`に INI 構成ソースを追加します。
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)	ユーザーシークレット構成ソースを追加します。これにより、ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスを `assembly` 検索します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	ユーザーシークレット構成ソースを追加します。これにより、ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスを `assembly` 検索します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	ユーザーシークレット構成ソースを追加します。これにより、ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスを `assembly` 検索します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets(IConfigurationBuilder, String)	指定したユーザーシークレット ID を持つユーザーシークレット構成ソースを追加します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets(IConfigurationBuilder, String, Boolean)	指定したユーザーシークレット ID を持つユーザーシークレット構成ソースを追加します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets<T>(IConfigurationBuilder)	ユーザーシークレット構成ソースを追加します。ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスの型 `T` を含むアセンブリを検索します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	ユーザーシークレット構成ソースを追加します。ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスの型 `T` を含むアセンブリを検索します。ユーザーシークレット ID は、シークレット構成値のコレクションを格納および識別するために使用される一意の値です。
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	ユーザーシークレット構成ソースを追加します。ユーザーシークレット ID を指定する UserSecretsIdAttributeのインスタンスの型 `T` を含むアセンブリを検索します。ユーザーシークレット 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`に追加します。

適用対象

次の方法で共有