addHealthCheck

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

addHealthCheck

Docs Reference Search TypeScript APIs Aspire.Hosting addHealthCheck

Method

📦 Aspire.Hosting v13.5.0

interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addHealthCheck(
      name: string,
      check: callback): void;
}

Signature

methodaddHealthCheck

Adds a custom health check callback to the distributed-application builder.

addHealthCheck(name: string, check: () => Promise<HealthCheckResult>): void

Parameters

namestring

check() => Promise<HealthCheckResult>

Applies to

This method applies to the following types:

typeIDistributedApplicationBuilder