Events - List By Subscription Id

Reference

Service:: Resource Health

API Version:: 2024-02-01

Lists service health events in the subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter={$filter}&queryStartTime={queryStartTime}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.
$filter	query		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
queryStartTime	query		string	Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020

Responses

Name	Type	Description
200 OK	events	The list of current service health events in the subscription
Other Status Codes	ErrorResponse	DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ListEventsBySubscriptionId

Sample request

HTTP

GET https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.ResourceHealth/events?api-version=2024-02-01&$filter=service eq 'Virtual Machines' or region eq 'West US'&queryStartTime=7/24/2020

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ",
      "name": "BC_1-FXZ",
      "type": "/providers/Microsoft.ResourceHealth/events",
      "properties": {
        "eventType": "ServiceIssue",
        "eventSource": "ResourceHealth",
        "status": "Active",
        "title": "ACTIVE: Virtual machines in West US",
        "summary": "An outage alert is being investigated. More information will be provided as it is known.",
        "header": "Your service might have been impacted by an Azure service issue",
        "article": {
          "articleContent": "<html>An outage alert is being investigated. More information will be provided as it is known</html>"
        },
        "links": [
          {
            "type": "Hyperlink",
            "displayText": {
              "value": "Request RCA",
              "localizedValue": "Request RCA"
            },
            "extensionName": "Microsoft_Azure_Health",
            "bladeName": "RequestRCABlade",
            "parameters": {
              "trackingId": "BC_1-FXZ",
              "rcaRequested": "False"
            }
          },
          {
            "type": "Button",
            "displayText": {
              "value": "Sign up for updates",
              "localizedValue": "Sign up for updates"
            },
            "extensionName": "Microsoft_Azure_Health",
            "bladeName": "AzureHealthBrowseBlade",
            "parameters": {
              "trackingId": "BC_1-FXZ"
            }
          }
        ],
        "level": "Warning",
        "eventLevel": "Informational",
        "impactStartTime": "2018-11-07T00:00:00Z",
        "impactMitigationTime": "2018-11-08T00:00:00Z",
        "impact": [
          {
            "impactedService": "Virtual Machines",
            "impactedServiceGuid": "fd8065f5-ffd0-4756-8788-e6a11bf36257",
            "impactedRegions": [
              {
                "impactedRegion": "West US",
                "status": "Active",
                "impactedSubscriptions": [
                  "{subscriptionId}"
                ],
                "impactedTenants": [],
                "lastUpdateTime": "2017-12-05T21:05:00Z"
              }
            ]
          }
        ],
        "recommendedActions": {
          "message": "Recommended actions title",
          "actions": [
            {
              "groupId": 23243,
              "actionText": "action 1"
            },
            {
              "groupId": 23432,
              "actionText": "action 2"
            }
          ],
          "localeCode": "en"
        },
        "faqs": [
          {
            "question": "This is a question",
            "answer": "This is an answer",
            "localeCode": "en"
          }
        ],
        "isHIR": false,
        "enableMicrosoftSupport": true,
        "enableChatWithUs": false,
        "priority": 2,
        "lastUpdateTime": "2018-11-08T00:00:00Z",
        "hirStage": "resolved"
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}

Definitions

Name	Description
Actions	Recommended actions for the service health event.
AdditionalInformation	Additional information
Article	Article of event.
createdByType	The type of identity that created the resource.
DisplayText	Display text of link.
ErrorResponse	Error details.
event	Service health event
EventLevelValues	Level of event.
events	The List events operation response.
EventSourceValues	Source of event.
EventStatusValues	Current status of event.
EventTypeValues	Type of event.
faq	Frequently asked question for the service health event
impact	Azure service impacted by the service health event.
impactedServiceRegion	Azure region impacted by the service health event.
LevelValues	Level of insight.
link	Useful links for service health event.
LinkTypeValues	Type of link.
RecommendedActions	Recommended actions of event.
systemData	Metadata pertaining to creation and last modification of the resource.
update	Update for service health event.

Actions

Recommended actions for the service health event.

Name	Type	Description
actionText	string	Recommended action text
groupId	integer	Recommended action group Id for the service health event.

AdditionalInformation

Additional information

Name	Type	Description
message	string	Additional information Message

Article

Article of event.

Name	Type	Description
articleContent	string	Article content of event.
articleId	string	Article Id
parameters	object	It provides a map of parameter name and value

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DisplayText

Display text of link.

