withHttpHealthCheck

Docs/Reference/Search TypeScript APIs/Aspire.Hosting/withHttpHealthCheck

withHttpHealthCheck

Docs Reference Search TypeScript APIs Aspire.Hosting withHttpHealthCheck

Method

📦 Aspire.Hosting v13.4.0

interface ContainerResource {
  // ... omitted for brevity
  withHttpHealthCheck(
      path?: string,
      statusCode?: number,
      endpointName?: string): IResourceWithEndpoints;
}

Signature

methodwithHttpHealthCheckbuilder

Adds a health check to the resource which is mapped to a specific endpoint.

withHttpHealthCheck(
    path?: string,
    statusCode?: number,
    endpointName?: string): IResourceWithEndpoints

Parameters

pathstringoptional

statusCodenumberoptional

endpointNamestringoptional

Returns

IResourceWithEndpoints

Applies to

This method applies to the following types:

typeContainerResource

typeExecutableResource

typeProjectResource

typeDotnetToolResource

typeCSharpAppResource