Share via


HciPrecheckResult Class

Definition

The HciPrecheckResult.

public class HciPrecheckResult : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Hci.Models.HciPrecheckResult>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Hci.Models.HciPrecheckResult>
public class HciPrecheckResult
type HciPrecheckResult = class
    interface IJsonModel<HciPrecheckResult>
    interface IPersistableModel<HciPrecheckResult>
type HciPrecheckResult = class
Public Class HciPrecheckResult
Implements IJsonModel(Of HciPrecheckResult), IPersistableModel(Of HciPrecheckResult)
Public Class HciPrecheckResult
Inheritance
HciPrecheckResult
Implements

Constructors

HciPrecheckResult()

Initializes a new instance of HciPrecheckResult.

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.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

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.

Explicit Interface Implementations

IJsonModel<HciPrecheckResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<HciPrecheckResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<HciPrecheckResult>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<HciPrecheckResult>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<HciPrecheckResult>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to