ConfigurationBuilder Klasse

Referenz

Definition

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.dll

Paket:: Microsoft.Extensions.Configuration v8.0.0

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

Quelle:: ConfigurationBuilder.cs

Quelle:: ConfigurationBuilder.cs

Quelle:: ConfigurationBuilder.cs

Quelle:: ConfigurationBuilder.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Wird verwendet, um Schlüssel-/Wertbasierte Konfigurationseinstellungen für die Verwendung in einer Anwendung zu erstellen.

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

Vererbung: Object
ConfigurationBuilder

Implementiert: IConfigurationBuilder

Hinweise

Mithilfe dieser Klasse können Sie Konfigurationswerte beispielsweise in einer JSON-Datei speichern und diese dann zur Laufzeit abrufen. Weitere Informationen finden Sie unter Configuration – grundlegendes Beispiel.

Wenn Sie eine App zu .NET Core 3.1 oder einer höheren Version migrieren, können Sie diese Klasse verwenden, um die app.config Dateifunktionalität zu ersetzen, die Sie möglicherweise zuvor zum Konfigurieren Der App verwendet haben.

Beispiel

Der folgende Codeausschnitt zeigt eine vereinfachte App, die ein ConfigurationBuilder -Objekt erstellt, um einen Zeichenfolgenwert aus einer JSON-Datei zur Laufzeit abzurufen.

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!
 */

Der Inhalt der JSON-Datei wird hier angezeigt.

{
  "weather": "stormy"
}

Konstruktoren

ConfigurationBuilder()

Initialisiert eine neue Instanz der ConfigurationBuilder Klasse.

Eigenschaften

Properties	Ruft eine Schlüssel-/Wertauflistung ab, die zum Freigeben von Daten zwischen dem IConfigurationBuilder und den registrierten Konfigurationsanbietern verwendet werden kann.
Sources	Ruft die Quellen ab, die zum Abrufen von Konfigurationswerten verwendet werden.

Methoden

Add(IConfigurationSource)	Fügt eine neue Konfigurationsquelle hinzu.
Build()	Erstellt eine IConfiguration mit Schlüsseln und Werten aus der Gruppe von Anbietern, die in Sourcesregistriert sind.
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)

Erweiterungsmethoden

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registriert einen Konfigurationsanbieter für Anwendungsmetadaten.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Fügt eine vorhandene Konfiguration zu `configurationBuilder`hinzu.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Fügt eine vorhandene Konfiguration zu `configurationBuilder`hinzu.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Fügt eine IConfigurationProvider hinzu, die Konfigurationswerte aus der Befehlszeile liest.
AddCommandLine(IConfigurationBuilder, String[])	Fügt eine CommandLineConfigurationProvider hinzu, die Konfigurationswerte aus der Befehlszeile liest.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Fügt eine CommandLineConfigurationProvider hinzu, die Konfigurationswerte über die Befehlszeile mithilfe der angegebenen Switchzuordnungen liest.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Fügt eine neue Konfigurationsquelle hinzu.
AddEnvironmentVariables(IConfigurationBuilder)	Fügt eine IConfigurationProvider hinzu, die Konfigurationswerte aus Umgebungsvariablen liest.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Fügt eine IConfigurationProvider hinzu, die Konfigurationswerte aus Umgebungsvariablen liest.
AddEnvironmentVariables(IConfigurationBuilder, String)	Fügt eine IConfigurationProvider hinzu, die Konfigurationswerte aus Umgebungsvariablen mit einem angegebenen Präfix liest.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Ruft die Standard-IFileProvider ab, die für dateibasierte Anbieter verwendet werden soll.
GetFileProvider(IConfigurationBuilder)	Ruft die Standard-IFileProvider ab, die für dateibasierte Anbieter verwendet werden soll.
SetBasePath(IConfigurationBuilder, String)	Legt den FileProvider für dateibasierte Anbieter auf einen PhysicalFileProvider mit dem Basispfad fest.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Legt fest, dass eine Standardaktion für dateibasierte Anbieter aufgerufen wird, wenn ein Fehler auftritt.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Legt den standardbasierten IFileProvider fest, der für dateibasierte Anbieter verwendet werden soll.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt `builder`eine INI-Konfigurationsquelle hinzu.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Fügt `builder`eine INI-Konfigurationsquelle hinzu.
AddIniFile(IConfigurationBuilder, String)	Fügt den INI-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddIniFile(IConfigurationBuilder, String, Boolean)	Fügt den INI-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den INI-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddIniStream(IConfigurationBuilder, Stream)	Fügt `builder`eine INI-Konfigurationsquelle hinzu.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt der `builder`eine JSON-Konfigurationsquelle hinzu.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Fügt der `builder`eine JSON-Konfigurationsquelle hinzu.
AddJsonFile(IConfigurationBuilder, String)	Fügt den JSON-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Fügt den JSON-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den JSON-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddJsonStream(IConfigurationBuilder, Stream)	Fügt der `builder`eine JSON-Konfigurationsquelle hinzu.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Fügt die Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte werden als Wert verwendet.
AddKeyPerFile(IConfigurationBuilder, String)	Fügt die Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte werden als Wert verwendet.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Fügt die Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte werden als Wert verwendet.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt die Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte werden als Wert verwendet.
AddInMemoryCollection(IConfigurationBuilder)	Fügt den Speicherkonfigurationsanbieter zu `configurationBuilder`hinzu.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Fügt den Speicherkonfigurationsanbieter zu `configurationBuilder`hinzu.
AddUserSecrets(IConfigurationBuilder, Assembly)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dadurch wird `assembly` nach einer Instanz von UserSecretsIdAttributedurchsucht, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dadurch wird `assembly` nach einer Instanz von UserSecretsIdAttributedurchsucht, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dadurch wird `assembly` nach einer Instanz von UserSecretsIdAttributedurchsucht, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets(IConfigurationBuilder, String)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel mit der angegebenen ID für geheime Benutzerschlüssel hinzu. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel mit der angegebenen ID für geheime Benutzerschlüssel hinzu. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets<T>(IConfigurationBuilder)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Durchsucht die Assembly, die typ `T` enthält, nach einer Instanz von UserSecretsIdAttribute, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Durchsucht die Assembly, die typ `T` enthält, nach einer Instanz von UserSecretsIdAttribute, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Durchsucht die Assembly, die typ `T` enthält, nach einer Instanz von UserSecretsIdAttribute, die eine geheime Benutzer-ID angibt. Eine geheime Benutzer-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung geheimer Konfigurationswerte verwendet wird.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt `builder`eine XML-Konfigurationsquelle hinzu.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Fügt `builder`eine XML-Konfigurationsquelle hinzu.
AddXmlFile(IConfigurationBuilder, String)	Fügt den XML-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Fügt den XML-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den XML-Konfigurationsanbieter bei `path` zu `builder`hinzu.
AddXmlStream(IConfigurationBuilder, Stream)	Fügt `builder`eine XML-Konfigurationsquelle hinzu.

Gilt für:

Weitere Informationen

-Konfiguration in .NET-

Freigeben über