Class EndpointServiceCollectionExtensions

Inheritance

System.Object

EndpointServiceCollectionExtensions

Namespace: Steeltoe.Management.Endpoint.Actuators.Health

Assembly: Steeltoe.Management.Endpoint.dll

Syntax

public static class EndpointServiceCollectionExtensions : object

Methods

AddHealthActuator(IServiceCollection)

Adds the health actuator to the service container and configures the ASP.NET Core middleware pipeline.

Declaration

public static IServiceCollection AddHealthActuator(this IServiceCollection services)

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.

Returns

Type	Description
IServiceCollection	The incoming services so that additional calls can be chained.

AddHealthActuator(IServiceCollection, Boolean)

Adds the health actuator to the service container.

Declaration

public static IServiceCollection AddHealthActuator(this IServiceCollection services, bool configureMiddleware)

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.
System.Boolean	configureMiddleware	When false, skips configuration of the ASP.NET Core middleware pipeline. While this provides full control over the pipeline order, it requires manual addition of the appropriate middleware for actuators to work correctly.

Returns

Type	Description
IServiceCollection	The incoming services so that additional calls can be chained.

AddHealthContributor(IServiceCollection, Type)

Adds the specified to the D/I container as a scoped service.

Declaration

public static IServiceCollection AddHealthContributor(this IServiceCollection services, Type healthContributorType)

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.
Type	healthContributorType	The type of the health contributor to add.

Returns

Type	Description
IServiceCollection	The incoming services so that additional calls can be chained.

AddHealthContributor<T>(IServiceCollection)

Adds the specified to the D/I container as a scoped service.

Declaration

public static IServiceCollection AddHealthContributor<T>(this IServiceCollection services)
    where T : class, IHealthContributor

Parameters

Type	Name	Description
IServiceCollection	services	The to add services to.

Returns

Type	Description
IServiceCollection	The incoming services so that additional calls can be chained.

Type Parameters

Name	Description
T	The type of health contributor to add.