withHttpProbe

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

withHttpProbe

Docs Reference Search TypeScript APIs Aspire.Hosting withHttpProbe

Function

📦 Aspire.Hosting v13.2.0-preview.1.26159.1

interface ContainerResource {
  // ... omitted for brevity
  withHttpProbe(
      probeType: ProbeType,
      path?: string,
      initialDelaySeconds?: number,
      periodSeconds?: number,
      timeoutSeconds?: number,
      failureThreshold?: number,
      successThreshold?: number,
      endpointName?: string): IResourceWithEndpoints;
}

Signature

method withHttpProbe builder

Adds an HTTP health probe to the resource

withHttpProbe(
    probeType: ProbeType,
    path?: string,
    initialDelaySeconds?: number,
    periodSeconds?: number,
    timeoutSeconds?: number,
    failureThreshold?: number,
    successThreshold?: number,
    endpointName?: string): IResourceWithEndpoints

Parameters

probeType ProbeType

path string optional

initialDelaySeconds number optional

periodSeconds number optional

timeoutSeconds number optional

failureThreshold number optional

successThreshold number optional

endpointName string optional

Returns

IResourceWithEndpoints

Applies to

This function is an extension method on the following types:

type ContainerResource

type ExecutableResource

type ProjectResource

type DotnetToolResource

type CSharpAppResource