IConfigurationBuilder Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a type used to build application configuration.
public interface class IConfigurationBuilder
public interface IConfigurationBuilder
type IConfigurationBuilder = interface
Public Interface IConfigurationBuilder
- Derived
Properties
Properties |
Gets a key/value collection that can be used to share data between the IConfigurationBuilder and the registered IConfigurationSources. |
Sources |
Gets 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 sources registered in Sources. |
Extension Methods
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String) |
Registers a configuration provider for application metadata. |
AddConfiguration(IConfigurationBuilder, IConfiguration) |
Adds an existing configuration to |
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean) |
Adds an existing configuration to |
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>) |
Adds an IConfigurationProvider that reads configuration values from the command line. |
AddCommandLine(IConfigurationBuilder, String[]) |
Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line. |
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>) |
Adds a CommandLineConfigurationProviderIConfigurationProvider that reads configuration values from the command line using the specified switch mappings. |
Add<TSource>(IConfigurationBuilder, Action<TSource>) |
Adds a new configuration source. |
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 a default action to be invoked for file-based providers when an error occurs. |
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 |
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>) |
Adds a INI configuration source to |
AddIniFile(IConfigurationBuilder, String) |
Adds the INI configuration provider at |
AddIniFile(IConfigurationBuilder, String, Boolean) |
Adds the INI configuration provider at |
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean) |
Adds the INI configuration provider at |
AddIniStream(IConfigurationBuilder, Stream) |
Adds a INI configuration source to |
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Adds a JSON configuration source to |
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>) |
Adds a JSON configuration source to |
AddJsonFile(IConfigurationBuilder, String) |
Adds the JSON configuration provider at |
AddJsonFile(IConfigurationBuilder, String, Boolean) |
Adds the JSON configuration provider at |
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean) |
Adds the JSON configuration provider at |
AddJsonStream(IConfigurationBuilder, Stream) |
Adds a JSON configuration source to |
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>) |
Adds configuration using files from a directory. File names are used as the key, file contents are used as the value. |
AddKeyPerFile(IConfigurationBuilder, String) |
Adds configuration using files from a directory. File names are used as the key, file contents are used as the value. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean) |
Adds configuration using files from a directory. File names are used as the key, file contents are used as the value. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean) |
Adds configuration using files from a directory. File names are used as the key, file contents are used as the value. |
AddInMemoryCollection(IConfigurationBuilder) |
Adds the memory configuration provider to |
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>) |
Adds the memory configuration provider to |
AddUserSecrets(IConfigurationBuilder, Assembly) |
Adds the user secrets configuration source. This searches 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 A user secrets ID is unique value used to store and identify a collection of secret configuration values. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean) |
Adds the user secrets configuration source. This searches 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(IConfigurationBuilder, String, Boolean) |
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 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 A user secrets ID is unique value used to store and identify a collection of secret configuration values. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean) |
Adds the user secrets configuration source. Searches the assembly that contains type 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 an XML configuration source to |
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>) |
Adds an XML configuration source to |
AddXmlFile(IConfigurationBuilder, String) |
Adds the XML configuration provider at |
AddXmlFile(IConfigurationBuilder, String, Boolean) |
Adds the XML configuration provider at |
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean) |
Adds the XML configuration provider at |
AddXmlStream(IConfigurationBuilder, Stream) |
Adds an XML configuration source to |