ConfigurationBuilder Classe

Definição

Espaço de Nomes:: Microsoft.Extensions.Configuration

Assemblagem:: 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 dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

Cria definições de configuração baseadas em chaves/valores para utilização numa aplicação.

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

Observações

Ao usar esta classe, pode armazenar valores de configuração num ficheiro JSON, por exemplo, e depois recuperá-los em tempo de execução. Para mais informações, veja Configuração - exemplo básico.

Se estiver a migrar uma aplicação para .NET Core 3.1 ou uma versão posterior, pode usar esta classe para substituir a funcionalidade de ficheiros app.config que possa ter usado anteriormente para configurar a sua aplicação.

Example

O seguinte excerto de código mostra uma aplicação simplificada que cria um ConfigurationBuilder objeto para recuperar um valor de cadeia de caracteres de um ficheiro 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 ficheiro JSON é apresentado aqui.

{
  "weather": "stormy"
}

Construtores

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

Propriedades

Name	Description
Properties	Obtém uma coleção de chaves/valores que pode ser usada para partilhar dados entre os IConfigurationBuilder e os fornecedores registados IConfigurationProvider .
Sources	Obtém as fontes usadas para obter valores de configuração.

Métodos

Name	Description
Add(IConfigurationSource)	Adiciona uma nova fonte de configuração.
Build()	Constrói um IConfiguration com chaves e valores do conjunto de fornecedores registados em Sources.

Métodos da Extensão

Name	Description
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Adiciona uma nova fonte de configuração.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Regista um fornecedor de configuração para metadados da aplicação.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Adiciona um IConfigurationProvider que lê valores de configuração da linha de comandos.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Adiciona um CommandLineConfigurationProvider IConfigurationProvider que lê valores de configuração da linha de comandos usando os mapeamentos de switch especificados.
AddCommandLine(IConfigurationBuilder, String[])	Adiciona um CommandLineConfigurationProvider IConfigurationProvider que lê valores de configuração da linha de comandos.
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 fornecedor de configuração INI em `path` a `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean)	Adiciona o fornecedor de configuração INI em `path` a `builder`.
AddIniFile(IConfigurationBuilder, String)	Adiciona o fornecedor de configuração INI em `path` a `builder`.
AddIniStream(IConfigurationBuilder, Stream)	Adiciona uma fonte de configuração INI a `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Adiciona o fornecedor de configuração de memória a `configurationBuilder`.
AddInMemoryCollection(IConfigurationBuilder)	Adiciona o fornecedor 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 fornecedor de configuração JSON em `path` a `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Adiciona o fornecedor de configuração JSON em `path` a `builder`.
AddJsonFile(IConfigurationBuilder, String)	Adiciona o fornecedor de configuração JSON em `path` a `builder`.
AddJsonStream(IConfigurationBuilder, Stream)	Adiciona uma fonte de configuração JSON a `builder`.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Adiciona configuração usando ficheiros de um diretório. Os nomes dos ficheiros são usados como chave, o conteúdo dos ficheiros como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Adiciona configuração usando ficheiros de um diretório. Os nomes dos ficheiros são usados como chave, o conteúdo dos ficheiros como valor.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Adiciona configuração usando ficheiros de um diretório. Os nomes dos ficheiros são usados como chave, o conteúdo dos ficheiros como valor.
AddKeyPerFile(IConfigurationBuilder, String)	Adiciona configuração usando ficheiros de um diretório. Os nomes dos ficheiros são usados como chave, o conteúdo dos ficheiros como valor.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Adiciona a fonte de configuração dos segredos do utilizador. Isto procura `assembly` uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Adiciona a fonte de configuração dos segredos do utilizador. Isto procura `assembly` uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, Assembly)	Adiciona a fonte de configuração dos segredos do utilizador. Isto procura `assembly` uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Adiciona a fonte de configuração dos secretos de utilizador com ID especificado de secretos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets(IConfigurationBuilder, String)	Adiciona a fonte de configuração dos secretos de utilizador com ID especificado de secretos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Adiciona a fonte de configuração dos segredos do utilizador. Pesquisa no assembly que contém o tipo `T` para uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Adiciona a fonte de configuração dos segredos do utilizador. Pesquisa no assembly que contém o tipo `T` para uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
AddUserSecrets<T>(IConfigurationBuilder)	Adiciona a fonte de configuração dos segredos do utilizador. Pesquisa no assembly que contém o tipo `T` para uma instância de UserSecretsIdAttribute, que especifica um ID de segredos de utilizador. Um ID de segredos de utilizador é um valor único usado para armazenar e identificar uma coleção de valores de configuração secretos.
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 fornecedor de configuração XML em `path` a `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Adiciona o fornecedor de configuração XML em `path` a `builder`.
AddXmlFile(IConfigurationBuilder, String)	Adiciona o fornecedor de configuração XML em `path` a `builder`.
AddXmlStream(IConfigurationBuilder, Stream)	Adiciona uma fonte de configuração XML a `builder`.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Faz com que uma ação por defeito seja invocada para os fornecedores baseados em ficheiros quando ocorre um erro.
GetFileProvider(IConfigurationBuilder)	Obtém o padrão IFileProvider para ser usado em fornecedores baseados em ficheiros.
SetBasePath(IConfigurationBuilder, String)	Define o FileProvider para fornecedores baseados em ficheiros para um PhysicalFileProvider com o caminho base.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Define uma ação padrão a ser invocada para os fornecedores baseados em ficheiros quando ocorre um erro.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Define o padrão IFileProvider para ser usado para fornecedores baseados em ficheiros.

Aplica-se a

Ver também

Configuração em .NET

Comentários

Esta página foi útil?