ConfigurationBuilder Klasse
Definition
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
-
ConfigurationBuilder
- Implementiert
Hinweise
Mit dieser Klasse können Sie Konfigurationswerte beispielsweise in einer JSON-Datei speichern und dann zur Laufzeit abrufen. Weitere Informationen finden Sie unter Konfiguration – einfaches 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 Ihrer App verwendet haben.
Beispiel
Der folgende Codeausschnitt zeigt eine vereinfachte App, die ein ConfigurationBuilder
-Objekt erstellt, um zur Laufzeit einen Zeichenfolgenwert aus einer JSON-Datei 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-Wert-Auflistung ab, die zum Freigeben von Daten zwischen den IConfigurationBuilder registrierten Konfigurationsanbietern und 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 dem Satz von Anbietern, die in Sources registriert sind. |
Equals(Object) |
Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object) |
GetHashCode() |
Fungiert als Standardhashfunktion. (Geerbt von Object) |
GetType() |
Ruft den Type der aktuellen Instanz ab. (Geerbt von Object) |
MemberwiseClone() |
Erstellt eine flache Kopie des 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 |
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean) |
Fügt |
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>) |
Fügt eine IConfigurationProvider-Schnittstelle hinzu, die Konfigurationswerte aus der Befehlszeile liest. |
AddCommandLine(IConfigurationBuilder, String[]) |
Fügt eine -Schnittstelle der CommandLineConfigurationProvider-Klasse hinzu, die Konfigurationswerte aus der Befehlszeile liest. |
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>) |
Fügt eine -Schnittstelle der CommandLineConfigurationProvider-Klasse hinzu, die mithilfe der angegebenen Optionszuordnungen Konfigurationswerte aus der Befehlszeile liest. |
Add<TSource>(IConfigurationBuilder, Action<TSource>) |
Fügt eine neue Konfigurationsquelle hinzu. |
AddEnvironmentVariables(IConfigurationBuilder) |
Fügt eine IConfigurationProvider-Schnittstelle hinzu, die Konfigurationswerte aus Umgebungsvariablen liest. |
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>) |
Fügt eine IConfigurationProvider-Schnittstelle hinzu, die Konfigurationswerte aus Umgebungsvariablen liest. |
AddEnvironmentVariables(IConfigurationBuilder, String) |
Fügt eine IConfigurationProvider-Schnittstelle hinzu, die Konfigurationswerte aus Umgebungsvariablen mit einem angegebenen Präfix liest. |
GetFileLoadExceptionHandler(IConfigurationBuilder) |
Ruft die Standardschnittstelle IFileProvider ab, die für dateibasierte Anbieter verwendet werden soll. |
GetFileProvider(IConfigurationBuilder) |
Ruft die Standardschnittstelle IFileProvider ab, die für dateibasierte Anbieter verwendet werden soll. |
SetBasePath(IConfigurationBuilder, String) |
Legt die FileProvider-Klasse für dateibasierte Anbieter auf eine PhysicalFileProvider-Klasse mit dem Basispfad fest. |
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>) |
Legt eine Standardaktion fest, die für dateibasierte Anbieter aufgerufen werden soll, wenn ein Fehler auftritt. |
SetFileProvider(IConfigurationBuilder, IFileProvider) |
Legt die Standardschnittstelle IFileProvider fest, die für dateibasierte Anbieter verwendet werden soll. |
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Fügt eine INI-Konfigurationsquelle zu |
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>) |
Fügt eine INI-Konfigurationsquelle zu |
AddIniFile(IConfigurationBuilder, String) |
Fügt den INI-Konfigurationsanbieter unter |
AddIniFile(IConfigurationBuilder, String, Boolean) |
Fügt den INI-Konfigurationsanbieter unter |
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean) |
Fügt den INI-Konfigurationsanbieter unter |
AddIniStream(IConfigurationBuilder, Stream) |
Fügt eine INI-Konfigurationsquelle zu |
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Fügt |
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>) |
Fügt |
AddJsonFile(IConfigurationBuilder, String) |
Fügt |
AddJsonFile(IConfigurationBuilder, String, Boolean) |
Fügt |
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean) |
Fügt |
AddJsonStream(IConfigurationBuilder, Stream) |
Fügt |
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>) |
Fügt Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte als Wert. |
AddKeyPerFile(IConfigurationBuilder, String) |
Fügt Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte als Wert. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean) |
Fügt Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte als Wert. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean) |
Fügt Konfiguration mithilfe von Dateien aus einem Verzeichnis hinzu. Dateinamen werden als Schlüssel verwendet, Dateiinhalte als Wert. |
AddInMemoryCollection(IConfigurationBuilder) |
Fügt den Speicherkonfigurationsanbieter |
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>) |
Fügt den Speicherkonfigurationsanbieter |
AddUserSecrets(IConfigurationBuilder, Assembly) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Dadurch wird Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Dadurch wird Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Dadurch wird Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets(IConfigurationBuilder, String) |
Fügt die Konfigurationsquelle von Benutzergeheimnissen mit angegebener Benutzergeheimnis-ID hinzu. Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets(IConfigurationBuilder, String, Boolean) |
Fügt die Konfigurationsquelle von Benutzergeheimnissen mit angegebener Benutzergeheimnis-ID hinzu. Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets<T>(IConfigurationBuilder) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Durchsucht die Assembly, die den Typ Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Durchsucht die Assembly, die den Typ Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean) |
Fügt die Konfigurationsquelle der Benutzergeheimnisse hinzu. Durchsucht die Assembly, die den Typ Eine Benutzergeheimnis-ID ist ein eindeutiger Wert, der zum Speichern und Identifizieren einer Sammlung von Geheimniskonfigurationswerten verwendet wird. |
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Fügt |
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>) |
Fügt |
AddXmlFile(IConfigurationBuilder, String) |
Fügt |
AddXmlFile(IConfigurationBuilder, String, Boolean) |
Fügt |
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean) |
Fügt |
AddXmlStream(IConfigurationBuilder, Stream) |
Fügt |
Gilt für:
Weitere Informationen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für