ConfigurationBuilder Clase

Definición

Espacio de nombres:

Microsoft.Extensions.Configuration

Ensamblado:

Microsoft.Extensions.Configuration.dll

Paquete:

Microsoft.Extensions.Configuration v9.0.0-preview.3.24172.9

Source:

ConfigurationBuilder.cs

Se usa para crear valores de configuración basados 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 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 archivoapp.config que puede haber usado anteriormente para configurar la aplicación.

Ejemplo

El siguiente fragmento de código 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

ConfigurationBuilder()

Inicializa una nueva instancia de la clase ConfigurationBuilder.

Propiedades

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

Métodos

Add(IConfigurationSource)	Agrega un origen de configuración nuevo.
Build()	Compila un objeto IConfiguration con claves y valores del conjunto de proveedores registrados en Sources.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Métodos de extensión

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registra un proveedor de configuración para los metadatos de la aplicación.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Agrega una configuración existente a configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Agrega una configuración existente a configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Agrega una instancia de IConfigurationProvider que lee los valores de configuración de la línea de comandos.
AddCommandLine(IConfigurationBuilder, String[])	Agrega una instancia de CommandLineConfigurationProvider que lee los valores de configuración de la línea de comandos.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Agrega una instancia de CommandLineConfigurationProvider que lee valores de configuración de la línea de comandos mediante las asignaciones de modificador especificadas.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Agrega un origen de configuración nuevo.
AddEnvironmentVariables(IConfigurationBuilder)	Agrega una instancia de IConfigurationProvider que lee los valores de configuración de las variables de entorno.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Agrega una instancia de IConfigurationProvider que lee los valores de configuración de las variables de entorno.
AddEnvironmentVariables(IConfigurationBuilder, String)	Agrega una instancia de IConfigurationProvider que lee los valores de configuración de las variables de entorno con un prefijo especificado.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtiene el objeto IFileProvider predeterminado que se va a usar para los proveedores basados en archivos.
GetFileProvider(IConfigurationBuilder)	Obtiene el objeto IFileProvider predeterminado que se va a usar para los proveedores basados en archivos.
SetBasePath(IConfigurationBuilder, String)	Establece el objeto FileProvider para los proveedores basados en archivos en un objeto 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 objeto IFileProvider predeterminado que se va a usar para los proveedores basados en archivos.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración INI a builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Agrega un origen de configuración INI a builder.
AddIniFile(IConfigurationBuilder, String)	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, Boolean, Boolean)	Agrega el proveedor de configuración INI en path a builder.
AddIniStream(IConfigurationBuilder, Stream)	Agrega un origen de configuración INI a builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración JSON a builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Agrega un origen de configuración JSON a builder.
AddJsonFile(IConfigurationBuilder, String)	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, Boolean, Boolean)	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 configuración mediante archivos de un directorio. Los nombres de archivo se usan como la clave y el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String)	Agrega configuración mediante archivos de un directorio. Los nombres de archivo se usan como la clave y el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Agrega configuración mediante archivos de un directorio. Los nombres de archivo se usan como la clave y el contenido del archivo se usa como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Agrega configuración mediante archivos de un directorio. Los nombres de archivo se usan como la clave y el contenido del archivo se usa como valor.
AddInMemoryCollection(IConfigurationBuilder)	Agrega el proveedor de configuración de memoria a configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Agrega el proveedor de configuración de memoria a configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Agrega el origen de configuración de secretos de usuario. Esto busca una instancia de UserSecretsIdAttribute en assembly, 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 secreto.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Agrega el origen de configuración de secretos de usuario. Esto busca una instancia de UserSecretsIdAttribute en assembly, 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 secreto.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Agrega el origen de configuración de secretos de usuario. Esto busca una instancia de UserSecretsIdAttribute en assembly, 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 secreto.
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 secreto.
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 secreto.
AddUserSecrets<T>(IConfigurationBuilder)	Agrega el origen de configuración de secretos de usuario. Busca una instancia de UserSecretsIdAttribute en el ensamblado que contiene el tipo T, 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 secreto.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Agrega el origen de configuración de secretos de usuario. Busca una instancia de UserSecretsIdAttribute en el ensamblado que contiene el tipo T, 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 secreto.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Agrega el origen de configuración de secretos de usuario. Busca una instancia de UserSecretsIdAttribute en el ensamblado que contiene el tipo T, 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 secreto.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Agrega un origen de configuración XML a builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Agrega un origen de configuración XML a builder.
AddXmlFile(IConfigurationBuilder, String)	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, Boolean, Boolean)	Agrega el proveedor de configuración XML en path a builder.
AddXmlStream(IConfigurationBuilder, Stream)	Agrega un origen de configuración XML a builder.

Consulte también

• Configuración en .NET