OptionsBuilderExtensions.AddValidatedOptions Method

Definition

Namespace:

Microsoft.Extensions.Options.Validation

Assembly:

Microsoft.Extensions.Options.ValidateOnStart.dll

Package:

Microsoft.Extensions.Options.ValidateOnStart v8.0.0-preview.7.23407.5

Overloads

AddValidatedOptions<TOptions,TValidateOptions>(IServiceCollection, String)	Adds named options that are automatically validated during startup using a custom validator.
AddValidatedOptions<TOptions>(IServiceCollection, String)	Adds named options that are automatically validated during startup using a built-in validator.

AddValidatedOptions<TOptions,TValidateOptions>(IServiceCollection, String)

Adds named options that are automatically validated during startup using a custom validator.

public static Microsoft.Extensions.Options.OptionsBuilder<TOptions> AddValidatedOptions<TOptions,TValidateOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string? name = default) where TOptions : class where TValidateOptions : class, Microsoft.Extensions.Options.IValidateOptions<TOptions>;

static member AddValidatedOptions : Microsoft.Extensions.DependencyInjection.IServiceCollection * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)> (requires 'Options : null and 'ValidateOptions : null and 'ValidateOptions :> Microsoft.Extensions.Options.IValidateOptions<'Options>)

<Extension()>
Public Function AddValidatedOptions(Of TOptions As Class, TValidateOptions As Class) (services As IServiceCollection, Optional name As String = Nothing) As OptionsBuilder(Of TOptions)

Type Parameters

TOptions

Options to validate.

TValidateOptions

Validator to use.

Parameters

services

IServiceCollection

Service collection.

name

String

Name of the options.

Returns

OptionsBuilder<TOptions>

The OptionsBuilder<TOptions> so that additional calls can be chained.

AddValidatedOptions<TOptions>(IServiceCollection, String)

Adds named options that are automatically validated during startup using a built-in validator.

public static Microsoft.Extensions.Options.OptionsBuilder<TOptions> AddValidatedOptions<TOptions>(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, string? name = default) where TOptions : class;

static member AddValidatedOptions : Microsoft.Extensions.DependencyInjection.IServiceCollection * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)> (requires 'Options : null)

<Extension()>
Public Function AddValidatedOptions(Of TOptions As Class) (services As IServiceCollection, Optional name As String = Nothing) As OptionsBuilder(Of TOptions)

Type Parameters

TOptions

Options to validate.

Parameters

services

IServiceCollection

Service collection.

name

String

Name of the options.

Returns

OptionsBuilder<TOptions>

The OptionsBuilder<TOptions> so that additional calls can be chained.

Remarks

We recommend using custom generated validator.