AvailabilityStatusProperties interface

Package:

@azure/arm-resourcehealth

Properties of availability state.

Properties

articleId	The Article Id
availabilityState	Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event
category	When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored.
context	When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object.
detailedStatus	Details of the availability status.
healthEventCategory	In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.
healthEventCause	In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.
healthEventId	It is a unique Id that identifies the event
healthEventType	In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.
occuredTime	Timestamp for when last change in health status occurred.
reasonChronicity	Chronicity of the availability transition.
reasonType	When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.
recentlyResolved	An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned
recommendedActions	Lists actions the user can take based on the current availabilityState of the resource.
reportedTime	Timestamp for when the health was last checked.
resolutionETA	When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.
rootCauseAttributionTime	When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.
serviceImpactingEvents	Lists the service impacting events that may be affecting the health of the resource.
summary	Summary description of the availability status.
title	Title description of the availability status.

Property Details

articleId

The Article Id

articleId?: string

Property Value

string

availabilityState

Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event

availabilityState?: string

Property Value

string

category

When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored.

category?: string

Property Value

string

context

When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object.

context?: string

Property Value

string

detailedStatus

Details of the availability status.

detailedStatus?: string

Property Value

string

healthEventCategory

In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc.

healthEventCategory?: string

Property Value

string

healthEventCause

In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc.

healthEventCause?: string

Property Value

string

healthEventId

It is a unique Id that identifies the event

healthEventId?: string

Property Value

string

healthEventType

In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc.

healthEventType?: string

Property Value

string

occuredTime

Timestamp for when last change in health status occurred.

occuredTime?: Date

Property Value

Date

reasonChronicity

Chronicity of the availability transition.

reasonChronicity?: string

Property Value

string

reasonType

When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc.

reasonType?: string

Property Value

string

recentlyResolved

An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned

recentlyResolved?: AvailabilityStatusPropertiesRecentlyResolved

Property Value

AvailabilityStatusPropertiesRecentlyResolved

recommendedActions

Lists actions the user can take based on the current availabilityState of the resource.

recommendedActions?: RecommendedAction[]

Property Value

RecommendedAction[]

reportedTime

Timestamp for when the health was last checked.

reportedTime?: Date

Property Value

Date

resolutionETA

When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.

resolutionETA?: Date

Property Value

Date

rootCauseAttributionTime

When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.

rootCauseAttributionTime?: Date

Property Value

Date

serviceImpactingEvents

Lists the service impacting events that may be affecting the health of the resource.

serviceImpactingEvents?: ServiceImpactingEvent[]

Property Value

ServiceImpactingEvent[]

summary

Summary description of the availability status.

summary?: string

Property Value

string

title

Title description of the availability status.

title?: string

Property Value

string