PrecheckResult interface

Package:

@azure/arm-azurestackhci

Properties

additionalData	Property bag of key value pairs for additional information.
description	Detailed overview of the issue and what impact the issue has on the stamp.
displayName	The health check DisplayName localized of the individual test executed.
healthCheckSource	The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).
healthCheckTags	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	Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.
status	The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.
tags	Key-value pairs that allow grouping/filtering individual tests.
targetResourceID	The unique identifier for the affected resource (such as a node or drive).
targetResourceName	The name of the affected resource.
targetResourceType	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?: string

Property Value

string

description

Detailed overview of the issue and what impact the issue has on the stamp.

description?: string

Property Value

string

displayName

The health check DisplayName localized of the individual test executed.

displayName?: string

Property Value

string

healthCheckSource

The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).

healthCheckSource?: string

Property Value

string

healthCheckTags

Key-value pairs that allow grouping/filtering individual tests.

healthCheckTags?: Record<string, unknown>

Property Value

Record<string, unknown>

name

Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.

name?: string

Property Value

string

remediation

Set of steps that can be taken to resolve the issue found.

remediation?: string

Property Value

string

severity

Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.

severity?: string

Property Value

string

status

The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.

status?: string

Property Value

string

tags

Key-value pairs that allow grouping/filtering individual tests.

tags?: PrecheckResultTags

Property Value

PrecheckResultTags

targetResourceID

The unique identifier for the affected resource (such as a node or drive).

targetResourceID?: string

Property Value

string

targetResourceName

The name of the affected resource.

targetResourceName?: string

Property Value

string

targetResourceType

The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring).

targetResourceType?: string

Property Value

string

timestamp

The time in which the HealthCheck was called.

timestamp?: Date

Property Value

Date

title

User-facing name; one or more sentences indicating the direct issue.

title?: string

Property Value

string