Table of Contents

Class ManagementWebHostBuilderExtensions

Namespace
Steeltoe.Management.Endpoint
Assembly
Steeltoe.Management.EndpointCore.dll
public static class ManagementWebHostBuilderExtensions
Inheritance
ManagementWebHostBuilderExtensions
Inherited Members

Fields

ManagementPortKey 

public const string ManagementPortKey = "management:endpoints:port"

Field Value

string

ManagementSSLKey 

public const string ManagementSSLKey = "management:endpoints:sslenabled"

Field Value

string

Methods

AddAllActuators(IWebHostBuilder, Action<IEndpointConventionBuilder>, MediaTypeVersion, Action<CorsPolicyBuilder>)

Adds all Steeltoe Actuators to the application

public static IWebHostBuilder AddAllActuators(this IWebHostBuilder hostBuilder, Action<IEndpointConventionBuilder> configureEndpoints = null, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2, Action<CorsPolicyBuilder> buildCorsPolicy = null)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

configureEndpoints Action<IEndpointConventionBuilder>

IEndpointConventionBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

buildCorsPolicy Action<CorsPolicyBuilder>

Customize the CORS policy.

Returns

IWebHostBuilder

AddCloudFoundryActuator(IWebHostBuilder)

Adds the Cloud Foundry actuator to the application

public static IWebHostBuilder AddCloudFoundryActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddDbMigrationsActuator(IWebHostBuilder)

Adds the Database Migrations actuator to the application

public static IWebHostBuilder AddDbMigrationsActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddEnvActuator(IWebHostBuilder)

Adds the Environment actuator to the application

public static IWebHostBuilder AddEnvActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddHealthActuator(IWebHostBuilder)

Adds the Health actuator to the application

public static IWebHostBuilder AddHealthActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddHealthActuator(IWebHostBuilder, IHealthAggregator, Type[])

Adds the Health actuator to the application

public static IWebHostBuilder AddHealthActuator(this IWebHostBuilder hostBuilder, IHealthAggregator aggregator, Type[] contributors)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

aggregator IHealthAggregator

Custom health aggregator

contributors Type[]

Types that contribute to the overall health of the app

Returns

IWebHostBuilder

AddHealthActuator(IWebHostBuilder, Type[])

Adds the Health actuator to the application

public static IWebHostBuilder AddHealthActuator(this IWebHostBuilder hostBuilder, Type[] contributors)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

contributors Type[]

Types that contribute to the overall health of the app

Returns

IWebHostBuilder

AddHeapDumpActuator(IWebHostBuilder)

Adds the HeapDump actuator to the application

public static IWebHostBuilder AddHeapDumpActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddHypermediaActuator(IWebHostBuilder)

Adds the Hypermedia actuator to the application

public static IWebHostBuilder AddHypermediaActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddInfoActuator(IWebHostBuilder)

Adds the Info actuator to the application

public static IWebHostBuilder AddInfoActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddInfoActuator(IWebHostBuilder, IInfoContributor[])

Adds the Info actuator to the application

public static IWebHostBuilder AddInfoActuator(this IWebHostBuilder hostBuilder, IInfoContributor[] contributors)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

contributors IInfoContributor[]

Contributors to application information

Returns

IWebHostBuilder

AddLoggersActuator(IWebHostBuilder)

Adds the Loggers actuator to the application

public static IWebHostBuilder AddLoggersActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddMappingsActuator(IWebHostBuilder)

Adds the Mappings actuator to the application

public static IWebHostBuilder AddMappingsActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddMetricsActuator(IWebHostBuilder)

Adds the Metrics actuator to the application

public static IWebHostBuilder AddMetricsActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddRefreshActuator(IWebHostBuilder)

Adds the Refresh actuator to the application

public static IWebHostBuilder AddRefreshActuator(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder

AddThreadDumpActuator(IWebHostBuilder, MediaTypeVersion)

Adds the ThreadDump actuator to the application

public static IWebHostBuilder AddThreadDumpActuator(this IWebHostBuilder hostBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

IWebHostBuilder

AddTraceActuator(IWebHostBuilder, MediaTypeVersion)

Adds the Trace actuator to the application

public static IWebHostBuilder AddTraceActuator(this IWebHostBuilder hostBuilder, MediaTypeVersion mediaTypeVersion = MediaTypeVersion.V2)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

mediaTypeVersion MediaTypeVersion

Specify the media type version to use in the response

Returns

IWebHostBuilder

AddWavefrontMetrics(IWebHostBuilder)

Adds Wavefront to the application

public static IWebHostBuilder AddWavefrontMetrics(this IWebHostBuilder hostBuilder)

Parameters

hostBuilder IWebHostBuilder

Your HostBuilder

Returns

IWebHostBuilder