Event interface

Package:

@azure/arm-resourcehealth

Service health event

Extends

ProxyResource

Properties

additionalInformation	Additional information
article	Article of event.
description	Contains the communication message for the event, that could include summary, root cause and other details.
duration	duration in seconds
enableChatWithUs	Tells if we want to enable or disable Microsoft Support for this event.
enableMicrosoftSupport	Tells if we want to enable or disable Microsoft Support for this event.
eventLevel	Level of event.
eventSource	Source of event.
eventType	Type of event.
externalIncidentId	The id of the Incident
faqs	Frequently asked questions for the service health event.
header	Header text of event.
hirStage	Stage for HIR Document
impact	List services impacted by the service health event.
impactMitigationTime	It provides the Timestamp for when the health impacting event resolved.
impactStartTime	It provides the Timestamp for when the health impacting event started.
impactType	The type of the impact
isHIR	It provides information if the event is High incident rate event or not.
lastUpdateTime	It provides the Timestamp for when the health impacting event was last updated.
level	Level of insight.
links	Useful links of event.
platformInitiated	Is true if the event is platform initiated.
priority	Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved.
reason	The reason for the Incident
recommendedActions	Recommended actions of event.
status	Current status of event.
summary	Summary text of event.
title	Title text of event.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

additionalInformation

Additional information

additionalInformation?: EventPropertiesAdditionalInformation

Property Value

EventPropertiesAdditionalInformation

article

Article of event.

article?: EventPropertiesArticle

Property Value

EventPropertiesArticle

description

Contains the communication message for the event, that could include summary, root cause and other details.

description?: string

Property Value

string

duration

duration in seconds

duration?: number

Property Value

number

enableChatWithUs

Tells if we want to enable or disable Microsoft Support for this event.

enableChatWithUs?: boolean

Property Value

boolean

enableMicrosoftSupport

Tells if we want to enable or disable Microsoft Support for this event.

enableMicrosoftSupport?: boolean

Property Value

boolean

eventLevel

Level of event.

eventLevel?: string

Property Value

string

eventSource

Source of event.

eventSource?: string

Property Value

string

eventType

Type of event.

eventType?: string

Property Value

string

externalIncidentId

The id of the Incident

externalIncidentId?: string

Property Value

string

faqs

Frequently asked questions for the service health event.

faqs?: Faq[]

Property Value

Faq[]

header

Header text of event.

header?: string

Property Value

string

hirStage

Stage for HIR Document

hirStage?: string

Property Value

string

impact

List services impacted by the service health event.

impact?: Impact[]

Property Value

Impact[]

impactMitigationTime

It provides the Timestamp for when the health impacting event resolved.

impactMitigationTime?: Date

Property Value

Date

impactStartTime

It provides the Timestamp for when the health impacting event started.

impactStartTime?: Date

Property Value

Date

impactType

The type of the impact

impactType?: string

Property Value

string

isHIR

It provides information if the event is High incident rate event or not.

isHIR?: boolean

Property Value

boolean

lastUpdateTime

It provides the Timestamp for when the health impacting event was last updated.

lastUpdateTime?: Date

Property Value

Date

level

Level of insight.

level?: string

Property Value

string

links

Useful links of event.

links?: Link[]

Property Value

Link[]

platformInitiated

Is true if the event is platform initiated.

platformInitiated?: boolean

Property Value

boolean

priority

Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved.

priority?: number

Property Value

number

reason

The reason for the Incident

reason?: string

Property Value

string

recommendedActions

Recommended actions of event.

recommendedActions?: EventPropertiesRecommendedActions

Property Value

EventPropertiesRecommendedActions

status

Current status of event.

status?: string

Property Value

string

summary

Summary text of event.

summary?: string

Property Value

string

title

Title text of event.

title?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type