OptionsConfigurationServiceCollectionExtensions.Configure Method

Definition

Overloads

Configure<TOptions>(IServiceCollection, IConfiguration)

Registers a configuration instance that TOptions will bind against.

Configure<TOptions>(IServiceCollection, IConfiguration, Action<BinderOptions>)

Registers a configuration instance that TOptions will bind against.

Configure<TOptions>(IServiceCollection, String, IConfiguration)

Registers a configuration instance that TOptions will bind against.

Configure<TOptions>(IServiceCollection, String, IConfiguration, Action<BinderOptions>)

Registers a configuration instance that TOptions will bind against.

Configure<TOptions>(IServiceCollection, IConfiguration)

Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs

Registers a configuration instance that TOptions will bind against.

C#
public static Microsoft.Extensions.DependencyInjection.IServiceCollection Configure<TOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Microsoft.Extensions.Configuration.IConfiguration config) where TOptions : class;

Type Parameters

TOptions

The type of options being configured.

Parameters

services
IServiceCollection

The IServiceCollection to add the services to.

config
IConfiguration

The configuration being bound.

Returns

The IServiceCollection so that additional calls can be chained.

Applies to

.NET 9 (package-provided) and other versions
Product 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)

Configure<TOptions>(IServiceCollection, IConfiguration, Action<BinderOptions>)

Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs

Registers a configuration instance that TOptions will bind against.

C#
public static Microsoft.Extensions.DependencyInjection.IServiceCollection Configure<TOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Microsoft.Extensions.Configuration.IConfiguration config, Action<Microsoft.Extensions.Configuration.BinderOptions>? configureBinder) where TOptions : class;

Type Parameters

TOptions

The type of options being configured.

Parameters

services
IServiceCollection

The IServiceCollection to add the services to.

config
IConfiguration

The configuration being bound.

configureBinder
Action<BinderOptions>

Used to configure the BinderOptions.

Returns

The IServiceCollection so that additional calls can be chained.

Applies to

.NET 9 (package-provided) and other versions
Product 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)

Configure<TOptions>(IServiceCollection, String, IConfiguration)

Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs

Registers a configuration instance that TOptions will bind against.

C#
public static Microsoft.Extensions.DependencyInjection.IServiceCollection Configure<TOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string? name, Microsoft.Extensions.Configuration.IConfiguration config) where TOptions : class;

Type Parameters

TOptions

The type of options being configured.

Parameters

services
IServiceCollection

The IServiceCollection to add the services to.

name
String

The name of the options instance.

config
IConfiguration

The configuration being bound.

Returns

The IServiceCollection so that additional calls can be chained.

Applies to

.NET 9 (package-provided) and other versions
Product 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)

Configure<TOptions>(IServiceCollection, String, IConfiguration, Action<BinderOptions>)

Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs
Source:
OptionsConfigurationServiceCollectionExtensions.cs

Registers a configuration instance that TOptions will bind against.

C#
public static Microsoft.Extensions.DependencyInjection.IServiceCollection Configure<TOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string? name, Microsoft.Extensions.Configuration.IConfiguration config, Action<Microsoft.Extensions.Configuration.BinderOptions>? configureBinder) where TOptions : class;

Type Parameters

TOptions

The type of options being configured.

Parameters

services
IServiceCollection

The IServiceCollection to add the services to.

name
String

The name of the options instance.

config
IConfiguration

The configuration being bound.

configureBinder
Action<BinderOptions>

Used to configure the BinderOptions.

Returns

The IServiceCollection so that additional calls can be chained.

Applies to

.NET 9 (package-provided) and other versions
Product 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)