ConfigurationBuilder クラス

定義

名前空間:

Microsoft.Extensions.Configuration

アセンブリ:

Microsoft.Extensions.Configuration.dll

パッケージ:

Microsoft.Extensions.Configuration v8.0.0

ソース:

ConfigurationBuilder.cs

アプリケーションで使用するキー/値ベースの構成設定をビルドするために使用されます。

public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder

public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder

type ConfigurationBuilder = class
    interface IConfigurationBuilder

Public Class ConfigurationBuilder
Implements IConfigurationBuilder

継承

Object

ConfigurationBuilder

実装

IConfigurationBuilder

注釈

このクラスを使用すると、たとえば JSON ファイルに構成値を格納し、実行時にそれらを取得できます。 詳細については、「 構成 - 基本的な例」を参照してください。

アプリを .NET Core 3.1 以降のバージョンに移行する場合は、このクラスを使用して、以前にアプリの構成に使用した app.config ファイル機能を置き換えることができます。

例

次のコード スニペットは、実行時に JSON ファイルから文字列値を取得するオブジェクトを作成 ConfigurationBuilder する簡略化されたアプリを示しています。

using Microsoft.Extensions.Configuration;

IConfigurationBuilder builder = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true);
IConfigurationRoot root = builder.Build();

Console.WriteLine($"Hello, { root["weather"] } world!");

/* This program outputs the following text:
 * 
 * Hello, stormy world!
 */

JSON ファイルの内容を次に示します。

{
  "weather": "stormy"
}

コンストラクター

ConfigurationBuilder()

ConfigurationBuilder クラスの新しいインスタンスを初期化します。

プロパティ

Properties	と登録済みの構成プロバイダーの間 IConfigurationBuilder でデータを共有するために使用できるキー/値コレクションを取得します。
Sources	構成値の取得に使用されるソースを取得します。

メソッド

Add(IConfigurationSource)	新しい構成ソースを追加します。
Build()	Sources に登録されているプロバイダー セットのキーと値を使用して IConfiguration を構築します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

拡張メソッド

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 を追加します。
Add<TSource>(IConfigurationBuilder, Action<TSource>)	新しい構成ソースを追加します。
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)	ユーザー シークレットの構成ソースを追加します。 これにより、ユーザー シークレット 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 に追加します。

こちらもご覧ください

• .NET での構成