ConfigurationBuilder Clase

Definición

Espacio de nombres:

Microsoft.Extensions.Configuration

Ensamblado:

Microsoft.Extensions.Configuration.dll

Paquete:

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

Source:

ConfigurationBuilder.cs

Compila las opciones de configuración basadas en clave y valor para su uso en una aplicación.

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

Herencia

Object

ConfigurationBuilder

Implementaciones

IConfigurationBuilder

Comentarios

Con esta clase, puede almacenar valores de configuración en un archivo JSON, por ejemplo, y luego recuperarlos en tiempo de ejecución. Para obtener más información, vea Configuración: ejemplo básico.

Si va a migrar una aplicación a .NET Core 3.1 o una versión posterior, puede usar esta clase para reemplazar la funcionalidad de archivo app.config que puede haber usado anteriormente para configurar la aplicación.

Example

El fragmento de código siguiente muestra una aplicación simplificada que crea un ConfigurationBuilder objeto para recuperar un valor de cadena de un archivo JSON en tiempo de ejecución.

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

Aquí se muestra el contenido del archivo JSON.

{
  "weather": "stormy"
}

Constructores

Nombre	Description
ConfigurationBuilder()	Inicializa una nueva instancia de la clase ConfigurationBuilder.

Propiedades

Nombre	Description
Properties	Obtiene una colección de clave-valor que se puede usar para compartir datos entre los IConfigurationBuilder proveedores registrados IConfigurationProvider y .
Sources	Obtiene los orígenes usados para obtener valores de configuración.

Métodos

Nombre	Description
Add(IConfigurationSource)	Agrega un nuevo origen de configuración.
Build()	Compila con IConfiguration claves y valores del conjunto de proveedores registrados en Sources.

Métodos de extensión

Nombre	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Agrega un nuevo origen de configuración.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registra un proveedor de configuración para los metadatos de la aplicación.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Agrega un IConfigurationProvider objeto que lee los valores de configuración de la línea de comandos.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Agrega un CommandLineConfigurationProviderIConfigurationProvider objeto que lee los valores de configuración de la línea de comandos mediante las asignaciones de modificadores especificadas.
AddCommandLine(IConfigurationBuilder, String[])	Agrega un CommandLineConfigurationProviderIConfigurationProvider objeto que lee los valores de configuración de la línea de comandos.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Agrega una configuración existente a configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Agrega una configuración existente a configurationBuilder.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Agrega un IConfigurationProvider objeto que lee los valores de configuración de las variables de entorno.
AddEnvironmentVariables(IConfigurationBuilder, String)	Agrega un IConfigurationProvider objeto que lee los valores de configuración de las variables de entorno con un prefijo especificado.
AddEnvironmentVariables(IConfigurationBuilder)	Agrega un IConfigurationProvider objeto que lee los valores de configuración de las variables de entorno.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Agrega un origen de configuración INI a builder.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración INI a builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Agrega el proveedor de configuración INI en path a builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Agrega el proveedor de configuración INI en path a builder.
AddIniFile(IConfigurationBuilder, String)	Agrega el proveedor de configuración INI en path a builder.
AddIniStream(IConfigurationBuilder, Stream)	Agrega un origen de configuración INI a builder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Agrega el proveedor de configuración de memoria a configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder)	Agrega el proveedor de configuración de memoria a configurationBuilder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Agrega un origen de configuración JSON a builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración JSON a builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Agrega el proveedor de configuración JSON en path a builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Agrega el proveedor de configuración JSON en path a builder.
AddJsonFile(IConfigurationBuilder, String)	Agrega el proveedor de configuración JSON en path a builder.
AddJsonStream(IConfigurationBuilder, Stream)	Agrega un origen de configuración JSON a builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Agrega la configuración mediante archivos de un directorio. Los nombres de archivo se usan como clave, el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Agrega la configuración mediante archivos de un directorio. Los nombres de archivo se usan como clave, el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Agrega la configuración mediante archivos de un directorio. Los nombres de archivo se usan como clave, el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String)	Agrega la configuración mediante archivos de un directorio. Los nombres de archivo se usan como clave, el contenido del archivo se usa como valor.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Agrega el origen de configuración de secretos de usuario. Esto busca assembly una instancia de UserSecretsIdAttribute, que especifica un identificador de secretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Agrega el origen de configuración de secretos de usuario. Esto busca assembly una instancia de UserSecretsIdAttribute, que especifica un identificador de secretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets(IConfigurationBuilder, Assembly)	Agrega el origen de configuración de secretos de usuario. Esto busca assembly una instancia de UserSecretsIdAttribute, que especifica un identificador de secretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Agrega el origen de configuración de secretos de usuario con el identificador de secretos de usuario especificado. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets(IConfigurationBuilder, String)	Agrega el origen de configuración de secretos de usuario con el identificador de secretos de usuario especificado. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Agrega el origen de configuración de secretos de usuario. Busca en el ensamblado que contiene el tipo T de una instancia de , que especifica un identificador de UserSecretsIdAttributesecretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Agrega el origen de configuración de secretos de usuario. Busca en el ensamblado que contiene el tipo T de una instancia de , que especifica un identificador de UserSecretsIdAttributesecretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddUserSecrets<T>(IConfigurationBuilder)	Agrega el origen de configuración de secretos de usuario. Busca en el ensamblado que contiene el tipo T de una instancia de , que especifica un identificador de UserSecretsIdAttributesecretos de usuario. Un identificador de secretos de usuario es un valor único que se usa para almacenar e identificar una colección de valores de configuración de secretos.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Agrega un origen de configuración XML a builder.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración XML a builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Agrega el proveedor de configuración XML en path a builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Agrega el proveedor de configuración XML en path a builder.
AddXmlFile(IConfigurationBuilder, String)	Agrega el proveedor de configuración XML en path a builder.
AddXmlStream(IConfigurationBuilder, Stream)	Agrega un origen de configuración XML a builder.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtiene una acción predeterminada que se va a invocar para los proveedores basados en archivos cuando se produce un error.
GetFileProvider(IConfigurationBuilder)	Obtiene el valor predeterminado IFileProvider que se va a usar para los proveedores basados en archivos.
SetBasePath(IConfigurationBuilder, String)	Establece FileProvider para proveedores basados en archivos en physicalFileProvider con la ruta de acceso base.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Establece una acción predeterminada que se va a invocar para los proveedores basados en archivos cuando se produce un error.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Establece el valor predeterminado IFileProvider que se usará para los proveedores basados en archivos.

Consulte también

• Configuración en .NET