IHealthCheck.CheckHealthAsync(HealthCheckContext, CancellationToken) Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Runs the health check, returning the status of the component being checked.
C#
public System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult> CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext context, System.Threading.CancellationToken cancellationToken = default);abstract member CheckHealthAsync : Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult>Public Function CheckHealthAsync (context As HealthCheckContext, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HealthCheckResult)- context
- HealthCheckContext
A context object associated with the current execution.
- cancellationToken
- CancellationToken
A CancellationToken that can be used to cancel the health check.
A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked.
The cancellation token was canceled. This exception is stored into the returned task.
| Product | Versions |
|---|---|
| .NET | 10 (package-provided) |
| .NET Standard | 2.0 (package-provided) |
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
.NET feedback
.NET is an open source project. Select a link to provide feedback: