PrecheckResult interface
model interface PrecheckResult
Properties
| additional |
Property bag of key value pairs for additional information. |
| description | Detailed overview of the issue and what impact the issue has on the stamp. |
| display |
The health check DisplayName localized of the individual test executed. |
| health |
The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). |
| health |
Key-value pairs that allow grouping/filtering individual tests. |
| name | Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. |
| remediation | Set of steps that can be taken to resolve the issue found. |
| severity | Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. |
| status | Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. |
| tags | Key-value pairs that allow grouping/filtering individual tests. |
| target |
The unique identifier for the affected resource (such as a node or drive). |
| target |
The name of the affected resource. |
| target |
The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). |
| timestamp | The time in which the HealthCheck was called. |
| title | User-facing name; one or more sentences indicating the direct issue. |
Property Details
additionalData
Property bag of key value pairs for additional information.
additionalData?: stringProperty Value
string
description
Detailed overview of the issue and what impact the issue has on the stamp.
description?: stringProperty Value
string
displayName
The health check DisplayName localized of the individual test executed.
displayName?: stringProperty Value
string
healthCheckSource
The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).
healthCheckSource?: stringProperty Value
string
healthCheckTags
Key-value pairs that allow grouping/filtering individual tests.
healthCheckTags?: anyProperty Value
any
name
Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.
name?: stringProperty Value
string
remediation
Set of steps that can be taken to resolve the issue found.
remediation?: stringProperty Value
string
severity
Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates.
severity?: stringProperty Value
string
status
Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress.
status?: stringProperty Value
string
tags
Key-value pairs that allow grouping/filtering individual tests.
tags?: PrecheckResultTagsProperty Value
targetResourceID
The unique identifier for the affected resource (such as a node or drive).
targetResourceID?: stringProperty Value
string
targetResourceName
The name of the affected resource.
targetResourceName?: stringProperty Value
string
targetResourceType
The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring).
targetResourceType?: stringProperty Value
string
timestamp
The time in which the HealthCheck was called.
timestamp?: DateProperty Value
Date
title
User-facing name; one or more sentences indicating the direct issue.
title?: stringProperty Value
string