IServiceCollection Interface

Reference

Definition

Namespace:: Microsoft.Extensions.DependencyInjection

Assembly:: Microsoft.Extensions.DependencyInjection.Abstractions.dll

Package:: Microsoft.Extensions.DependencyInjection.Abstractions v6.0.0

Package:: Microsoft.Extensions.DependencyInjection.Abstractions v7.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies the contract for a collection of service descriptors.

public interface class IServiceCollection : System::Collections::Generic::ICollection<Microsoft::Extensions::DependencyInjection::ServiceDescriptor ^>, System::Collections::Generic::IEnumerable<Microsoft::Extensions::DependencyInjection::ServiceDescriptor ^>, System::Collections::Generic::IList<Microsoft::Extensions::DependencyInjection::ServiceDescriptor ^>

public interface IServiceCollection : System.Collections.Generic.ICollection<Microsoft.Extensions.DependencyInjection.ServiceDescriptor>, System.Collections.Generic.IEnumerable<Microsoft.Extensions.DependencyInjection.ServiceDescriptor>, System.Collections.Generic.IList<Microsoft.Extensions.DependencyInjection.ServiceDescriptor>

type IServiceCollection = interface
    interface IList<ServiceDescriptor>
    interface ICollection<ServiceDescriptor>
    interface seq<ServiceDescriptor>
    interface IEnumerable

type IServiceCollection = interface
    interface ICollection<ServiceDescriptor>
    interface seq<ServiceDescriptor>
    interface IEnumerable
    interface IList<ServiceDescriptor>

Public Interface IServiceCollection
Implements ICollection(Of ServiceDescriptor), IEnumerable(Of ServiceDescriptor), IList(Of ServiceDescriptor)

Derived: Microsoft.Extensions.DependencyInjection.ServiceCollection

Implements: ICollection<ServiceDescriptor> ICollection<T> IEnumerable<ServiceDescriptor> IEnumerable<T> IList<ServiceDescriptor> IEnumerable

Properties

Count	Gets the number of elements contained in the ICollection<T>. (Inherited from ICollection<T>)
IsReadOnly	Gets a value indicating whether the ICollection<T> is read-only. (Inherited from ICollection<T>)
Item[Int32]	Gets or sets the element at the specified index. (Inherited from IList<T>)

Methods

Add(T)	Adds an item to the ICollection<T>. (Inherited from ICollection<T>)
Clear()	Removes all items from the ICollection<T>. (Inherited from ICollection<T>)
Contains(T)	Determines whether the ICollection<T> contains a specific value. (Inherited from ICollection<T>)
CopyTo(T[], Int32)	Copies the elements of the ICollection<T> to an Array, starting at a particular Array index. (Inherited from ICollection<T>)
GetEnumerator()	Returns an enumerator that iterates through a collection. (Inherited from IEnumerable)
IndexOf(T)	Determines the index of a specific item in the IList<T>. (Inherited from IList<T>)
Insert(Int32, T)	Inserts an item to the IList<T> at the specified index. (Inherited from IList<T>)
Remove(T)	Removes the first occurrence of a specific object from the ICollection<T>. (Inherited from ICollection<T>)
RemoveAt(Int32)	Removes the IList<T> item at the specified index. (Inherited from IList<T>)

Extension Methods

