ConfigurationBuilder Classe

Definição

Namespace:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.dll

Pacote:

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

Origem:

ConfigurationBuilder.cs

Usado para criar definições de configuração baseadas em chave/valor para uso em um aplicativo.

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

Herança

Object

ConfigurationBuilder

Implementações

IConfigurationBuilder

Comentários

Usando essa classe, você pode armazenar valores de configuração em um arquivo JSON, por exemplo, e recuperá-los em tempo de execução. Para obter mais informações, consulte Configuração – exemplo básico.

Se você estiver migrando um aplicativo para o .NET Core 3.1 ou uma versão posterior, poderá usar essa classe para substituir a funcionalidade de arquivo app.config que você pode ter usado anteriormente para configurar seu aplicativo.

Exemplo

O snippet de código a seguir mostra um aplicativo simplificado que cria um ConfigurationBuilder objeto para recuperar um valor de cadeia de caracteres de um arquivo JSON em tempo de execução.

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

O conteúdo do arquivo JSON é mostrado aqui.

{
  "weather": "stormy"
}

Construtores

ConfigurationBuilder()

Inicializa uma nova instância da classe ConfigurationBuilder.

Propriedades

Properties	Obtém uma coleção chave/valor que pode ser usada para compartilhar dados entre os IConfigurationBuilder provedores de configuração registrados e .
Sources	Obtém as fontes usadas para obter valores de configuração.

Métodos

Add(IConfigurationSource)	Adiciona uma nova origem de configuração.
Build()	Compila um IConfiguration com chaves e valores do conjunto de provedores registrados no Sources.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Métodos de Extensão

AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registra um provedor de configuração para metadados de aplicativo.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Adiciona uma configuração existente a configurationBuilder.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Adiciona uma configuração existente a configurationBuilder.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Adiciona um IConfigurationProvider que lê os valores de configuração da linha de comando.
AddCommandLine(IConfigurationBuilder, String[])	Adiciona um CommandLineConfigurationProvider que lê os valores de configuração da linha de comando.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Adiciona um CommandLineConfigurationProvider que lê os valores de configuração da linha de comando usando os mapeamentos de opção especificados.
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Adiciona uma nova origem de configuração.
AddEnvironmentVariables(IConfigurationBuilder)	Adiciona um IConfigurationProvider que lê valores de configuração de variáveis de ambiente.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Adiciona um IConfigurationProvider que lê valores de configuração de variáveis de ambiente.
AddEnvironmentVariables(IConfigurationBuilder, String)	Adiciona um IConfigurationProvider que lê valores de configuração de variáveis de ambiente com um prefixo especificado.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtém o IFileProvider padrão a ser usado para provedores baseados em arquivo.
GetFileProvider(IConfigurationBuilder)	Obtém o IFileProvider padrão a ser usado para provedores baseados em arquivo.
SetBasePath(IConfigurationBuilder, String)	Define o FileProvider para provedores baseados em arquivo para um PhysicalFileProvider com o caminho base.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Define a ação padrão a ser invocada para provedores baseados em arquivo quando ocorre um erro.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Define o IFileProvider padrão a ser usado para provedores baseados em arquivo.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma origem de configuração INI a builder.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Adiciona uma origem de configuração INI a builder.
AddIniFile(IConfigurationBuilder, String)	Adiciona o provedor de configuração INI em path para builder.
AddIniFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor de configuração INI em path para builder.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor de configuração INI em path para builder.
AddIniStream(IConfigurationBuilder, Stream)	Adiciona uma origem de configuração INI a builder.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma origem de configuração JSON a builder.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Adiciona uma origem de configuração JSON a builder.
AddJsonFile(IConfigurationBuilder, String)	Adiciona o provedor de configuração JSON em path para builder.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor de configuração JSON em path para builder.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor de configuração JSON em path para builder.
AddJsonStream(IConfigurationBuilder, Stream)	Adiciona uma origem de configuração JSON a builder.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Adiciona a configuração usando arquivos de um diretório. Os nomes de arquivo são usados como a chave; os conteúdos do arquivo são usados como o valor.
AddKeyPerFile(IConfigurationBuilder, String)	Adiciona a configuração usando arquivos de um diretório. Os nomes de arquivo são usados como a chave; os conteúdos do arquivo são usados como o valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Adiciona a configuração usando arquivos de um diretório. Os nomes de arquivo são usados como a chave; os conteúdos do arquivo são usados como o valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona a configuração usando arquivos de um diretório. Os nomes de arquivo são usados como a chave; os conteúdos do arquivo são usados como o valor.
AddInMemoryCollection(IConfigurationBuilder)	Adiciona o provedor de configuração de memória a configurationBuilder.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Adiciona o provedor de configuração de memória a configurationBuilder.
AddUserSecrets(IConfigurationBuilder, Assembly)	Adiciona a origem da configuração de segredos do usuário. Isso pesquisa assembly para uma instância do UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Adiciona a origem da configuração de segredos do usuário. Isso pesquisa assembly para uma instância do UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Adiciona a origem da configuração de segredos do usuário. Isso pesquisa assembly para uma instância do UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, String)	Adiciona a origem de configuração de segredos do usuário com a ID de segredos do usuário especificada. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Adiciona a origem de configuração de segredos do usuário com a ID de segredos do usuário especificada. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder)	Adiciona a origem da configuração de segredos do usuário. Pesquisa o assembly que contém o tipo T para uma instância de UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Adiciona a origem da configuração de segredos do usuário. Pesquisa o assembly que contém o tipo T para uma instância de UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Adiciona a origem da configuração de segredos do usuário. Pesquisa o assembly que contém o tipo T para uma instância de UserSecretsIdAttribute, que especifica uma ID de segredos do usuário. Uma ID de segredos de usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma origem de configuração XML a builder.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Adiciona uma origem de configuração XML a builder.
AddXmlFile(IConfigurationBuilder, String)	Adiciona o provedor de configuração XML em path para builder.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor de configuração XML em path para builder.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor de configuração XML em path para builder.
AddXmlStream(IConfigurationBuilder, Stream)	Adiciona uma origem de configuração XML a builder.

Confira também

• Configuração em .NET