Metric Alerts - List By Subscription

Service:

Monitor

API Version:

2018-03-01

Retrieve alert rule definitions in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	MetricAlertResourceCollection	Successful request for a list of metric alerts
Other Status Codes	ErrorResponse	BadRequest

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List metric alert rules

Sample request

HTTP

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/providers/Microsoft.Insights/metricAlerts?api-version=2018-03-01

Java

/**
 * Samples for MetricAlerts ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
     */
    /**
     * Sample code: List metric alert rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listMetricAlertRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts().listByResourceGroup("gigtest",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
func ExampleMetricAlertsClient_NewListBySubscriptionPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewMetricAlertsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MetricAlertResourceCollection = armmonitor.MetricAlertResourceCollection{
		// 	Value: []*armmonitor.MetricAlertResource{
		// 		{
		// 			Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 			ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu"),
		// 			Location: to.Ptr("global"),
		// 			Tags: map[string]*string{
		// 				"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
		// 			},
		// 			Properties: &armmonitor.MetricAlertProperties{
		// 				Description: to.Ptr("This is the description of the rule1"),
		// 				Actions: []*armmonitor.MetricAlertAction{
		// 					{
		// 						ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
		// 						WebHookProperties: map[string]*string{
		// 							"key11": to.Ptr("value11"),
		// 							"key12": to.Ptr("value12"),
		// 						},
		// 				}},
		// 				Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
		// 					ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
		// 					AllOf: []*armmonitor.MetricCriteria{
		// 						{
		// 							Name: to.Ptr("High_CPU_80"),
		// 							CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
		// 							Dimensions: []*armmonitor.MetricDimension{
		// 							},
		// 							MetricName: to.Ptr("CustomMetric_\\Processor(_Total)\\% Processor Time"),
		// 							TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
		// 							Operator: to.Ptr(armmonitor.OperatorGreaterThan),
		// 							Threshold: to.Ptr[float64](80.5),
		// 					}},
		// 				},
		// 				Enabled: to.Ptr(true),
		// 				EvaluationFrequency: to.Ptr("Pt1m"),
		// 				Scopes: []*string{
		// 					to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
		// 					Severity: to.Ptr[int32](3),
		// 					WindowSize: to.Ptr("Pt15m"),
		// 				},
		// 			},
		// 			{
		// 				Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 				ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu"),
		// 				Location: to.Ptr("global"),
		// 				Tags: map[string]*string{
		// 					"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
		// 				},
		// 				Properties: &armmonitor.MetricAlertProperties{
		// 					Description: to.Ptr("Med cpu alert"),
		// 					Actions: []*armmonitor.MetricAlertAction{
		// 						{
		// 							ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
		// 							WebHookProperties: map[string]*string{
		// 								"key11": to.Ptr("value11"),
		// 								"key12": to.Ptr("value12"),
		// 							},
		// 					}},
		// 					Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
		// 						ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
		// 						AllOf: []*armmonitor.MetricCriteria{
		// 							{
		// 								Name: to.Ptr("Medium_CPU_50"),
		// 								CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
		// 								Dimensions: []*armmonitor.MetricDimension{
		// 								},
		// 								MetricName: to.Ptr("CustomMetric_\\Processor(_Total)\\% Processor Time"),
		// 								TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
		// 								Operator: to.Ptr(armmonitor.OperatorGreaterThan),
		// 								Threshold: to.Ptr[float64](50.5),
		// 						}},
		// 					},
		// 					Enabled: to.Ptr(true),
		// 					EvaluationFrequency: to.Ptr("Pt1m"),
		// 					Scopes: []*string{
		// 						to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
		// 						Severity: to.Ptr[int32](4),
		// 						WindowSize: to.Ptr("Pt15m"),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieve alert rule definitions in a subscription.
 *
 * @summary Retrieve alert rule definitions in a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
 */
