ConfigurationBuilder Klasse

Definition

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.dll

Paket:: Microsoft.Extensions.Configuration v11.0.0-preview.4.26230.115

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.

Erstellt Schlüssel-/Wertbasierte Konfigurationseinstellungen für die Verwendung in einer Anwendung.

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 Dateifunktionalität app.config zu ersetzen, die Sie möglicherweise zuvor zum Konfigurieren der App verwendet haben.

Example

Der folgende Codeausschnitt zeigt eine vereinfachte App, die ein ConfigurationBuilder Objekt zum Abrufen eines Zeichenfolgenwerts aus einer JSON-Datei zur Laufzeit erstellt.

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

Name	Beschreibung
ConfigurationBuilder()	Initialisiert eine neue Instanz der ConfigurationBuilder-Klasse.

Eigenschaften

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

Methoden

Name	Beschreibung
Add(IConfigurationSource)	Fügt eine neue Konfigurationsquelle hinzu.
Build()	Erstellt einen IConfiguration mit Schlüsseln und Werten aus der Gruppe von Anbietern, die in Sourcesregistriert sind.

Erweiterungsmethoden

Name	Beschreibung
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Fügt eine neue Konfigurationsquelle hinzu.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registriert einen Konfigurationsanbieter für Anwendungsmetadaten.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Fügt einen IConfigurationProvider Wert hinzu, der Konfigurationswerte aus der Befehlszeile liest.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Fügt einen CommandLineConfigurationProvider IConfigurationProvider Wert hinzu, der Konfigurationswerte aus der Befehlszeile mithilfe der angegebenen Switchzuordnungen liest.
AddCommandLine(IConfigurationBuilder, String[])	Fügt einen CommandLineConfigurationProvider IConfigurationProvider Wert hinzu, der Konfigurationswerte aus der Befehlszeile liest.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Fügt eine vorhandene Konfiguration hinzu.`configurationBuilder`
AddConfiguration(IConfigurationBuilder, IConfiguration)	Fügt eine vorhandene Konfiguration hinzu.`configurationBuilder`
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Fügt einen IConfigurationProvider Wert hinzu, der Konfigurationswerte aus Umgebungsvariablen liest.
AddEnvironmentVariables(IConfigurationBuilder, String)	Fügt einen IConfigurationProvider Wert hinzu, der Konfigurationswerte aus Umgebungsvariablen mit einem angegebenen Präfix liest.
AddEnvironmentVariables(IConfigurationBuilder)	Fügt einen IConfigurationProvider Wert hinzu, der Konfigurationswerte aus Umgebungsvariablen liest.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Fügt eine INI-Konfigurationsquelle zu `builder`.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt eine INI-Konfigurationsquelle zu `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den INI-Konfigurationsanbieter zu `pathbuilder`.
AddIniFile(IConfigurationBuilder, String, Boolean)	Fügt den INI-Konfigurationsanbieter zu `pathbuilder`.
AddIniFile(IConfigurationBuilder, String)	Fügt den INI-Konfigurationsanbieter zu `pathbuilder`.
AddIniStream(IConfigurationBuilder, Stream)	Fügt eine INI-Konfigurationsquelle zu `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Fügt den Speicherkonfigurationsanbieter hinzu `configurationBuilder`.
AddInMemoryCollection(IConfigurationBuilder)	Fügt den Speicherkonfigurationsanbieter hinzu `configurationBuilder`.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Fügt eine JSON-Konfigurationsquelle hinzu.`builder`
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt eine JSON-Konfigurationsquelle hinzu.`builder`
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den JSON-Konfigurationsanbieter zu `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Fügt den JSON-Konfigurationsanbieter zu `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String)	Fügt den JSON-Konfigurationsanbieter zu `pathbuilder`.
AddJsonStream(IConfigurationBuilder, Stream)	Fügt eine JSON-Konfigurationsquelle hinzu.`builder`
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, Boolean, 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)	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.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dies sucht nach `assembly` 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(IConfigurationBuilder, Assembly, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dies sucht nach `assembly` 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(IConfigurationBuilder, Assembly)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Dies sucht nach `assembly` 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(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(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<T>(IConfigurationBuilder, Boolean, Boolean)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Durchsucht die Assembly, die den Typ `T` einer Instanz enthält 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 den Typ `T` einer Instanz enthält 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)	Fügt die Konfigurationsquelle für geheime Benutzerschlüssel hinzu. Durchsucht die Assembly, die den Typ `T` einer Instanz enthält 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, Action<XmlConfigurationSource>)	Fügt der XML-Konfigurationsquelle eine XML-Konfigurationsquelle hinzu `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Fügt der XML-Konfigurationsquelle eine XML-Konfigurationsquelle hinzu `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Fügt den XML-Konfigurationsanbieter zu `pathbuilder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Fügt den XML-Konfigurationsanbieter zu `pathbuilder`.
AddXmlFile(IConfigurationBuilder, String)	Fügt den XML-Konfigurationsanbieter zu `pathbuilder`.
AddXmlStream(IConfigurationBuilder, Stream)	Fügt der XML-Konfigurationsquelle eine XML-Konfigurationsquelle hinzu `builder`.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Ruft eine Standardaktion ab, die für dateibasierte Anbieter aufgerufen werden soll, wenn ein Fehler auftritt.
GetFileProvider(IConfigurationBuilder)	Ruft den Standardwert IFileProvider ab, der 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 Standardwert IFileProvider fest, der für dateibasierte Anbieter verwendet werden soll.

Gilt für:

Weitere Informationen

Konfiguration in .NET

Feedback

War diese Seite hilfreich?