Name	Type	Description
localizedValue	string	Localized display text of link.
value	string	Display text of link.

ErrorResponse

Error details.

Name	Type	Description
code	string	The error code.
details	string	The error details.
message	string	The error message.

event

Service health event

Name	Type	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
properties.additionalInformation	AdditionalInformation	Additional information
properties.article	Article	Article of event.
properties.description	string	Contains the communication message for the event, that could include summary, root cause and other details.
properties.duration	integer	duration in seconds
properties.enableChatWithUs	boolean	Tells if we want to enable or disable Microsoft Support for this event.
properties.enableMicrosoftSupport	boolean	Tells if we want to enable or disable Microsoft Support for this event.
properties.eventLevel	EventLevelValues	Level of event.
properties.eventSource	EventSourceValues	Source of event.
properties.eventType	EventTypeValues	Type of event.
properties.externalIncidentId	string	The id of the Incident
properties.faqs	faq[]	Frequently asked questions for the service health event.
properties.header	string	Header text of event.
properties.hirStage	string	Stage for HIR Document
properties.impact	impact[]	List services impacted by the service health event.
properties.impactMitigationTime	string	It provides the Timestamp for when the health impacting event resolved.
properties.impactStartTime	string	It provides the Timestamp for when the health impacting event started.
properties.impactType	string	The type of the impact
properties.isHIR	boolean	It provides information if the event is High incident rate event or not.
properties.lastUpdateTime	string	It provides the Timestamp for when the health impacting event was last updated.
properties.level	LevelValues	Level of insight.
properties.links	link[]	Useful links of event.
properties.platformInitiated	boolean	Is true if the event is platform initiated.
properties.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.
properties.reason	string	The reason for the Incident
properties.recommendedActions	RecommendedActions	Recommended actions of event.
properties.status	EventStatusValues	Current status of event.
properties.summary	string	Summary text of event.
properties.title	string	Title text of event.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

EventLevelValues

Level of event.

Name	Type	Description
Critical	string
Error	string
Informational	string
Warning	string

events

The List events operation response.

Name	Type	Description
nextLink	string	The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events.
value	event[]	The list of event.

EventSourceValues

Source of event.

Name	Type	Description
ResourceHealth	string
ServiceHealth	string

EventStatusValues

Current status of event.

Name	Type	Description
Active	string
Resolved	string

EventTypeValues

Type of event.

Name	Type	Description
EmergingIssues	string
HealthAdvisory	string
PlannedMaintenance	string
RCA	string
SecurityAdvisory	string
ServiceIssue	string

faq

Frequently asked question for the service health event

Name	Type	Description
answer	string	FAQ answer for the service health event.
localeCode	string	FAQ locale for the service health event.
question	string	FAQ question for the service health event.

impact

Azure service impacted by the service health event.

Name	Type	Description
impactedRegions	impactedServiceRegion[]	List regions impacted by the service health event.
impactedService	string	Impacted service name.
impactedServiceGuid	string	Impacted service guid. This is the permanent identifier for the impacted service.

impactedServiceRegion

Azure region impacted by the service health event.

Name	Type	Description
impactedRegion	string	Impacted region name.
impactedSubscriptions	string[]	List subscription impacted by the service health event.
impactedTenants	string[]	List tenant impacted by the service health event.
lastUpdateTime	string	It provides the Timestamp for when the last update for the service health event.
status	EventStatusValues	Current status of event in the region.
updates	update[]	List of updates for given service health event.

LevelValues

Level of insight.

Name	Type	Description
Critical	string
Warning	string

link

Useful links for service health event.

Name	Type	Description
bladeName	string	It provides the name of portal extension blade to produce link for given service health event.
displayText	DisplayText	Display text of link.
extensionName	string	It provides the name of portal extension to produce link for given service health event.
parameters	object	It provides a map of parameter name and value for portal extension blade to produce lik for given service health event.
type	LinkTypeValues	Type of link.

LinkTypeValues

Type of link.

Name	Type	Description
Button	string
Hyperlink	string

RecommendedActions

Recommended actions of event.

Name	Type	Description
actions	Actions[]	Recommended actions for the service health event.
localeCode	string	Recommended action locale for the service health event.
message	string	Recommended action title for the service health event.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

update

Update for service health event.

Name	Type	Description
summary	string	Summary text for the given update for the service health event.
updateDateTime	string	It provides the Timestamp for the given update for the service health event.

Share via