Get Alert Rule Incident
The Get Alert Rule Incident operation retrieves information about an incident of an alert rule.
Request
The Get Alert Rule Incident request may be specified as follows. Replace <subscription-id> with the subscription ID and <incident-id> with the identifier of the alert rule incident. You can obtain the identifier of an alert rule by using List Alert Rule Incidents.
Method |
Request URI |
---|---|
GET |
https://management.core.windows.net/<subscription-id>/services/monitoring/alertincidents/<incident-id> HYPERLINK "https://monitoring.management.core.windows.net/%3csubscription-id%3e/services/monitoring/alert/rules" |
You must make sure that the request that is made to the management service is secure. For additional details, see Authenticating Service Management Requests.
URI Parameters
None.
Request Headers
The following table describes the request headers.
Request Header |
Description |
---|---|
Accept |
Required. Set this header to application/json. |
x-ms-version |
Required. Specifies the version of the operation to use for this request. This header must be set to 2013-10-01 or higher. For more information about versioning headers, see Service Management Versioning. |
Request Body
None.
Response
The response includes an HTTP status code, a set of response headers, and a response body.
Status Code
A successful operation returns status code 200 (OK). For information about status codes, see Service Management Status and Error Codes.
Response Headers
The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.
Response Header |
Description |
---|---|
x-ms-request-id |
A value that uniquely identifies a request made against the management service. |
Response Body
The format of the response body is as follows:
{
"Id": "<identifier-of-alert-rule-incident>",
"RuleId": "<identifier-of-alert-rule>",
"IsActive": "<status-of-alert-rule-incident>",
"ActivatedTime": "<time-of-alert-rule-activation>",
"ResolvedTime": "<time-of-alert-rule-resolution>",
}
The following table describes the elements of the response body.
Element Name |
Description |
Id |
Specifies the identifier for the alert rule incident. |
RuleId |
Specifies the identifier of the alert rule. |
IsActive |
Indicates whether the alert rule incident is active. Possible values are:
This value is null if the alert rule incident is resolved. |
ActivatedTime |
Specifies the time that the alert rule incident was activated. |
ResolvedTime |
Specifies the time that the alert rule incident was resolved. This value can be null if the alert rule incident is active. |
Remarks
You can also use the classic portal to see the alert rules that are defined. For more information, see How to: Receive Alert Notifications and Manage Alert Rules in Azure.