AddWebEncoders(IServiceCollection)	Adds HtmlEncoder, JavaScriptEncoder and UrlEncoder to the specified `services`.
AddWebEncoders(IServiceCollection, Action<WebEncoderOptions>)	Adds HtmlEncoder, JavaScriptEncoder and UrlEncoder to the specified `services`.
Add(IServiceCollection, ServiceDescriptor)	Adds the specified `descriptor` to the `collection`.
Add(IServiceCollection, IEnumerable<ServiceDescriptor>)	Adds a sequence of ServiceDescriptor to the `collection`.
RemoveAll(IServiceCollection, Type)	Removes all services of type `serviceType` in IServiceCollection.
RemoveAll<T>(IServiceCollection)	Removes all services of type `T` in IServiceCollection.
Replace(IServiceCollection, ServiceDescriptor)	Removes the first service in IServiceCollection with the same service type as `descriptor` and adds `descriptor` to the collection.
TryAdd(IServiceCollection, ServiceDescriptor)	Adds the specified `descriptor` to the `collection` if the service type hasn't already been registered.
TryAdd(IServiceCollection, IEnumerable<ServiceDescriptor>)	Adds the specified `descriptors` to the `collection` if the service type hasn't already been registered.
TryAddEnumerable(IServiceCollection, ServiceDescriptor)	Adds a ServiceDescriptor if an existing descriptor with the same ServiceType and an implementation that does not already exist in `services`.
TryAddEnumerable(IServiceCollection, IEnumerable<ServiceDescriptor>)	Adds the specified ServiceDescriptors if an existing descriptor with the same ServiceType and an implementation that does not already exist in `services`.
TryAddScoped(IServiceCollection, Type)	Adds the specified `service` as a Scoped service to the `collection` if the service type hasn't already been registered.
TryAddScoped(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds the specified `service` as a Scoped service using the factory specified in `implementationFactory` to the `collection` if the service type hasn't already been registered.
TryAddScoped(IServiceCollection, Type, Type)	Adds the specified `service` as a Scoped service with the `implementationType` implementation to the `collection` if the service type hasn't already been registered.
TryAddScoped<TService>(IServiceCollection)	Adds the specified `TService` as a Scoped service to the `collection` if the service type hasn't already been registered.
TryAddScoped<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds the specified `TService` as a Scoped service using the factory specified in `implementationFactory` to the `services` if the service type hasn't already been registered.
TryAddScoped<TService,TImplementation>(IServiceCollection)	Adds the specified `TService` as a Scoped service implementation type specified in `TImplementation` to the `collection` if the service type hasn't already been registered.
TryAddSingleton(IServiceCollection, Type)	Adds the specified `service` as a Singleton service to the `collection` if the service type hasn't already been registered.
TryAddSingleton(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds the specified `service` as a Singleton service using the factory specified in `implementationFactory` to the `collection` if the service type hasn't already been registered.
TryAddSingleton(IServiceCollection, Type, Type)	Adds the specified `service` as a Singleton service with the `implementationType` implementation to the `collection` if the service type hasn't already been registered.
TryAddSingleton<TService>(IServiceCollection)	Adds the specified `TService` as a Singleton service to the `collection` if the service type hasn't already been registered.
TryAddSingleton<TService>(IServiceCollection, TService)	Adds the specified `TService` as a Singleton service with an instance specified in `instance` to the `collection` if the service type hasn't already been registered.
TryAddSingleton<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds the specified `TService` as a Singleton service using the factory specified in `implementationFactory` to the `services` if the service type hasn't already been registered.
TryAddSingleton<TService,TImplementation>(IServiceCollection)	Adds the specified `TService` as a Singleton service implementation type specified in `TImplementation` to the `collection` if the service type hasn't already been registered.
TryAddTransient(IServiceCollection, Type)	Adds the specified `service` as a Transient service to the `collection` if the service type hasn't already been registered.
TryAddTransient(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds the specified `service` as a Transient service using the factory specified in `implementationFactory` to the `collection` if the service type hasn't already been registered.
TryAddTransient(IServiceCollection, Type, Type)	Adds the specified `service` as a Transient service with the `implementationType` implementation to the `collection` if the service type hasn't already been registered.
TryAddTransient<TService>(IServiceCollection)	Adds the specified `TService` as a Transient service to the `collection` if the service type hasn't already been registered.
TryAddTransient<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds the specified `TService` as a Transient service using the factory specified in `implementationFactory` to the `services` if the service type hasn't already been registered.
TryAddTransient<TService,TImplementation>(IServiceCollection)	Adds the specified `TService` as a Transient service implementation type specified in `TImplementation` to the `collection` if the service type hasn't already been registered.
AddHealthChecks(IServiceCollection)	Adds the HealthCheckService to the container, using the provided delegate to register health checks.
AddHttpClient(IServiceCollection)	Adds the IHttpClientFactory and related services to the IServiceCollection.
AddHttpClient(IServiceCollection, String)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a named HttpClient.
AddHttpClient(IServiceCollection, String, Action<IServiceProvider,HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a named HttpClient.
AddHttpClient(IServiceCollection, String, Action<HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a named HttpClient.
AddHttpClient<TClient>(IServiceCollection)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the full name of `TClient`.
AddHttpClient<TClient>(IServiceCollection, Action<IServiceProvider,HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient>(IServiceCollection, Action<HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient>(IServiceCollection, String)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient>(IServiceCollection, String, Action<IServiceProvider,HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient>(IServiceCollection, String, Action<HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient,TImplementation>(IServiceCollection, Action<IServiceProvider,HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient,TImplementation>(IServiceCollection, Action<HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient,TImplementation>(IServiceCollection, Func<HttpClient,TImplementation>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection, Func<HttpClient,IServiceProvider,TImplementation>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection, String)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient. The client name will be set to the type name of `TClient`.
AddHttpClient<TClient,TImplementation>(IServiceCollection, String, Action<IServiceProvider,HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection, String, Action<HttpClient>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection, String, Func<HttpClient,TImplementation>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddHttpClient<TClient,TImplementation>(IServiceCollection, String, Func<HttpClient,IServiceProvider,TImplementation>)	Adds the IHttpClientFactory and related services to the IServiceCollection and configures a binding between the `TClient` type and a named HttpClient.
AddLocalization(IServiceCollection)	Adds services required for application localization.
AddLocalization(IServiceCollection, Action<LocalizationOptions>)	Adds services required for application localization.
AddLogging(IServiceCollection)	Adds logging services to the specified IServiceCollection.
AddLogging(IServiceCollection, Action<ILoggingBuilder>)	Adds logging services to the specified IServiceCollection.
AddDistributedMemoryCache(IServiceCollection)	Adds a default implementation of IDistributedCache that stores items in memory to the IServiceCollection. Frameworks that require a distributed cache to work can safely add this dependency as part of their dependency list to ensure that there is at least one implementation available.
AddDistributedMemoryCache(IServiceCollection, Action<MemoryDistributedCacheOptions>)	Adds a default implementation of IDistributedCache that stores items in memory to the IServiceCollection. Frameworks that require a distributed cache to work can safely add this dependency as part of their dependency list to ensure that there is at least one implementation available.
AddMemoryCache(IServiceCollection)	Adds a non distributed in memory implementation of IMemoryCache to the IServiceCollection.
AddMemoryCache(IServiceCollection, Action<MemoryCacheOptions>)	Adds a non distributed in memory implementation of IMemoryCache to the IServiceCollection.
Configure<TOptions>(IServiceCollection, IConfiguration)	Registers a configuration instance that `TOptions` will bind against, and updates the options when the configuration changes.
Configure<TOptions>(IServiceCollection, IConfiguration, Action<BinderOptions>)	Registers a configuration instance which TOptions will bind against.
Configure<TOptions>(IServiceCollection, String, IConfiguration)	Registers a configuration instance which TOptions will bind against.
Configure<TOptions>(IServiceCollection, String, IConfiguration, Action<BinderOptions>)	Registers a configuration instance which TOptions will bind against.
AddOptions(IServiceCollection)	Adds services required for using options.
AddOptions<TOptions>(IServiceCollection)	Gets an options builder that forwards `Configure` calls for the same named `TOptions` to the underlying service collection.
AddOptions<TOptions>(IServiceCollection, String)	Gets an options builder that forwards `Configure` calls for the same named `TOptions` to the underlying service collection.
Configure<TOptions>(IServiceCollection, Action<TOptions>)	Registers an action used to configure a particular type of options once during startup. This is run before PostConfigure<TOptions>(IServiceCollection, Action<TOptions>). Updates to the configuration does not invoke the action again.
Configure<TOptions>(IServiceCollection, String, Action<TOptions>)	Registers an action used to configure a particular type of options. These are run before PostConfigure<TOptions>(IServiceCollection, Action<TOptions>).
ConfigureAll<TOptions>(IServiceCollection, Action<TOptions>)	Registers an action used to configure all instances of a particular type of options.
ConfigureOptions(IServiceCollection, Object)	Registers an object that will have all of its `I[Post]ConfigureOptions` registered.
ConfigureOptions(IServiceCollection, Type)	Registers a type that will have all of its `I[Post]ConfigureOptions` registered.
ConfigureOptions<TConfigureOptions>(IServiceCollection)	Registers a type that will have all of its `I[Post]ConfigureOptions` registered.
PostConfigure<TOptions>(IServiceCollection, Action<TOptions>)	Registers an action used to initialize a particular type of options. These are run after Configure<TOptions>(IServiceCollection, Action<TOptions>).
PostConfigure<TOptions>(IServiceCollection, String, Action<TOptions>)	Registers an action used to configure a particular type of options. These are run after Configure<TOptions>(IServiceCollection, Action<TOptions>).
PostConfigureAll<TOptions>(IServiceCollection, Action<TOptions>)	Registers an action used to post configure all instances of a particular type of options. These are run after Configure<TOptions>(IServiceCollection, Action<TOptions>).
AddPolicyRegistry(IServiceCollection)	Registers an empty PolicyRegistry in the service collection with service types IPolicyRegistry<TKey>, and IReadOnlyPolicyRegistry<TKey> and returns the newly created registry.
AddPolicyRegistry(IServiceCollection, IPolicyRegistry<String>)	Registers the provided IPolicyRegistry<TKey> in the service collection with service types IPolicyRegistry<TKey>, and IReadOnlyPolicyRegistry<TKey> and returns the provided registry.
AddDistributedRedisCache(IServiceCollection, Action<RedisCacheOptions>)	Adds Redis distributed caching services to the specified IServiceCollection.
BuildServiceProvider(IServiceCollection)	Creates a ServiceProvider containing services from the provided IServiceCollection.
BuildServiceProvider(IServiceCollection, ServiceProviderOptions)	Creates a ServiceProvider containing services from the provided IServiceCollection optionally enabling service-creation and scope validation.
BuildServiceProvider(IServiceCollection, Boolean)	Creates a ServiceProvider containing services from the provided IServiceCollection optionally enabling scope validation.
AddHostedService<THostedService>(IServiceCollection)	Add an IHostedService registration for the given type.
AddHostedService<THostedService>(IServiceCollection, Func<IServiceProvider,THostedService>)	Add an IHostedService registration for the given type.
AddScoped(IServiceCollection, Type)	Adds a scoped service of the type specified in `serviceType` to the specified IServiceCollection.
AddScoped(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds a scoped service of the type specified in `serviceType` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddScoped(IServiceCollection, Type, Type)	Adds a scoped service of the type specified in `serviceType` with an implementation of the type specified in `implementationType` to the specified IServiceCollection.
AddScoped<TService>(IServiceCollection)	Adds a scoped service of the type specified in `TService` to the specified IServiceCollection.
AddScoped<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds a scoped service of the type specified in `TService` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddScoped<TService,TImplementation>(IServiceCollection)	Adds a scoped service of the type specified in `TService` with an implementation type specified in `TImplementation` to the specified IServiceCollection.
AddScoped<TService,TImplementation>(IServiceCollection, Func<IServiceProvider,TImplementation>)	Adds a scoped service of the type specified in `TService` with an implementation type specified in `TImplementation` using the factory specified in `implementationFactory` to the specified IServiceCollection.
AddSingleton(IServiceCollection, Type)	Adds a singleton service of the type specified in `serviceType` to the specified IServiceCollection.
AddSingleton(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds a singleton service of the type specified in `serviceType` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddSingleton(IServiceCollection, Type, Object)	Adds a singleton service of the type specified in `serviceType` with an instance specified in `implementationInstance` to the specified IServiceCollection.
AddSingleton(IServiceCollection, Type, Type)	Adds a singleton service of the type specified in `serviceType` with an implementation of the type specified in `implementationType` to the specified IServiceCollection.
AddSingleton<TService>(IServiceCollection)	Adds a singleton service of the type specified in `TService` to the specified IServiceCollection.
AddSingleton<TService>(IServiceCollection, TService)	Adds a singleton service of the type specified in `TService` with an instance specified in `implementationInstance` to the specified IServiceCollection.
AddSingleton<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds a singleton service of the type specified in `TService` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddSingleton<TService,TImplementation>(IServiceCollection)	Adds a singleton service of the type specified in `TService` with an implementation type specified in `TImplementation` to the specified IServiceCollection.
AddSingleton<TService,TImplementation>(IServiceCollection, Func<IServiceProvider,TImplementation>)	Adds a singleton service of the type specified in `TService` with an implementation type specified in `TImplementation` using the factory specified in `implementationFactory` to the specified IServiceCollection.
AddTransient(IServiceCollection, Type)	Adds a transient service of the type specified in `serviceType` to the specified IServiceCollection.
AddTransient(IServiceCollection, Type, Func<IServiceProvider,Object>)	Adds a transient service of the type specified in `serviceType` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddTransient(IServiceCollection, Type, Type)	Adds a transient service of the type specified in `serviceType` with an implementation of the type specified in `implementationType` to the specified IServiceCollection.
AddTransient<TService>(IServiceCollection)	Adds a transient service of the type specified in `TService` to the specified IServiceCollection.
AddTransient<TService>(IServiceCollection, Func<IServiceProvider,TService>)	Adds a transient service of the type specified in `TService` with a factory specified in `implementationFactory` to the specified IServiceCollection.
AddTransient<TService,TImplementation>(IServiceCollection)	Adds a transient service of the type specified in `TService` with an implementation type specified in `TImplementation` to the specified IServiceCollection.
AddTransient<TService,TImplementation>(IServiceCollection, Func<IServiceProvider,TImplementation>)	Adds a transient service of the type specified in `TService` with an implementation type specified in `TImplementation` using the factory specified in `implementationFactory` to the specified IServiceCollection.
AddDistributedSqlServerCache(IServiceCollection, Action<SqlServerCacheOptions>)	Adds Microsoft SQL Server distributed caching services to the specified IServiceCollection.
AddStackExchangeRedisCache(IServiceCollection, Action<RedisCacheOptions>)	Adds Redis distributed caching services to the specified IServiceCollection.
AsReadOnly<T>(IList<T>)	Returns a read-only ReadOnlyCollection<T> wrapper for the specified list.
CopyToDataTable<T>(IEnumerable<T>)	Returns a DataTable that contains copies of the DataRow objects, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.
CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption)	Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.
CopyToDataTable<T>(IEnumerable<T>, DataTable, LoadOption, FillErrorEventHandler)	Copies DataRow objects to the specified DataTable, given an input IEnumerable<T> object where the generic parameter `T` is DataRow.

Applies to