Share via


IPrecheckResult Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20240401.PrecheckResultTypeConverter))]
public interface IPrecheckResult : Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Runtime.IJsonSerializable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StackHCI.Models.Api20240401.PrecheckResultTypeConverter))>]
type IPrecheckResult = interface
    interface IJsonSerializable
Public Interface IPrecheckResult
Implements IJsonSerializable
Derived
Attributes
Implements

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).

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.

TagKey

Key that allow grouping/filtering individual tests.

TagValue

Value of the key 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.

Timestamp

The time in which the HealthCheck was called.

Title

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

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to