ResourceHealthAvailabilityStatusProperties Class

Definition

Properties of availability state.

public class ResourceHealthAvailabilityStatusProperties
type ResourceHealthAvailabilityStatusProperties = class
Public Class ResourceHealthAvailabilityStatusProperties
Inheritance
ResourceHealthAvailabilityStatusProperties

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.

OccuredOn

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.

ReportedOn

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.

RootCauseAttributionOn

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.

Applies to