IConfigurationRoot IConfigurationRoot IConfigurationRoot Interface

Definition

Represents the root of an IConfiguration hierarchy.

public interface IConfigurationRoot : Microsoft.Extensions.Configuration.IConfiguration
type IConfigurationRoot = interface
    interface IConfiguration
Public Interface IConfigurationRoot
Implements IConfiguration
Derived
Implements

Properties

Providers Providers Providers

The IConfigurationProviders for this configuration.

Methods

Reload() Reload() Reload()

Force the configuration values to be reloaded from the underlying IConfigurationProviders.

Extension Methods

Bind(IConfiguration, Object) Bind(IConfiguration, Object) Bind(IConfiguration, Object)

Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.

Bind(IConfiguration, Object, Action<BinderOptions>) Bind(IConfiguration, Object, Action<BinderOptions>) Bind(IConfiguration, Object, Action<BinderOptions>)

Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.

Bind(IConfiguration, String, Object) Bind(IConfiguration, String, Object) Bind(IConfiguration, String, Object)

Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.

Get(IConfiguration, Type) Get(IConfiguration, Type) Get(IConfiguration, Type)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.

Get(IConfiguration, Type, Action<BinderOptions>) Get(IConfiguration, Type, Action<BinderOptions>) Get(IConfiguration, Type, Action<BinderOptions>)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.

Get<T>(IConfiguration) Get<T>(IConfiguration) Get<T>(IConfiguration)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.

Get<T>(IConfiguration, Action<BinderOptions>) Get<T>(IConfiguration, Action<BinderOptions>) Get<T>(IConfiguration, Action<BinderOptions>)

Attempts to bind the configuration instance to a new instance of type T. If this configuration section has a value, that will be used. Otherwise binding by matching property names against configuration keys recursively.

GetValue(IConfiguration, Type, String) GetValue(IConfiguration, Type, String) GetValue(IConfiguration, Type, String)

Extracts the value with the specified key and converts it to the specified type.

GetValue(IConfiguration, Type, String, Object) GetValue(IConfiguration, Type, String, Object) GetValue(IConfiguration, Type, String, Object)

Extracts the value with the specified key and converts it to the specified type.

GetValue<T>(IConfiguration, String) GetValue<T>(IConfiguration, String) GetValue<T>(IConfiguration, String)

Extracts the value with the specified key and converts it to type T.

GetValue<T>(IConfiguration, String, T) GetValue<T>(IConfiguration, String, T) GetValue<T>(IConfiguration, String, T)

Extracts the value with the specified key and converts it to type T.

AsEnumerable(IConfiguration) AsEnumerable(IConfiguration) AsEnumerable(IConfiguration)

Get the enumeration of key value pairs within the IConfiguration

AsEnumerable(IConfiguration, Boolean) AsEnumerable(IConfiguration, Boolean) AsEnumerable(IConfiguration, Boolean)

Get the enumeration of key value pairs within the IConfiguration

GetConnectionString(IConfiguration, String) GetConnectionString(IConfiguration, String) GetConnectionString(IConfiguration, String)

Shorthand for GetSection("ConnectionStrings")[name].

Applies to