IResourceWithEndpoints.withHttpHealthCheck

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

withHttpHealthCheck

Docs Reference Search TypeScript APIs Aspire.Hosting IResourceWithEndpoints withHttpHealthCheck

Method

📦 Aspire.Hosting v13.2.0-preview.1.26159.1

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

Signature

method withHttpHealthCheck builder

Adds an HTTP health check

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

Parameters

path string optional

statusCode number optional

endpointName string optional

Returns

IResourceWithEndpoints

Defined on

This method is defined on the following type:

interface IResourceWithEndpoints 10 members