Package version:

Interface PrecheckResult

model interface PrecheckResult

interface PrecheckResult {
    additionalData?: string;
    description?: string;
    displayName?: string;
    healthCheckSource?: string;
    healthCheckTags?: any;
    name?: string;
    remediation?: string;
    severity?: string;
    status?: string;
    tags?: PrecheckResultTags;
    targetResourceID?: string;
    targetResourceName?: string;
    targetResourceType?: string;
    timestamp?: any;
    title?: string;
}

Properties

additionalData? description? displayName? healthCheckSource? healthCheckTags? name? remediation? severity? status? tags? targetResourceID? targetResourceName? targetResourceType? timestamp? title?

Properties

OptionaladditionalData

additionalData?: string

Property bag of key value pairs for additional information.

Optionaldescription

description?: string

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

OptionaldisplayName

displayName?: string

The health check DisplayName localized of the individual test executed.

OptionalhealthCheckSource

healthCheckSource?: string

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

OptionalhealthCheckTags

healthCheckTags?: any

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

Optionalname

name?: string

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

Optionalremediation

remediation?: string

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

Optionalseverity

severity?: string

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.

Optionalstatus

status?: string

Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress.

Optionaltags

tags?: PrecheckResultTags

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

OptionaltargetResourceID

targetResourceID?: string

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

OptionaltargetResourceName

targetResourceName?: string

The name of the affected resource.

OptionaltargetResourceType

targetResourceType?: string

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

Optionaltimestamp

timestamp?: any

The time in which the HealthCheck was called.

Optionaltitle

title?: string

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

Settings

Member Visibility