async function listMetricAlertRules() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.metricAlerts.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
// this example is just showing the usage of "MetricAlerts_ListBySubscription" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (MetricAlertResource item in subscriptionResource.GetMetricAlertsAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    MetricAlertData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "This is the description of the rule1",
        "severity": 3,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "High_CPU_80",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "type": "Microsoft.Insights/metricAlerts",
      "location": "global",
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      },
      "properties": {
        "description": "Med cpu alert",
        "severity": 4,
        "enabled": true,
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "evaluationFrequency": "Pt1m",
        "windowSize": "Pt15m",
        "criteria": {
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
          "allOf": [
            {
              "criterionType": "StaticThresholdCriterion",
              "name": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AggregationTypeEnum	the criteria time aggregation types.
DynamicMetricCriteria	Criterion for dynamic threshold.
DynamicThresholdFailingPeriods	The minimum number of violations required within the selected lookback time window required to raise an alert.
DynamicThresholdOperator	The operator used to compare the metric value against the threshold.
DynamicThresholdSensitivity	The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
ErrorResponse	Describes the format of Error response.
MetricAlertAction	An alert action.
MetricAlertMultipleResourceMultipleMetricCriteria	Specifies the metric alert criteria for multiple resource that has multiple metric criteria.
MetricAlertResource	The metric alert resource.
MetricAlertResourceCollection	Represents a collection of alert rule resources.
MetricAlertSingleResourceMultipleMetricCriteria	Specifies the metric alert criteria for a single resource that has multiple metric criteria.
MetricCriteria	Criterion to filter metrics.
MetricDimension	Specifies a metric dimension.
Operator	the criteria operator.
WebtestLocationAvailabilityCriteria	Specifies the metric alert rule criteria for a web test resource.

AggregationTypeEnum

the criteria time aggregation types.

Name	Type	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

Criterion for dynamic threshold.

Name	Type	Description
alertSensitivity	DynamicThresholdSensitivity	The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.
criterionType	string: DynamicThresholdCriterion	Specifies the type of threshold criteria
dimensions	MetricDimension[]	List of dimension conditions.
failingPeriods	DynamicThresholdFailingPeriods	The minimum number of violations required within the selected lookback time window required to raise an alert.
ignoreDataBefore	string	Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format)
metricName	string	Name of the metric.
metricNamespace	string	Namespace of the metric.
name	string	Name of the criteria.
operator	DynamicThresholdOperator	The operator used to compare the metric value against the threshold.
skipMetricValidation	boolean	Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped.
timeAggregation	AggregationTypeEnum	the criteria time aggregation types.

DynamicThresholdFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert.

Name	Type	Description
minFailingPeriodsToAlert	number	The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points.

DynamicThresholdOperator

The operator used to compare the metric value against the threshold.

Name	Type	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern.

Name	Type	Description
High	string
Low	string
Medium	string

ErrorResponse

Describes the format of Error response.

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

MetricAlertAction

An alert action.

Name	Type	Description
actionGroupId	string	the id of the action group to use.
webHookProperties	object	This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Specifies the metric alert criteria for multiple resource that has multiple metric criteria.

Name	Type	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	the list of multiple metric criteria for this 'all of' operation.
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	specifies the type of the alert criteria.

MetricAlertResource

The metric alert resource.

Name	Type	Description
id	string	Azure resource Id
location	string	Resource location
name	string	Azure resource name
properties.actions	MetricAlertAction[]	the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
properties.autoMitigate	boolean	the flag that indicates whether the alert should be auto resolved or not. The default is true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	defines the specific alert criteria information.
properties.description	string	the description of the metric alert that will be included in the alert email.
properties.enabled	boolean	the flag that indicates whether the metric alert is enabled.
properties.evaluationFrequency	string	how often the metric alert is evaluated represented in ISO 8601 duration format.
properties.isMigrated	boolean	the value indicating whether this alert rule is migrated.
properties.lastUpdatedTime	string	Last time the rule was updated in ISO8601 format.
properties.scopes	string[]	the list of resource id's that this metric alert is scoped to.
properties.severity	integer	Alert severity {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
properties.targetResourceType	string	the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource.
properties.windowSize	string	the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold.
tags	object	Resource tags
type	string	Azure resource type

MetricAlertResourceCollection

Represents a collection of alert rule resources.

Name	Type	Description
value	MetricAlertResource[]	the values for the alert rule resources.

MetricAlertSingleResourceMultipleMetricCriteria

Specifies the metric alert criteria for a single resource that has multiple metric criteria.

Name	Type	Description
allOf	MetricCriteria[]	The list of metric criteria for this 'all of' operation.
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	specifies the type of the alert criteria.

MetricCriteria

Criterion to filter metrics.

Name	Type	Description
criterionType	string: StaticThresholdCriterion	Specifies the type of threshold criteria
dimensions	MetricDimension[]	List of dimension conditions.
metricName	string	Name of the metric.
metricNamespace	string	Namespace of the metric.
name	string	Name of the criteria.
operator	Operator	the criteria operator.
skipMetricValidation	boolean	Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped.
threshold	number	the criteria threshold value that activates the alert.
timeAggregation	AggregationTypeEnum	the criteria time aggregation types.

MetricDimension

Specifies a metric dimension.

Name	Type	Description
name	string	Name of the dimension.
operator	string	the dimension operator. Only 'Include' and 'Exclude' are supported
values	string[]	list of dimension values.

Operator

the criteria operator.

Name	Type	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Specifies the metric alert rule criteria for a web test resource.

Name	Type	Description
componentId	string	The Application Insights resource Id.
failedLocationCount	number	The number of failed locations.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	specifies the type of the alert criteria.
webTestId	string	The Application Insights web test Id.