withHttpProbe

Method

📦 Aspire.Hosting v13.4.0

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

Signature

methodwithHttpProbebuilder

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

probeTypeProbeType

pathstringoptional

initialDelaySecondsnumberoptional

periodSecondsnumberoptional

timeoutSecondsnumberoptional

failureThresholdnumberoptional

successThresholdnumberoptional

endpointNamestringoptional

Returns

IResourceWithEndpoints

Applies to

This method applies to the following types:

typeContainerResource

typeExecutableResource

typeProjectResource

typeDotnetToolResource

typeCSharpAppResource