Events - List By Single Resource

Lists current service health events for given resource.

GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/events?api-version=2018-07-01
GET https://management.azure.com/{resourceUri}/providers/Microsoft.ResourceHealth/events?api-version=2018-07-01&$filter={$filter}&view={view}

URI Parameters

Name In Required Type Description
resourceUri
path True
  • string

The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}

api-version
query True
  • string

Client Api Version.

$filter
query
  • string

A valid odata query to limit the events returned. The logical operators and, or, equal, not equal, and top are supported. For example, $filter=Properties/EventType eq 'ServiceIssue' or Properties/EventType eq 'PlannedMaintenance' OR %24filter=Properties%2FEventType%20eq%20%27ServiceIssue%27%20or%20Properties%2FEventType%20eq%20%27PlannedMaintenance%27

view
query
  • string

setting view=full expands the article parameters

Responses

Name Type Description
200 OK

The list of current service health events for given resource

Other Status Codes

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

ListEventsBySingleResource

Sample Request

GET https://management.azure.com/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.Compute/virtualMachines/rhctestenvV1PI/providers/Microsoft.ResourceHealth/events?api-version=2018-07-01

Sample Response

{
  "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",
            "impactedRegions": [
              {
                "impactedRegion": "West US",
                "status": "Active",
                "impactedSubscriptions": [
                  "{subscriptionId}"
                ],
                "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": "active"
      }
    }
  ],
  "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}"
}

Definitions

Actions

Recommended actions for the service health event.

Article

Article of event.

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.

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.

Article

Article of event.

Name Type Description
articleContent
  • string

Article content of event.

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.article

Article of event.

properties.description
  • string

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

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

Level of event.

properties.eventSource

Source of event.

properties.eventType

Type of event.

properties.faqs

Frequently asked questions for the service health event.

properties.header
  • string

Header text of event.

properties.hirStage
  • string

Stage for HIR Document

properties.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.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

Level of insight.

properties.links

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.recommendedActions

Recommended actions of event.

properties.status

Current status of event.

properties.summary
  • string

Summary text of event.

properties.title
  • string

Title text of event.

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

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

List regions impacted by the service health event.

impactedService
  • string

Impacted service name.

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.

lastUpdateTime
  • string

It provides the Timestamp for when the last update for the service health event.

status

Current status of event in the region.

updates

List of updates for given service health event.

LevelValues

Level of insight.

Name Type Description
Critical
  • string
Warning
  • string

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

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

Type of link.

LinkTypeValues

Type of link.

Name Type Description
Button
  • string
Hyperlink
  • string

RecommendedActions

Recommended actions of event.

Name Type Description
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.

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.