Azure Resource Health · Schema
event
Service health event
Continuous IntegrationDeveloper ToolsPublic APIsMicrosoft AzureMicrosoftMonitoringService Health
Properties
| Name | Type | Description |
|---|---|---|
| properties | object | Properties of event. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/azure-devops-health/json-schema/azure-devops-health-event-schema.json",
"title": "event",
"description": "Service health event",
"x-generated": "2026-11-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/azure-devops-health-event-api-openapi.yml#/components/schemas/event",
"type": "object",
"properties": {
"properties": {
"$ref": "#/$defs/EventProperties",
"description": "Properties of event.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/$defs/TypesProxyResource"
}
],
"$defs": {
"ApiOperationLink": {
"type": "object",
"description": "An API operation associated with an event.",
"properties": {
"httpMethod": {
"type": "string",
"description": "HTTP method to use. Resource Health returns GET for Advisor recommendations.",
"readOnly": true
},
"url": {
"type": "string",
"format": "uri",
"description": "Opaque absolute ARM URL for the associated API operation.",
"readOnly": true
},
"description": {
"type": "string",
"description": "Human-readable description of the operation. Clients must not parse this value.",
"readOnly": true
}
},
"required": [
"httpMethod",
"url"
]
},
"EventLevelValues": {
"type": "string",
"description": "Level of event.",
"enum": [
"Critical",
"Error",
"Warning",
"Informational"
],
"x-ms-enum": {
"name": "EventLevelValues",
"modelAsString": true,
"values": [
{
"name": "Critical",
"value": "Critical",
"description": "Critical"
},
{
"name": "Error",
"value": "Error",
"description": "Error"
},
{
"name": "Warning",
"value": "Warning",
"description": "Warning"
},
{
"name": "Informational",
"value": "Informational",
"description": "Informational"
}
]
}
},
"EventProperties": {
"type": "object",
"description": "Properties of event.",
"properties": {
"eventType": {
"$ref": "#/$defs/EventTypeValues",
"description": "Type of event."
},
"eventSubType": {
"$ref": "#/$defs/EventSubTypeValues",
"description": "Sub-type of event."
},
"advisorRecommendations": {
"$ref": "#/$defs/ApiOperationLink",
"description": "Operation for listing Advisor recommendations associated with this event's tracking ID in the response subscription.",
"readOnly": true
},
"eventSource": {
"$ref": "#/$defs/EventSourceValues",
"description": "Source of event."
},
"status": {
"$ref": "#/$defs/EventStatusValues",
"description": "Current status of event."
},
"title": {
"type": "string",
"description": "Title text of event."
},
"summary": {
"type": "string",
"description": "Summary text of event. Use fetchEventDetails endpoint to get summary of sensitive events."
},
"header": {
"type": "string",
"description": "Header text of event."
},
"level": {
"$ref": "#/$defs/LevelValues",
"description": "Level of insight."
},
"eventLevel": {
"$ref": "#/$defs/EventLevelValues",
"description": "Level of event."
},
"isEventSensitive": {
"type": "boolean",
"description": "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"
},
"externalIncidentId": {
"type": "string",
"description": "The id of the Incident"
},
"reason": {
"type": "string",
"description": "The reason for the Incident"
},
"article": {
"$ref": "#/$defs/EventPropertiesArticle",
"description": "Article of event."
},
"links": {
"type": "array",
"description": "Useful links of event.",
"items": {
"$ref": "#/$defs/link"
},
"x-ms-identifiers": []
},
"impactStartTime": {
"type": "string",
"format": "date-time",
"description": "It provides the Timestamp for when the health impacting event started."
},
"impactMitigationTime": {
"type": "string",
"format": "date-time",
"description": "It provides the Timestamp for when the health impacting event resolved."
},
"impact": {
"type": "array",
"description": "List services impacted by the service health event.",
"items": {
"$ref": "#/$defs/impact"
},
"x-ms-identifiers": []
},
"recommendedActions": {
"$ref": "#/$defs/EventPropertiesRecommendedActions",
"description": "Recommended actions of event."
},
"faqs": {
"type": "array",
"description": "Frequently asked questions for the service health event.",
"items": {
"$ref": "#/$defs/faq"
},
"x-ms-identifiers": []
},
"isHIR": {
"type": "boolean",
"description": "It provides information if the event is High incident rate event or not."
},
"enableMicrosoftSupport": {
"type": "boolean",
"description": "Tells if we want to enable or disable Microsoft Support for this event."
},
"description": {
"type": "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."
},
"platformInitiated": {
"type": "boolean",
"description": "Is true if the event is platform initiated."
},
"enableChatWithUs": {
"type": "boolean",
"description": "Tells if we want to enable or disable Microsoft Support for this event."
},
"priority": {
"type": "integer",
"format": "int32",
"description": "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."
},
"lastUpdateTime": {
"type": "string",
"format": "date-time",
"description": "It provides the Timestamp for when the health impacting event was last updated."
},
"hirStage": {
"type": "string",
"description": "Stage for HIR Document"
},
"additionalInformation": {
"$ref": "#/$defs/EventPropertiesAdditionalInformation",
"description": "Additional information"
},
"duration": {
"type": "integer",
"format": "int32",
"description": "duration in seconds"
},
"impactType": {
"type": "string",
"description": "The type of the impact"
},
"eventTags": {
"type": "array",
"description": "A list of metadata tags associated with the event. Possible values include:\n-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.\n- False Positive: After investigation, we've determined your service is healthy and service issues did not impact your services as originally communicated.\n- 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.\n- 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.",
"items": {
"type": "string"
}
},
"newRate": {
"type": "number",
"format": "double",
"description": "Billing rate change information - new rate"
},
"oldRate": {
"type": "number",
"format": "double",
"description": "Billing rate change information - old rate"
},
"currencyType": {
"type": "string",
"description": "Billing currency type information. Example: USD, CAD"
},
"billingId": {
"type": "string",
"description": "Billing identifier information."
}
}
},
"EventPropertiesAdditionalInformation": {
"type": "object",
"description": "Additional information",
"properties": {
"message": {
"type": "string",
"description": "Additional information Message"
}
}
},
"EventPropertiesArticle": {
"type": "object",
"description": "Article of event.",
"properties": {
"articleContent": {
"type": "string",
"description": "Article content of event."
},
"articleId": {
"type": "string",
"description": "Article Id"
},
"parameters": {
"description": "It provides a map of parameter name and value"
}
}
},
"EventPropertiesRecommendedActions": {
"type": "object",
"description": "Recommended actions of event.",
"properties": {
"message": {
"type": "string",
"description": "Recommended action title for the service health event."
},
"actions": {
"type": "array",
"description": "Recommended actions for the service health event.",
"items": {
"$ref": "#/$defs/EventPropertiesRecommendedActionsActionsItem"
},
"x-ms-identifiers": []
},
"localeCode": {
"type": "string",
"description": "Recommended action locale for the service health event."
}
}
},
"EventPropertiesRecommendedActionsActionsItem": {
"type": "object",
"description": "Recommended action for the service health event.",
"properties": {
"groupId": {
"type": "integer",
"format": "int32",
"description": "Recommended action group Id for the service health event."
},
"actionText": {
"type": "string",
"description": "Recommended action text"
}
}
},
"EventSourceValues": {
"type": "string",
"description": "Source of event.",
"enum": [
"ResourceHealth",
"ServiceHealth"
],
"x-ms-enum": {
"name": "EventSourceValues",
"modelAsString": true,
"values": [
{
"name": "ResourceHealth",
"value": "ResourceHealth",
"description": "ResourceHealth"
},
{
"name": "ServiceHealth",
"value": "ServiceHealth",
"description": "ServiceHealth"
}
]
}
},
"EventStatusValues": {
"type": "string",
"description": "Current status of event.",
"enum": [
"Active",
"Resolved"
],
"x-ms-enum": {
"name": "EventStatusValues",
"modelAsString": true,
"values": [
{
"name": "Active",
"value": "Active",
"description": "Active"
},
{
"name": "Resolved",
"value": "Resolved",
"description": "Resolved"
}
]
}
},
"EventSubTypeValues": {
"type": "string",
"description": "Sub-type of event.",
"enum": [
"Retirement",
"ForeignExchangeRateChange",
"Underbilling",
"Overbilling",
"PriceChanges",
"TaxChanges",
"MeterIDChanges",
"UnauthorizedPartyAbuse"
],
"x-ms-enum": {
"name": "EventSubTypeValues",
"modelAsString": true,
"values": [
{
"name": "Retirement",
"value": "Retirement",
"description": "Retirement"
},
{
"name": "ForeignExchangeRateChange",
"value": "ForeignExchangeRateChange",
"description": "ForeignExchangeRateChange"
},
{
"name": "Underbilling",
"value": "Underbilling",
"description": "Underbilling"
},
{
"name": "Overbilling",
"value": "Overbilling",
"description": "Overbilling"
},
{
"name": "PriceChanges",
"value": "PriceChanges",
"description": "PriceChanges"
},
{
"name": "TaxChanges",
"value": "TaxChanges",
"description": "TaxChanges"
},
{
"name": "MeterIDChanges",
"value": "MeterIDChanges",
"description": "MeterIDChanges"
},
{
"name": "UnauthorizedPartyAbuse",
"value": "UnauthorizedPartyAbuse",
"description": "UnauthorizedPartyAbuse"
}
]
}
},
"EventTypeValues": {
"type": "string",
"description": "Type of event.",
"enum": [
"ServiceIssue",
"PlannedMaintenance",
"HealthAdvisory",
"RCA",
"EmergingIssues",
"SecurityAdvisory",
"Billing"
],
"x-ms-enum": {
"name": "EventTypeValues",
"modelAsString": true,
"values": [
{
"name": "ServiceIssue",
"value": "ServiceIssue",
"description": "ServiceIssue"
},
{
"name": "PlannedMaintenance",
"value": "PlannedMaintenance",
"description": "PlannedMaintenance"
},
{
"name": "HealthAdvisory",
"value": "HealthAdvisory",
"description": "HealthAdvisory"
},
{
"name": "RCA",
"value": "RCA",
"description": "RCA"
},
{
"name": "EmergingIssues",
"value": "EmergingIssues",
"description": "EmergingIssues"
},
{
"name": "SecurityAdvisory",
"value": "SecurityAdvisory",
"description": "SecurityAdvisory"
},
{
"name": "Billing",
"value": "Billing",
"description": "Billing"
}
]
}
},
"LevelValues": {
"type": "string",
"description": "Level of insight.",
"enum": [
"Critical",
"Warning"
],
"x-ms-enum": {
"name": "LevelValues",
"modelAsString": true,
"values": [
{
"name": "Critical",
"value": "Critical",
"description": "Critical"
},
{
"name": "Warning",
"value": "Warning",
"description": "Warning"
}
]
}
},
"LinkDisplayText": {
"type": "object",
"description": "Display text of link.",
"properties": {
"value": {
"type": "string",
"description": "Display text of link."
},
"localizedValue": {
"type": "string",
"description": "Localized display text of link."
}
}
},
"LinkTypeValues": {
"type": "string",
"description": "Type of link.",
"enum": [
"Button",
"Hyperlink"
],
"x-ms-enum": {
"name": "LinkTypeValues",
"modelAsString": true,
"values": [
{
"name": "Button",
"value": "Button",
"description": "Button"
},
{
"name": "Hyperlink",
"value": "Hyperlink",
"description": "Hyperlink"
}
]
}
},
"TypesProxyResource": {
"type": "object",
"title": "Proxy Resource",
"description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
"allOf": [
{
"$ref": "#/$defs/Resource"
}
]
},
"faq": {
"type": "object",
"description": "Frequently asked question for the service health event",
"properties": {
"question": {
"type": "string",
"description": "FAQ question for the service health event."
},
"answer": {
"type": "string",
"description": "FAQ answer for the service health event."
},
"localeCode": {
"type": "string",
"description": "FAQ locale for the service health event."
}
}
},
"impact": {
"type": "object",
"description": "Azure service impacted by the service health event.",
"properties": {
"impactedService": {
"type": "string",
"description": "Impacted service name."
},
"impactedServiceGuid": {
"type": "string",
"description": "Impacted service guid. This is the permanent identifier for the impacted service."
},
"impactedRegions": {
"type": "array",
"description": "List regions impacted by the service health event.",
"items": {
"$ref": "#/$defs/impactedServiceRegion"
},
"x-ms-identifiers": []
}
}
},
"impactedServiceRegion": {
"type": "object",
"description": "Azure region impacted by the service health event.",
"properties": {
"impactedRegion": {
"type": "string",
"description": "Impacted region name."
},
"status": {
"$ref": "#/$defs/EventStatusValues",
"description": "Current status of event in the region."
},
"impactedSubscriptions": {
"type": "array",
"description": "List subscription impacted by the service health event.",
"items": {
"type": "string"
}
},
"impactedTenants": {
"type": "array",
"description": "List tenant impacted by the service health event.",
"items": {
"type": "string"
}
},
"lastUpdateTime": {
"type": "string",
"format": "date-time",
"description": "It provides the Timestamp for when the last update for the service health event."
},
"updates": {
"type": "array",
"description": "List of updates for given service health event. Use fetchEventDetails endpoint to get updates of sensitive events.",
"items": {
"$ref": "#/$defs/update"
},
"x-ms-identifiers": []
}
}
},
"link": {
"type": "object",
"description": "Useful links for service health event.",
"properties": {
"type": {
"$ref": "#/$defs/LinkTypeValues",
"description": "Type of link."
},
"displayText": {
"$ref": "#/$defs/LinkDisplayText",
"description": "Display text of link."
},
"extensionName": {
"type": "string",
"description": "It provides the name of portal extension to produce link for given service health event."
},
"bladeName": {
"type": "string",
"description": "It provides the name of portal extension blade to produce link for given service health event."
},
"parameters": {
"description": "It provides a map of parameter name and value for portal extension blade to produce lik for given service health event."
}
}
},
"update": {
"type": "object",
"description": "Update for service health event.",
"properties": {
"summary": {
"type": "string",
"description": "Summary text for the given update for the service health event."
},
"updateDateTime": {
"type": "string",
"format": "date-time",
"description": "It provides the Timestamp for the given update for the service health event."
},
"eventTags": {
"type": "array",
"description": "A list of metadata tags associated with the event. Possible values include:\n-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.\n- False Positive: After investigation, we've determined your service is healthy and service issues did not impact your services as originally communicated.\n- 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.\n- 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.",
"items": {
"type": "string"
}
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/azure-devops-health-event"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.