Microsoft.ResourceHealth (stable:2015-01-01)

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

AvailabilityStatuses_ListBySubscriptionId (new)
Description :  Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
api-version:
{
Description: Client Api Version. ,
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: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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. Use the nextLink property in the response to get the next page of availability statuses.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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_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: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 the historical availability statuses for a single resource. Use the nextLink property in the response to get the next page of availability status
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: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildAvailabilityStatuses_GetByResource (new)
Description :  Gets current availability status for a single resource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildAvailabilityStatuses_List (new)
Description :  Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildResources_List (new)
Description :  Lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childResources
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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: Client Api Version. ,
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_ListBySubscriptionId (removed)
Description :  Lists the current availability status for all the resources in the subscription. Use the nextLink property in the response to get the next page of availability statuses.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
api-version:
{
Description: Client Api Version. ,
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: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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. Use the nextLink property in the response to get the next page of availability statuses.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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_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: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 the historical availability statuses for a single resource. Use the nextLink property in the response to get the next page of availability status
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: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildAvailabilityStatuses_GetByResource (removed)
Description :  Gets current availability status for a single resource
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildAvailabilityStatuses_List (removed)
Description :  Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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 ,
}
ChildResources_List (removed)
Description :  Lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.ResourceHealth/childResources
{
resourceUri:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
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. ,
Enum:
{
Available: No description available. ,
Unavailable: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
summary:
{
Description: Summary description of the availability state. ,
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 ,
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 ,
isArmResource:
{
Description: flag to show if child resource need detail health. ,
Required: False ,
}
boolean ,
recentlyResolvedState:
{
Description: An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned ,
Required: False ,
}
{
unavailableOccurredTime:
{
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 ,
unavailabilitySummary:
{
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: Client Api Version. ,
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 ,
}