IConfigurationSection Interface

Definition

Represents a section of application configuration values.

public interface IConfigurationSection : Microsoft.Extensions.Configuration.IConfiguration
Derived
Implements

Properties

Item[String]

Gets or sets a configuration value.

(Inherited from IConfiguration)
Key

Gets the key this section occupies in its parent.

Path

Gets the full path to this section within the IConfiguration.

Value

Gets or sets the section value.

Methods

GetChildren()

Gets the immediate descendant configuration sub-sections.

(Inherited from IConfiguration)
GetReloadToken()

Returns a IChangeToken that can be used to observe when this configuration is reloaded.

(Inherited from IConfiguration)
GetSection(String)

Gets a configuration sub-section with the specified key.

(Inherited from IConfiguration)

Extension Methods

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

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, 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(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<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.

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.

GetValue(IConfiguration, Type, String, Object)

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

GetValue(IConfiguration, Type, String)

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

GetValue<T>(IConfiguration, String, T)

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

GetValue<T>(IConfiguration, String)

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

AsEnumerable(IConfiguration, Boolean)

Get the enumeration of key value pairs within the IConfiguration

AsEnumerable(IConfiguration)

Get the enumeration of key value pairs within the IConfiguration

Exists(IConfigurationSection)

Determines whether the section has a Value or has children.

GetConnectionString(IConfiguration, String)

Gets the specified connection string from the specified configuration. Shorthand for GetSection("ConnectionStrings")[name].

GetRequiredSection(IConfiguration, String)

Gets a configuration subsection with the specified key.

Applies to

Produit Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)