ConfigurationExtensions.GetRequiredSection(IConfiguration, String) Method

Definition

Namespace:

Microsoft.Extensions.Configuration

Assembly:

Microsoft.Extensions.Configuration.Abstractions.dll

Package:

Microsoft.Extensions.Configuration.Abstractions v8.0.0

Source:

ConfigurationExtensions.cs

Gets the configuration subsection that has the specified key.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationSection ^ GetRequiredSection(Microsoft::Extensions::Configuration::IConfiguration ^ configuration, System::String ^ key);

public static Microsoft.Extensions.Configuration.IConfigurationSection GetRequiredSection (this Microsoft.Extensions.Configuration.IConfiguration configuration, string key);

static member GetRequiredSection : Microsoft.Extensions.Configuration.IConfiguration * string -> Microsoft.Extensions.Configuration.IConfigurationSection

<Extension()>
Public Function GetRequiredSection (configuration As IConfiguration, key As String) As IConfigurationSection

Parameters

configuration

IConfiguration

The configuration to enumerate.

key

String

The key of the configuration section.

Returns

IConfigurationSection

The configuration subsection that has the specified key.

Exceptions

InvalidOperationException

There is no section with key key.

Remarks

If no matching subsection is found with the specified key, an exception is raised.