Event interface

Package:

@azure/arm-resourcehealth

Service health event

Extends

ProxyResource

Properties

additionalInformation	Additional information
article	Article of event.
billingId	Billing identifier information.
currencyType	Billing currency type information. Example: USD, CAD
description	Contains the communication message for the event, that could include summary, root cause and other details. Use fetchEventDetails endpoint to get description of sensitive events.
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.
eventSubType	Sub-type of event.
eventTags	A list of metadata tags associated with the event. Possible values include: -Action Recommended: Action may be required by you to avoid possible disruptions or mitigate risks for your services. It is recommended to evaluate these actions and the potential impact on your services. False Positive: After investigation, we've determined your service is healthy and service issues did not impact your services as originally communicated. Preliminary PIR: For our largest, most impactful service issues a Preliminary Post Incident Review (PIR) is published generally within 72 hours of mitigation, to summarize what we have learned so far from the still-in-progress investigation. Final PIR: For service issues, a Final Post Incident Review (PIR) may be published to provide additional details or learnings. Sometimes this requires us to complete an internal retrospective, generally within 14 days of mitigation.
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
isEventSensitive	If true the event may contains sensitive data. Use the post events/{trackingId}/fetchEventDetails endpoint to fetch sensitive data see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access
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.
newRate	Billing rate change information - new rate
oldRate	Billing rate change information - old rate
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. Use fetchEventDetails endpoint to get summary of sensitive events.
title	Title text of event.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	The name of the resource
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

additionalInformation

Additional information

additionalInformation?: EventPropertiesAdditionalInformation

Property Value

EventPropertiesAdditionalInformation

article

Article of event.

article?: EventPropertiesArticle

Property Value

EventPropertiesArticle

billingId

Billing identifier information.

billingId?: string

Property Value

string

currencyType

Billing currency type information. Example: USD, CAD

currencyType?: string

Property Value

string

description

Contains the communication message for the event, that could include summary, root cause and other details. Use fetchEventDetails endpoint to get description of sensitive events.

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

eventSubType

Sub-type of event.

eventSubType?: string

Property Value

string

eventTags

A list of metadata tags associated with the event. Possible values include: -Action Recommended: Action may be required by you to avoid possible disruptions or mitigate risks for your services. It is recommended to evaluate these actions and the potential impact on your services.

• False Positive: After investigation, we've determined your service is healthy and service issues did not impact your services as originally communicated.
• Preliminary PIR: For our largest, most impactful service issues a Preliminary Post Incident Review (PIR) is published generally within 72 hours of mitigation, to summarize what we have learned so far from the still-in-progress investigation.
• Final PIR: For service issues, a Final Post Incident Review (PIR) may be published to provide additional details or learnings. Sometimes this requires us to complete an internal retrospective, generally within 14 days of mitigation.

eventTags?: 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

isEventSensitive

If true the event may contains sensitive data. Use the post events/{trackingId}/fetchEventDetails endpoint to fetch sensitive data see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access

isEventSensitive?: boolean

Property Value

boolean

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[]

newRate

Billing rate change information - new rate

newRate?: number

Property Value

number

oldRate

Billing rate change information - old rate

oldRate?: number

Property Value

number

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. Use fetchEventDetails endpoint to get summary of sensitive events.

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}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type