Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
Microsoft.Extensions.Options
System Library
| Author | Microsoft |
| Version | 10.0.1 |
| Tags |
Public Types
Microsoft.Extensions.DependencyInjection
class OptionsBuilderExtensions
Extension methods for adding configuration-related options services to the DI container via <see cref="T:Microsoft.Extensions.Options.OptionsBuilder`1" /> .
Extension methods for adding options services to the DI container.
Microsoft.Extensions.Options
class ConfigureNamedOptions<TOptions>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureNamedOptions<TOptions, TDep>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureNamedOptions<TOptions, TDep1, TDep2>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureNamedOptions<TOptions, TDep1, TDep2, TDep3>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureNamedOptions<TOptions, TDep1, TDep2, TDep3, TDep4>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureNamedOptions<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureNamedOptions`1" /> .
class ConfigureOptions<TOptions>
Implementation of <see cref="T:Microsoft.Extensions.Options.IConfigureOptions`1" /> .
interface IConfigureNamedOptions<TOptions>
Represents something that configures the <typeparamref name="TOptions" /> type.
interface IConfigureOptions<TOptions>
Represents something that configures the <typeparamref name="TOptions" /> type.
interface IOptions<TOptions>
Retrieves configured <typeparamref name="TOptions" /> instances.
interface IOptionsChangeTokenSource<TOptions>
Fetches a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that's used for tracking options changes.
interface IOptionsFactory<TOptions>
Creates <typeparamref name="TOptions" /> instances.
interface IOptionsMonitor<TOptions>
Monitors changes on a <typeparamref name="TOptions" /> instance.
interface IOptionsMonitorCache<TOptions>
Used by <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" /> to cache <typeparamref name="TOptions" /> instances.
interface IOptionsSnapshot<TOptions>
Used to access the value of <typeparamref name="TOptions" /> for the lifetime of a request.
interface IPostConfigureOptions<TOptions>
Represents something that configures the <typeparamref name="TOptions" /> type.
interface IStartupValidator
Used by hosts to validate options during startup.
interface IValidateOptions<TOptions>
Validates options.
class Options
Helper class for options.
class OptionsBuilder<TOptions>
Configures <typeparamref name="TOptions" /> instances.
class OptionsCache<TOptions>
Caches <typeparamref name="TOptions" /> instances.
class OptionsFactory<TOptions>
Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsFactory`1" /> .
class OptionsManager<TOptions>
Implements <see cref="T:Microsoft.Extensions.Options.IOptions`1" /> and <see cref="T:Microsoft.Extensions.Options.IOptionsSnapshot`1" /> .
class OptionsMonitor<TOptions>
Implements <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" /> .
class OptionsMonitorExtensions
Extension methods for <see cref="T:Microsoft.Extensions.Options.IOptionsMonitor`1" /> .
Represents the exception that's thrown when options validation fails.
Triggers the automatic generation of the implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> at compile time.
class OptionsWrapper<TOptions>
Wraps the options instance.
class PostConfigureOptions<TOptions>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
class PostConfigureOptions<TOptions, TDep>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
class PostConfigureOptions<TOptions, TDep1, TDep2>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
class PostConfigureOptions<TOptions, TDep1, TDep2, TDep3>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
class PostConfigureOptions<TOptions, TDep1, TDep2, TDep3, TDep4>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
class PostConfigureOptions<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5>
Implementation of <see cref="T:Microsoft.Extensions.Options.IPostConfigureOptions`1" /> .
Marks a field or property to be enumerated; each enumerated object is validated.
Marks a field or property to be validated transitively.
class ValidateOptions<TOptions>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" />
class ValidateOptions<TOptions, TDep>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" />
class ValidateOptions<TOptions, TDep1, TDep2>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" /> .
class ValidateOptions<TOptions, TDep1, TDep2, TDep3>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" />
class ValidateOptions<TOptions, TDep1, TDep2, TDep3, TDep4>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" />
class ValidateOptions<TOptions, TDep1, TDep2, TDep3, TDep4, TDep5>
Implementation of <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1" />
class ValidateOptionsResult
Represents the result of an options validation.
Builds <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult" /> with support for multiple error messages.