Microsoft.ResourceHealth (stable:2022-05-01)

2025/09/26 • 12 new, 12 deleted methods

AvailabilityStatuses_ListBySubscriptionId (new)
Description :  Lists the current availability status for all the resources in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_ListByResourceGroup (new)
Description :  Lists the current availability status for all the resources in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Operations_List (new)
Description :  Lists available operations for the resourcehealth resource provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations available in the resourcehealth resource provider. ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource name. ,
Required: False ,
}
string ,
operation:
{
Description: Operation name. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_GetByResource (new)
Description :  Gets current availability status for a single resource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_List (new)
Description :  Lists all historical availability transitions and impacting events for a single resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
ImpactedResources_ListBySubscriptionIdAndEventId (new)
Description :  Lists impacted resources in the subscription by an event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of eventImpactedResources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of impacted resource. ,
Required: False ,
}
{
targetResourceType:
{
Description: Resource type within Microsoft cloud. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Identity for resource within Microsoft cloud. ,
Required: False ,
}
string ,
targetRegion:
{
Description: Impacted resource region name. ,
Required: False ,
}
string ,
info:
{
Description: Additional information. ,
Required: False ,
}
[
{
key:
{
Description: Key of tuple. ,
Required: False ,
}
string ,
value:
{
Description: Value of tuple. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of impacted resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
ImpactedResources_Get (new)
Description :  Gets the specific impacted resource in the subscription by an event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
impactedResourceName:
{
Description: Name of the Impacted Resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of impacted resource. ,
Required: False ,
}
{
targetResourceType:
{
Description: Resource type within Microsoft cloud. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Identity for resource within Microsoft cloud. ,
Required: False ,
}
string ,
targetRegion:
{
Description: Impacted resource region name. ,
Required: False ,
}
string ,
info:
{
Description: Additional information. ,
Required: False ,
}
[
{
key:
{
Description: Key of tuple. ,
Required: False ,
}
string ,
value:
{
Description: Value of tuple. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListBySubscriptionId (new)
Description :  Lists service health events in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Event_GetBySubscriptionIdAndTrackingId (new)
Description :  Service health event in the subscription by event tracking id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListByTenantId (new)
Description :  Lists current service health events in the tenant.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/events
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Event_GetByTenantIdAndTrackingId (new)
Description :  Service health event in the tenant by event tracking id
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/events/{eventTrackingId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListBySingleResource (new)
Description :  Lists current service health events for given resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/events
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_ListBySubscriptionId (removed)
Description :  Lists the current availability status for all the resources in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_ListByResourceGroup (removed)
Description :  Lists the current availability status for all the resources in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Operations_List (removed)
Description :  Lists available operations for the resourcehealth resource provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations available in the resourcehealth resource provider. ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Provider name. ,
Required: False ,
}
string ,
resource:
{
Description: Resource name. ,
Required: False ,
}
string ,
operation:
{
Description: Operation name. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_GetByResource (removed)
Description :  Gets current availability status for a single resource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
AvailabilityStatuses_List (removed)
Description :  Lists all historical availability transitions and impacting events for a single resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
$expand:
{
Description: Setting $expand=recommendedactions in url query expands the recommendedactions in the response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of availabilityStatuses. ,
Required: True ,
}
[
{
id:
{
Description: Azure Resource Manager Identity for the availabilityStatuses resource. ,
Required: False ,
}
string ,
name:
{
Description: current. ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.ResourceHealth/AvailabilityStatuses. ,
Required: False ,
}
string ,
location:
{
Description: Azure Resource Manager geo location of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Properties of availability state. ,
Required: False ,
}
{
availabilityState:
{
Description: Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Degraded: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title description of the availability status. ,
Required: False ,
}
string ,
summary:
{
Description: Summary description of the availability status. ,
Required: False ,
}
string ,
detailedStatus:
{
Description: Details of the availability status. ,
Required: False ,
}
string ,
reasonType:
{
Description: When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. ,
Required: False ,
}
string ,
context:
{
Description: When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. ,
Required: False ,
}
string ,
category:
{
Description: When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. ,
Required: False ,
}
string ,
articleId:
{
Description: The Article Id ,
Required: False ,
}
string ,
rootCauseAttributionTime:
{
Description: When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. ,
Format: date-time ,
Required: False ,
}
string ,
healthEventType:
{
Description: In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. ,
Required: False ,
}
string ,
healthEventCause:
{
Description: In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. ,
Required: False ,
}
string ,
healthEventCategory:
{
Description: In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. ,
Required: False ,
}
string ,
healthEventId:
{
Description: It is a unique Id that identifies the event ,
Required: False ,
}
string ,
resolutionETA:
{
Description: When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. ,
Format: date-time ,
Required: False ,
}
string ,
occuredTime:
{
Description: Timestamp for when last change in health status occurred. ,
Format: date-time ,
Required: False ,
}
string ,
reasonChronicity:
{
Description: Chronicity of the availability transition. ,
Enum:
{
Transient: No description available. ,
Persistent: No description available. ,
}
,
Required: False ,
}
enum ,
reportedTime:
{
Description: Timestamp for when the health was last checked. ,
Format: date-time ,
Required: False ,
}
string ,
recentlyResolved:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccuredTime:
{
Description: Timestamp for when the availabilityState changed to Unavailable ,
Format: date-time ,
Required: False ,
}
string ,
resolvedTime:
{
Description: Timestamp when the availabilityState changes to Available. ,
Format: date-time ,
Required: False ,
}
string ,
unavailableSummary:
{
Description: Brief description of cause of the resource becoming unavailable. ,
Required: False ,
}
string ,
}
,
recommendedActions:
{
Description: Lists actions the user can take based on the current availabilityState of the resource. ,
Required: False ,
}
[
{
action:
{
Description: Recommended action. ,
Required: False ,
}
string ,
actionUrl:
{
Description: Link to the action ,
Required: False ,
}
string ,
_ActionUrl.Comment:
{
Description: the comment for the Action ,
Required: False ,
}
string ,
actionUrlText:
{
Description: Substring of action, it describes which text should host the action url. ,
Required: False ,
}
string ,
}
,
]
,
serviceImpactingEvents:
{
Description: Lists the service impacting events that may be affecting the health of the resource. ,
Required: False ,
}
[
{
eventStartTime:
{
Description: Timestamp for when the event started. ,
Format: date-time ,
Required: False ,
}
string ,
eventStatusLastModifiedTime:
{
Description: Timestamp for when event was submitted/detected. ,
Format: date-time ,
Required: False ,
}
string ,
correlationId:
{
Description: Correlation id for the event ,
Required: False ,
}
string ,
status:
{
Description: Status of the service impacting event. ,
Required: False ,
}
{
value:
{
Description: Current status of the event ,
Required: False ,
}
string ,
}
,
incidentProperties:
{
Description: Properties of the service impacting event. ,
Required: False ,
}
{
title:
{
Description: Title of the incident. ,
Required: False ,
}
string ,
service:
{
Description: Service impacted by the event. ,
Required: False ,
}
string ,
region:
{
Description: Region impacted by the event. ,
Required: False ,
}
string ,
incidentType:
{
Description: Type of Event. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
ImpactedResources_ListBySubscriptionIdAndEventId (removed)
Description :  Lists impacted resources in the subscription by an event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of eventImpactedResources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of impacted resource. ,
Required: False ,
}
{
targetResourceType:
{
Description: Resource type within Microsoft cloud. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Identity for resource within Microsoft cloud. ,
Required: False ,
}
string ,
targetRegion:
{
Description: Impacted resource region name. ,
Required: False ,
}
string ,
info:
{
Description: Additional information. ,
Required: False ,
}
[
{
key:
{
Description: Key of tuple. ,
Required: False ,
}
string ,
value:
{
Description: Value of tuple. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of impacted resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
ImpactedResources_Get (removed)
Description :  Gets the specific impacted resource in the subscription by an event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}/impactedResources/{impactedResourceName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
impactedResourceName:
{
Description: Name of the Impacted Resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of impacted resource. ,
Required: False ,
}
{
targetResourceType:
{
Description: Resource type within Microsoft cloud. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Identity for resource within Microsoft cloud. ,
Required: False ,
}
string ,
targetRegion:
{
Description: Impacted resource region name. ,
Required: False ,
}
string ,
info:
{
Description: Additional information. ,
Required: False ,
}
[
{
key:
{
Description: Key of tuple. ,
Required: False ,
}
string ,
value:
{
Description: Value of tuple. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListBySubscriptionId (removed)
Description :  Lists service health events in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Event_GetBySubscriptionIdAndTrackingId (removed)
Description :  Service health event in the subscription by event tracking id
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events/{eventTrackingId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListByTenantId (removed)
Description :  Lists current service health events in the tenant.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/events
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Event_GetByTenantIdAndTrackingId (removed)
Description :  Service health event in the tenant by event tracking id
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ResourceHealth/events/{eventTrackingId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
queryStartTime:
{
Description: Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 ,
Required: False ,
}
string ,
eventTrackingId:
{
Description: Event Id which uniquely identifies ServiceHealth event. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}
Events_ListBySingleResource (removed)
Description :  Lists current service health events for given resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/events
{
resourceUri:
{
Description: 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} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of event. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of event. ,
Required: False ,
}
{
eventType:
{
Description: Type of event. ,
Enum:
{
ServiceIssue: No description available. ,
PlannedMaintenance: No description available. ,
HealthAdvisory: No description available. ,
RCA: No description available. ,
EmergingIssues: No description available. ,
SecurityAdvisory: No description available. ,
}
,
Required: False ,
}
enum ,
eventSource:
{
Description: Source of event. ,
Enum:
{
ResourceHealth: No description available. ,
ServiceHealth: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Current status of event. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: Title text of event. ,
Required: False ,
}
string ,
summary:
{
Description: Summary text of event. ,
Required: False ,
}
string ,
header:
{
Description: Header text of event. ,
Required: False ,
}
string ,
level:
{
Description: Level of insight. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
}
,
Required: False ,
}
enum ,
eventLevel:
{
Description: Level of event. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
externalIncidentId:
{
Description: The id of the Incident ,
Required: False ,
}
string ,
reason:
{
Description: The reason for the Incident ,
Required: False ,
}
string ,
article:
{
Description: Article of event. ,
Required: False ,
}
{
articleContent:
{
Description: Article content of event. ,
Required: False ,
}
string ,
articleId:
{
Description: Article Id ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value ,
Required: False ,
}
object ,
}
,
links:
{
Description: Useful links of event. ,
Required: False ,
}
[
{
type:
{
Description: Type of link. ,
Enum:
{
Button: No description available. ,
Hyperlink: No description available. ,
}
,
Required: False ,
}
enum ,
displayText:
{
Description: Display text of link. ,
Required: False ,
}
{
value:
{
Description: Display text of link. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized display text of link. ,
Required: False ,
}
string ,
}
,
extensionName:
{
Description: It provides the name of portal extension to produce link for given service health event. ,
Required: False ,
}
string ,
bladeName:
{
Description: It provides the name of portal extension blade to produce link for given service health event. ,
Required: False ,
}
string ,
parameters:
{
Description: It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. ,
Required: False ,
}
object ,
}
,
]
,
impactStartTime:
{
Description: It provides the Timestamp for when the health impacting event started. ,
Format: date-time ,
Required: False ,
}
string ,
impactMitigationTime:
{
Description: It provides the Timestamp for when the health impacting event resolved. ,
Format: date-time ,
Required: False ,
}
string ,
impact:
{
Description: List services impacted by the service health event. ,
Required: False ,
}
[
{
impactedService:
{
Description: Impacted service name. ,
Required: False ,
}
string ,
impactedRegions:
{
Description: List regions impacted by the service health event. ,
Required: False ,
}
[
{
impactedRegion:
{
Description: Impacted region name. ,
Required: False ,
}
string ,
status:
{
Description: Current status of event in the region. ,
Enum:
{
Active: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
impactedSubscriptions:
{
Description: List subscription impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
impactedTenants:
{
Description: List tenant impacted by the service health event. ,
Required: False ,
}
[
string ,
]
,
lastUpdateTime:
{
Description: It provides the Timestamp for when the last update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
updates:
{
Description: List of updates for given service health event. ,
Required: False ,
}
[
{
summary:
{
Description: Summary text for the given update for the service health event. ,
Required: False ,
}
string ,
updateDateTime:
{
Description: It provides the Timestamp for the given update for the service health event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
recommendedActions:
{
Description: Recommended actions of event. ,
Required: False ,
}
{
message:
{
Description: Recommended action title for the service health event. ,
Required: False ,
}
string ,
actions:
{
Description: Recommended actions for the service health event. ,
Required: False ,
}
[
{
groupId:
{
Description: Recommended action group Id for the service health event. ,
Format: int32 ,
Required: False ,
}
integer ,
actionText:
{
Description: Recommended action text ,
Required: False ,
}
string ,
}
,
]
,
localeCode:
{
Description: Recommended action locale for the service health event. ,
Required: False ,
}
string ,
}
,
faqs:
{
Description: Frequently asked questions for the service health event. ,
Required: False ,
}
[
{
question:
{
Description: FAQ question for the service health event. ,
Required: False ,
}
string ,
answer:
{
Description: FAQ answer for the service health event. ,
Required: False ,
}
string ,
localeCode:
{
Description: FAQ locale for the service health event. ,
Required: False ,
}
string ,
}
,
]
,
isHIR:
{
Description: It provides information if the event is High incident rate event or not. ,
Required: False ,
}
boolean ,
enableMicrosoftSupport:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
description:
{
Description: Contains the communication message for the event, that could include summary, root cause and other details. ,
Required: False ,
}
string ,
platformInitiated:
{
Description: Is true if the event is platform initiated. ,
Required: False ,
}
boolean ,
enableChatWithUs:
{
Description: Tells if we want to enable or disable Microsoft Support for this event. ,
Required: False ,
}
boolean ,
priority:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdateTime:
{
Description: It provides the Timestamp for when the health impacting event was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
hirStage:
{
Description: Stage for HIR Document ,
Required: False ,
}
string ,
additionalInformation:
{
Description: Additional information ,
Required: False ,
}
{
message:
{
Description: Additional information Message ,
Required: False ,
}
string ,
}
,
duration:
{
Description: duration in seconds ,
Format: int32 ,
Required: False ,
}
integer ,
impactType:
{
Description: The type of the impact ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
string ,
}