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.4.24266.19

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 çalışma zamanında alabilirsiniz. Daha fazla bilgi için bkz . Yapılandırma - 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 ConfigurationBuilder JSON dosyasından dize değeri almak için bir nesne oluşturan basitleştirilmiş bir uygulamayı 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	ve kayıtlı yapılandırma sağlayıcıları arasında IConfigurationBuilder 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()	içinde kayıtlı Sourcessağlayıcı kümesinden 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()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi 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)	öğesine configurationBuildermevcut bir yapılandırma ekler.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	öğesine configurationBuildermevcut 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 IConfigurationProvider eke sahip ortam değişkenlerinden yapılandırma değerlerini okuyan bir ekler.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Dosya tabanlı sağlayıcılar için kullanılacak varsayılan IFileProvider değeri alır.
GetFileProvider(IConfigurationBuilder)	Dosya tabanlı sağlayıcılar için kullanılacak varsayılan IFileProvider değeri 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>)	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 değeri ayarlar.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	öğesine builderbir INI yapılandırma kaynağı ekler.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	öğesine builderbir INI yapılandırma kaynağı ekler.
AddIniFile(IConfigurationBuilder, String)	konumundaki INI yapılandırma sağlayıcısını path öğesine builderekler.
AddIniFile(IConfigurationBuilder, String, Boolean)	konumundaki INI yapılandırma sağlayıcısını path öğesine builderekler.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	konumundaki INI yapılandırma sağlayıcısını path öğesine builderekler.
AddIniStream(IConfigurationBuilder, Stream)	öğesine builderbir INI yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	öğesine builderbir JSON yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	öğesine builderbir JSON yapılandırma kaynağı ekler.
AddJsonFile(IConfigurationBuilder, String)	konumundaki JSON yapılandırma sağlayıcısını path öğesine builderekler.
AddJsonFile(IConfigurationBuilder, String, Boolean)	konumundaki JSON yapılandırma sağlayıcısını path öğesine builderekler.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	konumundaki JSON yapılandırma sağlayıcısını path öğesine builderekler.
AddJsonStream(IConfigurationBuilder, Stream)	öğesine 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ı öğesine configurationBuilderekler.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	bellek yapılandırma sağlayıcısını öğesine configurationBuilderekler.
AddUserSecrets(IConfigurationBuilder, Assembly)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Bu, assembly kullanıcı gizli dizi kimliğini UserSecretsIdAttributebelirten bir ö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 değerdir.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Bu, assembly kullanıcı gizli dizi kimliğini UserSecretsIdAttributebelirten bir ö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 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 UserSecretsIdAttributebelirten bir ö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 değerdir.
AddUserSecrets(IConfigurationBuilder, String)	Belirtilen kullanıcı gizli dizileri kimliğine sahip kullanıcı gizli dizileri yapılandırma kaynağını ekler. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz değerdir.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Belirtilen kullanıcı gizli dizileri kimliğine sahip kullanıcı gizli dizileri yapılandırma kaynağını ekler. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz değerdir.
AddUserSecrets<T>(IConfigurationBuilder)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Kullanıcı gizli dizileri kimliğini belirten bir örneği UserSecretsIdAttributeiçin türü T içeren derlemede arama yapın. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz değerdir.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Kullanıcı gizli dizileri kimliğini belirten bir örneği UserSecretsIdAttributeiçin türü T içeren derlemede arama yapın. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz değerdir.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Kullanıcı gizli dizileri yapılandırma kaynağını ekler. Kullanıcı gizli dizileri kimliğini belirten bir örneği UserSecretsIdAttributeiçin türü T içeren derlemede arama yapın. Kullanıcı gizli dizileri kimliği, gizli dizi yapılandırma değerlerinin koleksiyonunu depolamak ve tanımlamak için kullanılan benzersiz değerdir.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	öğesine builderbir XML yapılandırma kaynağı ekler.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	öğesine builderbir XML yapılandırma kaynağı ekler.
AddXmlFile(IConfigurationBuilder, String)	konumundaki path XML yapılandırma sağlayıcısını öğesine builderekler.
AddXmlFile(IConfigurationBuilder, String, Boolean)	konumundaki path XML yapılandırma sağlayıcısını öğesine builderekler.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	konumundaki path XML yapılandırma sağlayıcısını öğesine builderekler.
AddXmlStream(IConfigurationBuilder, Stream)	öğesine builderbir XML yapılandırma kaynağı ekler.

Ayrıca bkz.

• .NET'te yapılandırma