metric_alerts_status
Creates, updates, deletes, gets or lists a metric_alerts_status resource.
Overview
| Name | metric_alerts_status |
| Type | Resource |
| Id | azure.monitor.metric_alerts_status |
Fields
The following fields are returned by SELECT queries:
- list_by_name
- list
| Name | Datatype | Description |
|---|---|---|
id | string | The alert rule arm id. |
name | string | The status name. |
dimensions | object | An object describing the type of the dimensions. |
status | string | Status value. |
timestamp | string (date-time) | UTC time when the status was checked. |
type | string | The extended resource type name. |
| Name | Datatype | Description |
|---|---|---|
id | string | The alert rule arm id. |
name | string | The status name. |
dimensions | object | An object describing the type of the dimensions. |
status | string | Status value. |
timestamp | string (date-time) | UTC time when the status was checked. |
type | string | The extended resource type name. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_name | select | resource_group_name, rule_name, status_name, subscription_id | Retrieve an alert rule status. | |
list | select | resource_group_name, rule_name, subscription_id | Retrieve an alert rule status. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
rule_name | string | The name of the rule. Required. |
status_name | string | The name of the status. Required. |
subscription_id | string |
SELECT examples
- list_by_name
- list
Retrieve an alert rule status.
SELECT
id,
name,
dimensions,
status,
timestamp,
type
FROM azure.monitor.metric_alerts_status
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND status_name = '{{ status_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;
Retrieve an alert rule status.
SELECT
id,
name,
dimensions,
status,
timestamp,
type
FROM azure.monitor.metric_alerts_status
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;