ConfigurationBuilder Class

Definition

Used to build key/value based configuration settings for use in an application.

public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder
Inheritance
ConfigurationBuilder
Implements

Constructors

ConfigurationBuilder()

Properties

Properties

Gets a key/value collection that can be used to share data between the IConfigurationBuilder and the registered IConfigurationProviders.

Sources

Returns the sources used to obtain configuration values.

Methods

Add(IConfigurationSource)

Adds a new configuration source.

Build()

Builds an IConfiguration with keys and values from the set of providers registered in Sources.

Extension Methods

AddAzureKeyVault(IConfigurationBuilder, String, KeyVaultClient, IKeyVaultSecretManager)

Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2)

Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2, IKeyVaultSecretManager)

Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddAzureKeyVault(IConfigurationBuilder, String, String, String)

Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddAzureKeyVault(IConfigurationBuilder, String, String, String, IKeyVaultSecretManager)

Adds an IConfigurationProvider that reads configuration values from the Azure KeyVault.

AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)

Adds an IConfigurationProvider that reads configuration values from the command line.

AddCommandLine(IConfigurationBuilder, String[])

Adds an IConfigurationProvider that reads configuration values from the command line.

AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)

Adds an IConfigurationProvider that reads configuration values from the command line using the specified switch mappings.

Add<TSource>(IConfigurationBuilder, Action<TSource>)

Adds a new configuration source.

AddUserSecrets(IConfigurationBuilder)

Adds the user secrets configuration source. Searches the assembly from GetEntryAssembly() for an instance of UserSecretsIdAttribute.

AddUserSecrets(IConfigurationBuilder, Assembly)

Adds the user secrets configuration source.

AddUserSecrets(IConfigurationBuilder, String)

Adds the user secrets configuration source with specified secrets id.

AddUserSecrets<T>(IConfigurationBuilder)

Adds the user secrets configuration source. Searches the assembly that contains type T for an instance of UserSecretsIdAttribute.

AddEnvironmentVariables(IConfigurationBuilder)

Adds an IConfigurationProvider that reads configuration values from environment variables.

AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)

Adds an IConfigurationProvider that reads configuration values from environment variables.

AddEnvironmentVariables(IConfigurationBuilder, String)

Adds an IConfigurationProvider that reads configuration values from environment variables with a specified prefix.

GetFileLoadExceptionHandler(IConfigurationBuilder)

Gets the default IFileProvider to be used for file-based providers.

GetFileProvider(IConfigurationBuilder)

Gets the default IFileProvider to be used for file-based providers.

SetBasePath(IConfigurationBuilder, String)

Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.

SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)

Sets a default action to be invoked for file-based providers when an error occurs.

SetFileProvider(IConfigurationBuilder, IFileProvider)

Sets the default IFileProvider to be used for file-based providers.

AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Adds a INI configuration source to builder.

AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)

Adds a INI configuration source to builder.

AddIniFile(IConfigurationBuilder, String)

Adds the INI configuration provider at path to builder.

AddIniFile(IConfigurationBuilder, String, Boolean)

Adds the INI configuration provider at path to builder.

AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)

Adds the INI configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Adds a JSON configuration source to builder.

AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)

Adds a JSON configuration source to builder.

AddJsonFile(IConfigurationBuilder, String)

Adds the JSON configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, String, Boolean)

Adds the JSON configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)

Adds the JSON configuration provider at path to builder.

AddInMemoryCollection(IConfigurationBuilder)

Adds the memory configuration provider to configurationBuilder.

AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)

Adds the memory configuration provider to configurationBuilder.

AddUserSecrets(IConfigurationBuilder, Assembly)

Adds the user secrets configuration source. This searches assembly for an instance of UserSecretsIdAttribute, which specifies a user secrets ID.

A user secrets ID is unique value used to store and identify a collection of secret configuration values.

AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)

Adds the user secrets configuration source. This searches assembly for an instance of UserSecretsIdAttribute, which specifies a user secrets ID.

A user secrets ID is unique value used to store and identify a collection of secret configuration values.

AddUserSecrets(IConfigurationBuilder, String)

Adds the user secrets configuration source with specified user secrets ID.

A user secrets ID is unique value used to store and identify a collection of secret configuration values.

AddUserSecrets<T>(IConfigurationBuilder)

Adds the user secrets configuration source. Searches the assembly that contains type T for an instance of UserSecretsIdAttribute, which specifies a user secrets ID.

A user secrets ID is unique value used to store and identify a collection of secret configuration values.

AddUserSecrets<T>(IConfigurationBuilder, Boolean)

Adds the user secrets configuration source. Searches the assembly that contains type T for an instance of UserSecretsIdAttribute, which specifies a user secrets ID.

A user secrets ID is unique value used to store and identify a collection of secret configuration values.

AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Adds a XML configuration source to builder.

AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)

Adds a XML configuration source to builder.

AddXmlFile(IConfigurationBuilder, String)

Adds the XML configuration provider at path to builder.

AddXmlFile(IConfigurationBuilder, String, Boolean)

Adds the XML configuration provider at path to builder.

AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)

Adds the XML configuration provider at path to builder.

Applies to