AzureResourceHealthSignalStatus interface

Package:

@azure/arm-cloudhealth

Status of an Azure Resource Health signal, including availability information reported by Azure Resource Health.

Properties

additionalContext	Additional context as provided by the submitter
availabilityReportedTime	Timestamp when Azure Resource Health observed the current availability state.
availabilityState	Availability state of the Azure resource as reported by Azure Resource Health.
category	Whether the status changing event was planned or unplanned.
detailedStatus	Detailed status of the Azure resource as reported by Azure Resource Health.
error	Error message if the signal status cannot be retrieved
healthState	Health state of this signal
reasonChronicity	Whether the current availability state is 'Persistent' or 'Transient'.
reasonType	Reason type for the current availability state (e.g. 'Unplanned', 'Planned', 'UserInitiated').
reportedAt	Timestamp when the value was reported
summary	Human-readable summary of the current availability state from Azure Resource Health.
value	Reported value of the signal

Property Details

additionalContext

Additional context as provided by the submitter

additionalContext?: string

Property Value

string

availabilityReportedTime

Timestamp when Azure Resource Health observed the current availability state.

availabilityReportedTime?: Date

Property Value

Date

availabilityState

Availability state of the Azure resource as reported by Azure Resource Health.

availabilityState?: string

Property Value

string

category

Whether the status changing event was planned or unplanned.

category?: string

Property Value

string

detailedStatus

Detailed status of the Azure resource as reported by Azure Resource Health.

detailedStatus?: string

Property Value

string

error

Error message if the signal status cannot be retrieved

error?: string

Property Value

string

healthState

Health state of this signal

healthState?: string

Property Value

string

reasonChronicity

Whether the current availability state is 'Persistent' or 'Transient'.

reasonChronicity?: string

Property Value

string

reasonType

Reason type for the current availability state (e.g. 'Unplanned', 'Planned', 'UserInitiated').

reasonType?: string

Property Value

string

reportedAt

Timestamp when the value was reported

reportedAt?: Date

Property Value

Date

summary

Human-readable summary of the current availability state from Azure Resource Health.

summary?: string

Property Value

string

value

Reported value of the signal

value?: number

Property Value

number