withHttpHealthCheck

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

withHttpHealthCheck

Docs Reference Search TypeScript APIs Aspire.Hosting withHttpHealthCheck

Method

📦 Aspire.Hosting v13.3.0

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

Signature

method withHttpHealthCheck builder

Adds an HTTP health check to the external service

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

Parameters

path string optional

statusCode number optional

endpointName string optional

Returns

ExternalServiceResource

Applies to

This method applies to the following types:

type ExternalServiceResource