ConfigurationBuilder Klass

Definition

Namnområde:: Microsoft.Extensions.Configuration

Sammansättning:: Microsoft.Extensions.Configuration.dll

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

Källa:: ConfigurationBuilder.cs

Källa:: ConfigurationBuilder.cs

Källa:: ConfigurationBuilder.cs

Källa:: ConfigurationBuilder.cs

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

Skapar nyckel-/värdebaserade konfigurationsinställningar för användning i ett program.

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

Arv: Object
ConfigurationBuilder

Implementeringar: IConfigurationBuilder

Kommentarer

Med hjälp av den här klassen kan du till exempel lagra konfigurationsvärden i en JSON-fil och sedan hämta dem vid körning. Mer information finns i Konfiguration – grundläggande exempel.

Om du migrerar en app till .NET Core 3.1 eller en senare version kan du använda den här klassen för att ersätta filfunktionerna app.config som du tidigare har använt för att konfigurera appen.

Example

Följande kodfragment visar en förenklad app som skapar ett ConfigurationBuilder objekt för att hämta ett strängvärde från en JSON-fil vid körning.

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

Innehållet i JSON-filen visas här.

{
  "weather": "stormy"
}

Konstruktorer

Name	Description
ConfigurationBuilder()	Initierar en ny instans av ConfigurationBuilder klassen.

Egenskaper

Name	Description
Properties	Hämtar en nyckel-/värdesamling som kan användas för att dela data mellan IConfigurationBuilder och de registrerade IConfigurationProvider leverantörerna.
Sources	Hämtar de källor som används för att hämta konfigurationsvärden.

Metoder

Name	Description
Add(IConfigurationSource)	Lägger till en ny konfigurationskälla.
Build()	Skapar en IConfiguration med nycklar och värden från uppsättningen providers som är registrerade i Sources.

Tilläggsmetoder

Name	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Lägger till en ny konfigurationskälla.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registrerar en konfigurationsprovider för programmetadata.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Lägger till ett IConfigurationProvider som läser konfigurationsvärden från kommandoraden.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Lägger till en CommandLineConfigurationProvider IConfigurationProvider som läser konfigurationsvärden från kommandoraden med hjälp av de angivna växelmappningarna.
AddCommandLine(IConfigurationBuilder, String[])	Lägger till en CommandLineConfigurationProvider IConfigurationProvider som läser konfigurationsvärden från kommandoraden.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Lägger till en befintlig konfiguration i `configurationBuilder`.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Lägger till en befintlig konfiguration i `configurationBuilder`.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Lägger till en IConfigurationProvider som läser konfigurationsvärden från miljövariabler.
AddEnvironmentVariables(IConfigurationBuilder, String)	Lägger till ett IConfigurationProvider som läser konfigurationsvärden från miljövariabler med ett angivet prefix.
AddEnvironmentVariables(IConfigurationBuilder)	Lägger till en IConfigurationProvider som läser konfigurationsvärden från miljövariabler.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Lägger till en INI-konfigurationskälla i `builder`.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Lägger till en INI-konfigurationskälla i `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Lägger till INI-konfigurationsprovidern på `path` i `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean)	Lägger till INI-konfigurationsprovidern på `path` i `builder`.
AddIniFile(IConfigurationBuilder, String)	Lägger till INI-konfigurationsprovidern på `path` i `builder`.
AddIniStream(IConfigurationBuilder, Stream)	Lägger till en INI-konfigurationskälla i `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Lägger till minneskonfigurationsprovidern i `configurationBuilder`.
AddInMemoryCollection(IConfigurationBuilder)	Lägger till minneskonfigurationsprovidern i `configurationBuilder`.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Lägger till en JSON-konfigurationskälla i `builder`.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Lägger till en JSON-konfigurationskälla i `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Lägger till JSON-konfigurationsprovidern på `path` i `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Lägger till JSON-konfigurationsprovidern på `path` i `builder`.
AddJsonFile(IConfigurationBuilder, String)	Lägger till JSON-konfigurationsprovidern på `path` i `builder`.
AddJsonStream(IConfigurationBuilder, Stream)	Lägger till en JSON-konfigurationskälla i `builder`.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Lägger till konfiguration med filer från en katalog. Filnamn används som nyckel, filinnehåll används som värde.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Lägger till konfiguration med filer från en katalog. Filnamn används som nyckel, filinnehåll används som värde.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Lägger till konfiguration med filer från en katalog. Filnamn används som nyckel, filinnehåll används som värde.
AddKeyPerFile(IConfigurationBuilder, String)	Lägger till konfiguration med filer från en katalog. Filnamn används som nyckel, filinnehåll används som värde.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Lägger till konfigurationskällan för användarhemligheter. Detta söker efter `assembly` en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Lägger till konfigurationskällan för användarhemligheter. Detta söker efter `assembly` en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets(IConfigurationBuilder, Assembly)	Lägger till konfigurationskällan för användarhemligheter. Detta söker efter `assembly` en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Lägger till konfigurationskällan för användarhemligheter med angivet användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets(IConfigurationBuilder, String)	Lägger till konfigurationskällan för användarhemligheter med angivet användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Lägger till konfigurationskällan för användarhemligheter. Söker i sammansättningen som innehåller typen `T` för en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Lägger till konfigurationskällan för användarhemligheter. Söker i sammansättningen som innehåller typen `T` för en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddUserSecrets<T>(IConfigurationBuilder)	Lägger till konfigurationskällan för användarhemligheter. Söker i sammansättningen som innehåller typen `T` för en instans av UserSecretsIdAttribute, som anger ett användarhemlighets-ID. Ett användarhemlighets-ID är ett unikt värde som används för att lagra och identifiera en samling hemliga konfigurationsvärden.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Lägger till en XML-konfigurationskälla i `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Lägger till en XML-konfigurationskälla i `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Lägger till XML-konfigurationsprovidern på `path` i `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Lägger till XML-konfigurationsprovidern på `path` i `builder`.
AddXmlFile(IConfigurationBuilder, String)	Lägger till XML-konfigurationsprovidern på `path` i `builder`.
AddXmlStream(IConfigurationBuilder, Stream)	Lägger till en XML-konfigurationskälla i `builder`.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Hämtar en standardåtgärd som ska anropas för filbaserade leverantörer när ett fel inträffar.
GetFileProvider(IConfigurationBuilder)	Hämtar standardvärdet IFileProvider som ska användas för filbaserade leverantörer.
SetBasePath(IConfigurationBuilder, String)	Anger FileProvider för filbaserade providers till en PhysicalFileProvider med bassökvägen.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Anger en standardåtgärd som ska anropas för filbaserade leverantörer när ett fel inträffar.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Anger standardvärdet IFileProvider som ska användas för filbaserade leverantörer.

Gäller för

Se även

Konfiguration i .NET

Feedback

Var den här sidan till hjälp?