Class HealthCheckAttribute
Metadata attribute for Health checks.
Inheritance
object
Attribute
Namespace: Umbraco.Cms.Core.HealthChecks
Assembly: Umbraco.Core.dll
Syntax
[AttributeUsage(AttributeTargets.Class)]
public sealed class HealthCheckAttribute : AttributeConstructors
View SourceHealthCheckAttribute(string, string)
Initializes a new instance of the HealthCheckAttribute class.
Declaration
public HealthCheckAttribute(string id, string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | id | The unique identifier for the health check as a GUID string. |
| string | name | The display name of the health check. |
Properties
View SourceDescription
Gets or sets the description of the health check.
Declaration
public string? Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Group
Gets or sets the group this health check belongs to.
Declaration
public string? Group { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Id
Gets the unique identifier of the health check.
Declaration
public Guid Id { get; }Property Value
| Type | Description |
|---|---|
| Guid |
Name
Gets the display name of the health check.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |