event

Creates, updates, deletes, gets or lists an event resource.

Overview

Name	event
Type	Resource
Id	azure.resource_health.event

Fields

The following fields are returned by SELECT queries:

get_by_subscription_id_and_tracking_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalInformation	object	Additional information.
article	object	Article of event.
billingId	string	Billing identifier information.
currencyType	string	Billing currency type information. Example: USD, CAD.
description	string	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	integer	duration in seconds.
enableChatWithUs	boolean	Tells if we want to enable or disable Microsoft Support for this event.
enableMicrosoftSupport	boolean	Tells if we want to enable or disable Microsoft Support for this event.
eventLevel	string	Level of event. Known values are: "Critical", "Error", "Warning", and "Informational". (Critical, Error, Warning, Informational)
eventSource	string	Source of event. Known values are: "ResourceHealth" and "ServiceHealth". (ResourceHealth, ServiceHealth)
eventSubType	string	Sub-type of event. Known values are: "Retirement", "ForeignExchangeRateChange", "Underbilling", "Overbilling", "PriceChanges", "TaxChanges", "MeterIDChanges", and "UnauthorizedPartyAbuse". (Retirement, ForeignExchangeRateChange, Underbilling, Overbilling, PriceChanges, TaxChanges, MeterIDChanges, UnauthorizedPartyAbuse)
eventTags	array	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	string	Type of event. Known values are: "ServiceIssue", "PlannedMaintenance", "HealthAdvisory", "RCA", "EmergingIssues", "SecurityAdvisory", and "Billing". (ServiceIssue, PlannedMaintenance, HealthAdvisory, RCA, EmergingIssues, SecurityAdvisory, Billing)
externalIncidentId	string	The id of the Incident.
faqs	array	Frequently asked questions for the service health event.
header	string	Header text of event.
hirStage	string	Stage for HIR Document.
impact	array	List services impacted by the service health event.
impactMitigationTime	string (date-time)	It provides the Timestamp for when the health impacting event resolved.
impactStartTime	string (date-time)	It provides the Timestamp for when the health impacting event started.
impactType	string	The type of the impact.
isEventSensitive	boolean	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	boolean	It provides information if the event is High incident rate event or not.
lastUpdateTime	string (date-time)	It provides the Timestamp for when the health impacting event was last updated.
level	string	Level of insight. Known values are: "Critical" and "Warning". (Critical, Warning)
links	array	Useful links of event.
newRate	number	Billing rate change information - new rate.
oldRate	number	Billing rate change information - old rate.
platformInitiated	boolean	Is true if the event is platform initiated.
priority	integer	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	string	The reason for the Incident.
recommendedActions	object	Recommended actions of event.
status	string	Current status of event. Known values are: "Active" and "Resolved". (Active, Resolved)
summary	string	Summary text of event. Use fetchEventDetails endpoint to get summary of sensitive events.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title text of event.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_by_tenant_id_and_tracking_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalInformation	object	Additional information.
article	object	Article of event.
billingId	string	Billing identifier information.
currencyType	string	Billing currency type information. Example: USD, CAD.
description	string	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	integer	duration in seconds.
enableChatWithUs	boolean	Tells if we want to enable or disable Microsoft Support for this event.
enableMicrosoftSupport	boolean	Tells if we want to enable or disable Microsoft Support for this event.
eventLevel	string	Level of event. Known values are: "Critical", "Error", "Warning", and "Informational". (Critical, Error, Warning, Informational)
eventSource	string	Source of event. Known values are: "ResourceHealth" and "ServiceHealth". (ResourceHealth, ServiceHealth)
eventSubType	string	Sub-type of event. Known values are: "Retirement", "ForeignExchangeRateChange", "Underbilling", "Overbilling", "PriceChanges", "TaxChanges", "MeterIDChanges", and "UnauthorizedPartyAbuse". (Retirement, ForeignExchangeRateChange, Underbilling, Overbilling, PriceChanges, TaxChanges, MeterIDChanges, UnauthorizedPartyAbuse)
eventTags	array	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	string	Type of event. Known values are: "ServiceIssue", "PlannedMaintenance", "HealthAdvisory", "RCA", "EmergingIssues", "SecurityAdvisory", and "Billing". (ServiceIssue, PlannedMaintenance, HealthAdvisory, RCA, EmergingIssues, SecurityAdvisory, Billing)
externalIncidentId	string	The id of the Incident.
faqs	array	Frequently asked questions for the service health event.
header	string	Header text of event.
hirStage	string	Stage for HIR Document.
impact	array	List services impacted by the service health event.
impactMitigationTime	string (date-time)	It provides the Timestamp for when the health impacting event resolved.
impactStartTime	string (date-time)	It provides the Timestamp for when the health impacting event started.
impactType	string	The type of the impact.
isEventSensitive	boolean	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	boolean	It provides information if the event is High incident rate event or not.
lastUpdateTime	string (date-time)	It provides the Timestamp for when the health impacting event was last updated.
level	string	Level of insight. Known values are: "Critical" and "Warning". (Critical, Warning)
links	array	Useful links of event.
newRate	number	Billing rate change information - new rate.
oldRate	number	Billing rate change information - old rate.
platformInitiated	boolean	Is true if the event is platform initiated.
priority	integer	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	string	The reason for the Incident.
recommendedActions	object	Recommended actions of event.
status	string	Current status of event. Known values are: "Active" and "Resolved". (Active, Resolved)
summary	string	Summary text of event. Use fetchEventDetails endpoint to get summary of sensitive events.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
title	string	Title text of event.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_subscription_id_and_tracking_id	select	event_tracking_id, subscription_id	$filter, queryStartTime	Service health event in the subscription by event tracking id.
get_by_tenant_id_and_tracking_id	select	event_tracking_id	$filter, queryStartTime	Service health event in the tenant by event tracking id.
fetch_details_by_subscription_id_and_tracking_id	exec	event_tracking_id, subscription_id		Service health event details in the subscription by event tracking id. This can be used to fetch sensitive properties for Security Advisory events. Please see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access _.
fetch_billling_communication_details_by_subscription_id_and_tracking_id	exec	event_tracking_id, subscription_id		Service health event details specific in the subscription by event tracking id. This can be used to fetch sensitive properties for Billing event type.
fetch_details_by_tenant_id_and_tracking_id	exec	event_tracking_id		Service health event details in the tenant by event tracking id. This can be used to fetch sensitive properties for Security Advisory events. Please see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access _.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
event_tracking_id	string	Event Id which uniquely identifies ServiceHealth event. Required.
subscription_id	string
$filter	string	The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN _. Default value is None.
queryStartTime	string	Specifies from when to return events (default is 3 days), based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020. Default value is None.

SELECT examples

get_by_subscription_id_and_tracking_id

Service health event in the subscription by event tracking id.

SELECT
id,
name,
additionalInformation,
article,
billingId,
currencyType,
description,
duration,
enableChatWithUs,
enableMicrosoftSupport,
eventLevel,
eventSource,
eventSubType,
eventTags,
eventType,
externalIncidentId,
faqs,
header,
hirStage,
impact,
impactMitigationTime,
impactStartTime,
impactType,
isEventSensitive,
isHIR,
lastUpdateTime,
level,
links,
newRate,
oldRate,
platformInitiated,
priority,
reason,
recommendedActions,
status,
summary,
systemData,
title,
type
FROM azure.resource_health.event
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND queryStartTime = '{{ queryStartTime }}'
;

get_by_tenant_id_and_tracking_id

Service health event in the tenant by event tracking id.

SELECT
id,
name,
additionalInformation,
article,
billingId,
currencyType,
description,
duration,
enableChatWithUs,
enableMicrosoftSupport,
eventLevel,
eventSource,
eventSubType,
eventTags,
eventType,
externalIncidentId,
faqs,
header,
hirStage,
impact,
impactMitigationTime,
impactStartTime,
impactType,
isEventSensitive,
isHIR,
lastUpdateTime,
level,
links,
newRate,
oldRate,
platformInitiated,
priority,
reason,
recommendedActions,
status,
summary,
systemData,
title,
type
FROM azure.resource_health.event
WHERE event_tracking_id = '{{ event_tracking_id }}' -- required
AND $filter = '{{ $filter }}'
AND queryStartTime = '{{ queryStartTime }}'
;

Lifecycle Methods

fetch_details_by_subscription_id_and_tracking_id

Service health event details in the subscription by event tracking id. This can be used to fetch sensitive properties for Security Advisory events. Please see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access _.

EXEC azure.resource_health.event.fetch_details_by_subscription_id_and_tracking_id 
@event_tracking_id='{{ event_tracking_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

fetch_billling_communication_details_by_subscription_id_and_tracking_id

Service health event details specific in the subscription by event tracking id. This can be used to fetch sensitive properties for Billing event type.

EXEC azure.resource_health.event.fetch_billling_communication_details_by_subscription_id_and_tracking_id 
@event_tracking_id='{{ event_tracking_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

fetch_details_by_tenant_id_and_tracking_id

Service health event details in the tenant by event tracking id. This can be used to fetch sensitive properties for Security Advisory events. Please see https://learn.microsoft.com/en-us/azure/service-health/security-advisories-elevated-access _.

EXEC azure.resource_health.event.fetch_details_by_tenant_id_and_tracking_id 
@event_tracking_id='{{ event_tracking_id }}' --required
;