ConfigurationBuilder クラス

リファレンス

定義

名前空間:: Microsoft.Extensions.Configuration

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

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

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

ソース:: ConfigurationBuilder.cs

ソース:: ConfigurationBuilder.cs

ソース:: ConfigurationBuilder.cs

ソース:: ConfigurationBuilder.cs

重要

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

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

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)	`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`に追加します。

適用対象

こちらもご覧ください

.NET での構成

次の方法で共有