ConfigurationBuilder Classe

Definição

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.dll

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

Origem:: ConfigurationBuilder.cs

Origem:: ConfigurationBuilder.cs

Origem:: ConfigurationBuilder.cs

Origem:: ConfigurationBuilder.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Cria configurações 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 .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.

Example

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

Nome	Description
ConfigurationBuilder()	Inicializa uma nova instância da classe ConfigurationBuilder.

Propriedades

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

Métodos

Nome	Description
Add(IConfigurationSource)	Adiciona uma nova fonte de configuração.
Build()	Cria um IConfiguration com chaves e valores do conjunto de provedores registrados em Sources.

Métodos de Extensão

Nome	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Adiciona uma nova fonte de configuração.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Registra um provedor de configuração para metadados de aplicativo.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Adiciona um IConfigurationProvider que lê valores de configuração da linha de comando.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Adiciona um CommandLineConfigurationProvider IConfigurationProvider que lê valores de configuração da linha de comando usando os mapeamentos de comutador especificados.
AddCommandLine(IConfigurationBuilder, String[])	Adiciona um CommandLineConfigurationProvider IConfigurationProvider que lê valores de configuração da linha de comando.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Adiciona uma configuração existente a `configurationBuilder`.
AddConfiguration(IConfigurationBuilder, IConfiguration)	Adiciona uma configuração existente a `configurationBuilder`.
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.
AddEnvironmentVariables(IConfigurationBuilder)	Adiciona um IConfigurationProvider que lê valores de configuração de variáveis de ambiente.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Adiciona uma fonte de configuração ini a `builder`.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma fonte de configuração ini a `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor de configuração ini a `pathbuilder`.
AddIniFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor de configuração ini a `pathbuilder`.
AddIniFile(IConfigurationBuilder, String)	Adiciona o provedor de configuração ini a `pathbuilder`.
AddIniStream(IConfigurationBuilder, Stream)	Adiciona uma fonte de configuração ini a `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Adiciona o provedor de configuração de memória a `configurationBuilder`.
AddInMemoryCollection(IConfigurationBuilder)	Adiciona o provedor de configuração de memória a `configurationBuilder`.
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Adiciona uma fonte de configuração JSON a `builder`.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma fonte de configuração JSON a `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor de configuração JSON a `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor de configuração JSON a `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String)	Adiciona o provedor de configuração JSON a `pathbuilder`.
AddJsonStream(IConfigurationBuilder, Stream)	Adiciona uma fonte 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, o conteúdo do arquivo é usado 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, o conteúdo do arquivo é usado 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, o conteúdo do arquivo é usado 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, o conteúdo do arquivo é usado como o valor.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Adiciona a fonte de configuração de segredos do usuário. Isso procura `assembly` uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Adiciona a fonte de configuração de segredos do usuário. Isso procura `assembly` uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets(IConfigurationBuilder, Assembly)	Adiciona a fonte de configuração de segredos do usuário. Isso procura `assembly` uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Adiciona a fonte de configuração de segredos do usuário com a ID de segredos do usuário especificada. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets(IConfigurationBuilder, String)	Adiciona a fonte de configuração de segredos do usuário com a ID de segredos do usuário especificada. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Adiciona a fonte de configuração de segredos do usuário. Pesquisa o assembly que contém o tipo `T` de uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Adiciona a fonte de configuração de segredos do usuário. Pesquisa o assembly que contém o tipo `T` de uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddUserSecrets<T>(IConfigurationBuilder)	Adiciona a fonte de configuração de segredos do usuário. Pesquisa o assembly que contém o tipo `T` de uma instância de , que especifica uma ID de segredos do UserSecretsIdAttributeusuário. Uma ID de segredos do usuário é um valor exclusivo usado para armazenar e identificar uma coleção de valores de configuração de segredo.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Adiciona uma fonte de configuração XML a `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Adiciona uma fonte de configuração XML a `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona o provedor `path` de configuração XML a `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Adiciona o provedor `path` de configuração XML a `builder`.
AddXmlFile(IConfigurationBuilder, String)	Adiciona o provedor `path` de configuração XML a `builder`.
AddXmlStream(IConfigurationBuilder, Stream)	Adiciona uma fonte de configuração XML a `builder`.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Obtém uma ação padrão a ser invocada para provedores baseados em arquivo quando ocorre um erro.
GetFileProvider(IConfigurationBuilder)	Obtém o padrão IFileProvider a ser usado para provedores baseados em arquivo.
SetBasePath(IConfigurationBuilder, String)	Define o FileProvider para provedores baseados em arquivo como um PhysicalFileProvider com o caminho base.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Define uma ação padrão a ser invocada para provedores baseados em arquivo quando ocorre um erro.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Define o padrão IFileProvider a ser usado para provedores baseados em arquivo.

Aplica-se a

Confira também

Configuração em .NET

Comentários

Esta página foi útil?