View Source

Class CheckHealthCheckGroupController

Inheritance

System.Object

ManagementApiControllerBase

HealthCheckGroupControllerBase

Namespace: Umbraco.Cms.Api.Management.Controllers.HealthCheck.Group

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class CheckHealthCheckGroupController : HealthCheckGroupControllerBase

Constructors

CheckHealthCheckGroupController(IHealthCheckGroupPresentationFactory)

Declaration

public CheckHealthCheckGroupController(IHealthCheckGroupPresentationFactory healthCheckGroupPresentationFactory)

Parameters

Type	Name	Description
IHealthCheckGroupPresentationFactory	healthCheckGroupPresentationFactory

Methods

ByNameWithResult(CancellationToken, String)

Check all health checks in the group with a given group name.

Declaration

public async Task<IActionResult> ByNameWithResult(CancellationToken cancellationToken, string name)

Parameters

Type	Name	Description
CancellationToken	cancellationToken
System.String	name	The name of the group.

Returns

Type	Description
Task<IActionResult>	The health check group or not found result.

Remarks

The health check result(s) will be included as part of the health checks.