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
Successful request for a list of metric alerts
| Name | Datatype | Description |
|---|---|---|
id | string | The alert rule arm id. |
name | string | The status name. |
properties | object | The alert status properties of the metric alert status. |
type | string | The extended resource type name. |
Successful request for a list of metric alerts
| Name | Datatype | Description |
|---|---|---|
id | string | The alert rule arm id. |
name | string | The status name. |
properties | object | The alert status properties of the metric alert status. |
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 | subscriptionId, resourceGroupName, ruleName, statusName | Retrieve an alert rule status. | |
list | select | subscriptionId, resourceGroupName, ruleName | 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 |
|---|---|---|
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
ruleName | string | The name of the rule. |
statusName | string | The name of the status. |
subscriptionId | string | The ID of the target subscription. |
SELECT examples
- list_by_name
- list
Retrieve an alert rule status.
SELECT
id,
name,
properties,
type
FROM azure.monitor.metric_alerts_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND statusName = '{{ statusName }}' -- required
;
Retrieve an alert rule status.
SELECT
id,
name,
properties,
type
FROM azure.monitor.metric_alerts_status
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
;