英語で読む

次の方法で共有

IConfiguration インターフェイス

  • リファレンス

定義

名前空間:
Microsoft.Extensions.Configuration
アセンブリ:
Microsoft.Extensions.Configuration.Abstractions.dll
パッケージ:
Microsoft.Extensions.Configuration.Abstractions v8.0.0
パッケージ:
Microsoft.Extensions.Configuration.Abstractions v9.0.0-preview.7.24405.7
ソース:
IConfiguration.cs
ソース:
IConfiguration.cs
ソース:
IConfiguration.cs
ソース:
IConfiguration.cs

キー/値アプリケーション構成プロパティのセットを表します。

C# 
public interface IConfiguration
派生

注釈

詳細については、「.NETの 構成」を参照してください。

プロパティ

Item[String]

構成値を取得または設定します。

メソッド

GetChildren()

直下の子孫構成サブセクションを取得します。
GetReloadToken()

この構成が再読み込みされたときに監視するために使用できる IChangeToken を返します。
GetSection(String)

指定したキーを持つ構成サブセクションを取得します。

拡張メソッド

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 型に変換します。
AsEnumerable(IConfiguration)

IConfiguration内のキーと値のペアの列挙を取得します。
AsEnumerable(IConfiguration, Boolean)

IConfiguration内のキーと値のペアの列挙体を取得します。
GetConnectionString(IConfiguration, String)

構成ソースの ConnectionStrings セクションから、指定したキーを持つ値を取得します。 このメソッドの呼び出しは、GetSection("ConnectionStrings")[name]の短縮形です。
GetRequiredSection(IConfiguration, String)

指定したキーを持つ構成サブセクションを取得します。

適用対象

製品 バージョン
.NET 6, 7, 8, 9
.NET Framework 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0