ConfigurationBuilder Sınıf

Tanım

Ad Alanı:

Microsoft.Extensions.Configuration

Bütünleştirilmiş Kod:

Microsoft.Extensions.Configuration.dll

Paket:

Microsoft.Extensions.Configuration v9.0.0-preview.7.24405.7

Kaynak:

ConfigurationBuilder.cs

Uygulamada kullanmak üzere anahtar/değer tabanlı yapılandırma ayarları oluşturmak için kullanılır.

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

Devralma

Object

ConfigurationBuilder

Uygulamalar

IConfigurationBuilder

Açıklamalar

Bu sınıfı kullanarak, yapılandırma değerlerini örneğin bir JSON dosyasında depolayabilir ve sonra çalışma zamanında alabilirsiniz. Daha fazla bilgi için bkz. Yapılandırması - temel örnek.

Bir uygulamayı .NET Core 3.1 veya sonraki bir sürüme geçiriyorsanız, uygulamanızı yapılandırmak için daha önce kullanmış olabileceğiniz app.config dosya işlevselliğini değiştirmek için bu sınıfı kullanabilirsiniz.

Örnek

Aşağıdaki kod parçacığı, çalışma zamanında bir JSON dosyasından dize değeri almak için ConfigurationBuilder nesnesi oluşturan basitleştirilmiş bir uygulama gösterir.

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 dosyasının içeriği burada gösterilir.

{
  "weather": "stormy"
}

Oluşturucular

ConfigurationBuilder()

ConfigurationBuilder sınıfının yeni bir örneğini başlatır.

Özellikler

Properties	IConfigurationBuilder ve kayıtlı yapılandırma sağlayıcıları arasında veri paylaşmak için kullanılabilecek bir anahtar/değer koleksiyonu alır.
Sources	Yapılandırma değerlerini almak için kullanılan kaynakları alır.

Yöntemler

Add(IConfigurationSource)	Yeni bir yapılandırma kaynağı ekler.
Build()	Sources'de kayıtlı sağlayıcı kümesindeki anahtarlar ve değerlerle bir IConfiguration oluşturur.
Equals(Object)	Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler. (Devralındığı yer: Object)
GetHashCode()	Varsayılan karma işlevi işlevi görür. (Devralındığı yer: Object)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)

Uzantı Metotları

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Uygulama meta verileri için bir yapılandırma sağlayıcısı kaydeder.
AddConfiguration(IConfigurationBuilder, IConfiguration)	configurationBuildervar olan bir yapılandırma ekler.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	configurationBuildervar olan bir yapılandırma ekler.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Komut satırından yapılandırma değerlerini okuyan bir IConfigurationProvider ekler.
AddCommandLine(IConfigurationBuilder, String[])	Komut satırından yapılandırma değerlerini okuyan bir CommandLineConfigurationProvider ekler.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Belirtilen anahtar eşlemelerini kullanarak komut satırından yapılandırma değerlerini okuyan bir CommandLineConfigurationProvider ekler.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Yeni bir yapılandırma kaynağı ekler.
AddEnvironmentVariables(IConfigurationBuilder)	Ortam değişkenlerinden yapılandırma değerlerini okuyan bir IConfigurationProvider ekler.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Ortam değişkenlerinden yapılandırma değerlerini okuyan bir IConfigurationProvider ekler.
AddEnvironmentVariables(IConfigurationBuilder, String)	Belirtilen ön eke sahip ortam değişkenlerinden yapılandırma değerlerini okuyan bir IConfigurationProvider ekler.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Dosya tabanlı sağlayıcılar için kullanılacak varsayılan IFileProvider alır.
GetFileProvider(IConfigurationBuilder)	Dosya tabanlı sağlayıcılar için kullanılacak varsayılan IFileProvider alır.
SetBasePath(IConfigurationBuilder, String)	Dosya tabanlı sağlayıcılar için FileProvider'ı temel yolu olan bir PhysicalFileProvider olarak ayarlar.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Bir hata oluştuğunda dosya tabanlı sağlayıcılar için çağrılacak varsayılan eylemi ayarlar.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Dosya tabanlı sağlayıcılar için kullanılacak varsayılan IFileProvider ayarlar.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	builderbir INI yapılandırma kaynağı ekler.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	builderbir INI yapılandırma kaynağı ekler.
AddIniFile(IConfigurationBuilder, String)	path ini yapılandırma sağlayıcısını builderekler.
AddIniFile(IConfigurationBuilder, String, Boolean)	path ini yapılandırma sağlayıcısını builderekler.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	path ini yapılandırma sağlayıcısını builderekler.
AddIniStream(IConfigurationBuilder, Stream)	builderbir INI yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	builderbir JSON yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	builderbir JSON yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, String)	path'daki JSON yapılandırma sağlayıcısını builderekler.
AddJsonFile(IConfigurationBuilder, String, Boolean)	path'daki JSON yapılandırma sağlayıcısını builderekler.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	path'daki JSON yapılandırma sağlayıcısını builderekler.
AddJsonStream(IConfigurationBuilder, Stream)	builderbir JSON yapılandırma kaynağı ekler.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Dizinden dosyaları kullanarak yapılandırma ekler. Dosya adları anahtar olarak, dosya içeriği ise değer olarak kullanılır.
AddKeyPerFile(IConfigurationBuilder, String)	Dizinden dosyaları kullanarak yapılandırma ekler. Dosya adları anahtar olarak, dosya içeriği ise değer olarak kullanılır.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Dizinden dosyaları kullanarak yapılandırma ekler. Dosya adları anahtar olarak, dosya içeriği ise değer olarak kullanılır.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Dizinden dosyaları kullanarak yapılandırma ekler. Dosya adları anahtar olarak, dosya içeriği ise değer olarak kullanılır.
AddInMemoryCollection(IConfigurationBuilder)	bellek yapılandırma sağlayıcısını configurationBuilderekler.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	bellek yapılandırma sağlayıcısını configurationBuilderekler.
AddUserSecrets(IConfigurationBuilder, Assembly)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Bu, assembly kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Bu, assembly kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Bu, assembly kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets(IConfigurationBuilder, String)	Kullanıcı gizli dizileri yapılandırma kaynağını belirtilen kullanıcı gizli dizileri kimliğiyle ekler. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını belirtilen kullanıcı gizli dizileri kimliğiyle ekler. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets<T>(IConfigurationBuilder)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. T türü içeren derlemede kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. T türü içeren derlemede kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. T türü içeren derlemede kullanıcı gizli dizi kimliğini belirten UserSecretsIdAttributeörneğini arar. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz bir değerdir.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	builderbir XML yapılandırma kaynağı ekler.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	builderbir XML yapılandırma kaynağı ekler.
AddXmlFile(IConfigurationBuilder, String)	path'daki XML yapılandırma sağlayıcısını builderekler.
AddXmlFile(IConfigurationBuilder, String, Boolean)	path'daki XML yapılandırma sağlayıcısını builderekler.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	path'daki XML yapılandırma sağlayıcısını builderekler.
AddXmlStream(IConfigurationBuilder, Stream)	builderbir XML yapılandırma kaynağı ekler.

Ayrıca bkz.

• .NET'de Yapılandırması