Edit

IConfiguration Interface

  • Reference

Definition

Namespace:
Microsoft.Extensions.Configuration
Assembly:
Microsoft.Extensions.Configuration.Abstractions.dll
Package:
Microsoft.Extensions.Configuration.Abstractions v6.0.0
Package:
Microsoft.Extensions.Configuration.Abstractions v7.0.0
Package:
Microsoft.Extensions.Configuration.Abstractions v8.0.0
Package:
Microsoft.Extensions.Configuration.Abstractions v9.0.0-preview.2.24128.5
Source:
IConfiguration.cs
Source:
IConfiguration.cs
Source:
IConfiguration.cs

Represents a set of key/value application configuration properties.

public interface class IConfiguration
public interface IConfiguration
type IConfiguration = interface
Public Interface IConfiguration
Derived

Remarks

For more information, see Configuration in .NET.

Properties

Item[String]

Gets or sets a configuration value.

Methods

GetChildren()

Gets the immediate descendant configuration sub-sections.
GetReloadToken()

Attempts to get an IChangeToken for change tracking.
GetSection(String)

Gets a configuration sub-section with the specified key.

Extension Methods

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>)

Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
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)

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>)

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)

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>)

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)

Extracts the value with the specified key and converts it to the specified type.
GetValue(IConfiguration, Type, String, Object)

Extracts the value with the specified key and converts it to the specified type.
GetValue<T>(IConfiguration, String)

Extracts the value with the specified key and converts it to type T.
GetValue<T>(IConfiguration, String, T)

Extracts the value with the specified key and converts it to type T.
AsEnumerable(IConfiguration)

Get the enumeration of key-value pairs within the IConfiguration.
AsEnumerable(IConfiguration, Boolean)

Gets the enumeration of key-value pairs within the IConfiguration.
GetConnectionString(IConfiguration, String)

Retrieves the value with the specified key from the ConnectionStrings section of the configuration source. Calling this method is shorthand for GetSection("ConnectionStrings")[name].
GetRequiredSection(IConfiguration, String)

Gets the configuration subsection that has the specified key.

Applies to