ExternalServiceResource.withHttpHealthCheck

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

withHttpHealthCheck

Docs Reference Search TypeScript APIs Aspire.Hosting ExternalServiceResource withHttpHealthCheck

Method

📦 Aspire.Hosting v13.4.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 for polyglot app hosts.

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

Parameters

path string optional

statusCode number optional

endpointName string optional

Returns

ExternalServiceResource

Defined on

This method is defined on the following type:

handle ExternalServiceResource 1 members