ConfigurationManager 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:: ConfigurationManager.cs

Quelle:: ConfigurationManager.cs

Quelle:: ConfigurationManager.cs

Quelle:: ConfigurationManager.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.

Stellt ein veränderbares Konfigurationsobjekt dar. Es ist sowohl ein IConfigurationBuilder als auch ein IConfigurationRoot. Wenn Quellen hinzugefügt werden, aktualisiert sie die aktuelle Ansicht der Konfiguration. Sobald IConfigurationBuilder.Build() aufgerufen wird, wird die Konfiguration fixiert.

public ref class ConfigurationManager sealed : IDisposable, Microsoft::Extensions::Configuration::IConfigurationManager, Microsoft::Extensions::Configuration::IConfigurationRoot

public sealed class ConfigurationManager : IDisposable, Microsoft.Extensions.Configuration.IConfigurationManager, Microsoft.Extensions.Configuration.IConfigurationRoot

type ConfigurationManager = class
    interface IConfigurationManager
    interface IConfiguration
    interface IConfigurationBuilder
    interface IConfigurationRoot
    interface IDisposable

Public NotInheritable Class ConfigurationManager
Implements IConfigurationManager, IConfigurationRoot, IDisposable

Vererbung: Object
ConfigurationManager

Implementiert: IConfiguration IConfigurationBuilder IConfigurationManager IConfigurationRoot IDisposable

Hinweise

Es ist sowohl ein IConfigurationBuilder als auch ein IConfigurationRoot. Wenn Quellen hinzugefügt werden, aktualisiert sie die aktuelle Ansicht der Konfiguration. Sobald IConfigurationBuilder.Build() aufgerufen wird, wird die Konfiguration fixiert.

Konstruktoren

ConfigurationManager()

Erstellt ein leeres änderbares Konfigurationsobjekt, das sowohl ein IConfigurationBuilder als auch ein IConfigurationRootist.

Eigenschaften

Item[String]	Dient zum Abrufen oder Festlegen eines Konfigurationswerts.
Sources	Ruft die Quellen ab, die zum Abrufen von Konfigurationswerten verwendet werden.

Methoden

Dispose()	Führt anwendungsdefinierte Aufgaben aus, die mit dem Freigeben, Freigeben oder Zurücksetzen nicht verwalteter Ressourcen verknüpft sind.
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
GetChildren()	Ruft die direkt untergeordneten Konfigurationsunterabschnitte ab.
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetSection(String)	Ruft einen Konfigurationsunterabschnitt mit dem angegebenen Schlüssel ab.
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)

Explizite Schnittstellenimplementierungen

IConfiguration.GetReloadToken()	Gibt einen IChangeToken zurück, der verwendet werden kann, um zu beobachten, wann diese Konfiguration neu geladen wird.
IConfigurationBuilder.Add(IConfigurationSource)	Fügt eine neue Konfigurationsquelle hinzu.
IConfigurationBuilder.Build()	Erstellt eine IConfiguration mit Schlüsseln und Werten aus der Gruppe von Quellen, die in Sourcesregistriert sind.
IConfigurationBuilder.Properties	Ruft eine Schlüsselwertauflistung ab, die zum Freigeben von Daten zwischen dem IConfigurationBuilder und den registrierten Konfigurationsquellen verwendet werden kann.
IConfigurationRoot.Providers	Ruft die Konfigurationsanbieter für diese Konfiguration ab.
IConfigurationRoot.Reload()	Erzwingt, dass die Konfigurationswerte aus den zugrunde liegenden IConfigurationProvider Instanzen neu geladen werden.

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.
Bind(IConfiguration, Object)	Versucht, die angegebene Objektinstanz rekursiv an Konfigurationswerte zu binden, indem Eigenschaftennamen mit Konfigurationsschlüsseln übereinstimmen.
Bind(IConfiguration, Object, Action<BinderOptions>)	Versucht, die angegebene Objektinstanz rekursiv an Konfigurationswerte zu binden, indem Eigenschaftennamen mit Konfigurationsschlüsseln übereinstimmen.
Bind(IConfiguration, String, Object)	Versucht, die angegebene Objektinstanz an den vom Schlüssel angegebenen Konfigurationsabschnitt zu binden, indem Eigenschaftennamen rekursiv mit Konfigurationsschlüsseln abgegleicht werden.
Get(IConfiguration, Type)	Versucht, die Konfigurationsinstanz an eine neue Instanz vom Typ T zu binden. Wenn dieser Konfigurationsabschnitt einen Wert aufweist, wird dieser verwendet. Andernfalls wird die Bindung durch Zuordnen von Eigenschaftennamen mit Konfigurationsschlüsseln rekursiv festgelegt.
Get(IConfiguration, Type, Action<BinderOptions>)	Versucht, die Konfigurationsinstanz an eine neue Instanz vom Typ T zu binden. Wenn dieser Konfigurationsabschnitt einen Wert aufweist, wird dieser verwendet. Andernfalls wird die Bindung durch Zuordnen von Eigenschaftennamen mit Konfigurationsschlüsseln rekursiv festgelegt.
Get<T>(IConfiguration)	Versucht, die Konfigurationsinstanz an eine neue Instanz vom Typ T zu binden. Wenn dieser Konfigurationsabschnitt einen Wert aufweist, wird dieser verwendet. Andernfalls wird die Bindung durch Zuordnen von Eigenschaftennamen mit Konfigurationsschlüsseln rekursiv festgelegt.
Get<T>(IConfiguration, Action<BinderOptions>)	Versucht, die Konfigurationsinstanz an eine neue Instanz vom Typ T zu binden. Wenn dieser Konfigurationsabschnitt einen Wert aufweist, wird dieser verwendet. Andernfalls wird die Bindung durch Zuordnen von Eigenschaftennamen mit Konfigurationsschlüsseln rekursiv festgelegt.
GetValue(IConfiguration, Type, String)	Extrahiert den Wert mit dem angegebenen Schlüssel und konvertiert ihn in den angegebenen Typ.
GetValue(IConfiguration, Type, String, Object)	Extrahiert den Wert mit dem angegebenen Schlüssel und konvertiert ihn in den angegebenen Typ.
GetValue<T>(IConfiguration, String)	Extrahiert den Wert mit dem angegebenen Schlüssel und konvertiert ihn in den Typ T.
GetValue<T>(IConfiguration, String, T)	Extrahiert den Wert mit dem angegebenen Schlüssel und konvertiert ihn in den Typ T.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Fügt eine neue Konfigurationsquelle hinzu.
AsEnumerable(IConfiguration)	Rufen Sie die Aufzählung von Schlüssel-Wert-Paaren innerhalb der IConfigurationab.
AsEnumerable(IConfiguration, Boolean)	Ruft die Aufzählung von Schlüssel-Wert-Paaren innerhalb der IConfigurationab.
GetConnectionString(IConfiguration, String)	Ruft den Wert mit dem angegebenen Schlüssel aus dem abschnitt `ConnectionStrings` der Konfigurationsquelle ab. Das Aufrufen dieser Methode ist kurz für `GetSection("ConnectionStrings")[name]`.
GetRequiredSection(IConfiguration, String)	Ruft den Konfigurationsunterabschnitt ab, der den angegebenen Schlüssel aufweist.
GetDebugView(IConfigurationRoot)	Generiert eine lesbare Ansicht der Konfiguration, die zeigt, woher jeder Wert stammt.
GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>)	Generiert eine lesbare Ansicht der Konfiguration, die zeigt, woher jeder Wert stammt.
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:

Freigeben über