Metric Alerts - List By Subscription

Service:

Monitor

API Version:

2018-03-01

Récupérer les définitions de règle d’alerte dans un abonnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	MetricAlertResourceCollection	Demande réussie d’une liste d’alertes de métriques
Other Status Codes	ErrorResponse	BadRequest

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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 List.
 */
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().list(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 System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Monitor;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;

// 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_ListByResourceGroup" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this MetricAlertResource
MetricAlertCollection collection = resourceGroupResource.GetMetricAlerts();

// invoke the operation and iterate over the result
await foreach (MetricAlertResource item in collection.GetAllAsync())
{
    // 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"
            }
          }
        ]
      }
    }
  ]
}

Définitions

Nom	Description
AggregationTypeEnum	les types d’agrégation de temps de critères.
DynamicMetricCriteria	Critère de seuil dynamique.
DynamicThresholdFailingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.
DynamicThresholdOperator	Opérateur utilisé pour comparer la valeur de la métrique au seuil.
DynamicThresholdSensitivity	Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques.
ErrorResponse	Décrit le format de la réponse d’erreur.
MetricAlertAction	Action d’alerte.
MetricAlertMultipleResourceMultipleMetricCriteria	Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.
MetricAlertResource	Ressource d’alerte de métrique.
MetricAlertResourceCollection	Représente une collection de ressources de règle d’alerte.
MetricAlertSingleResourceMultipleMetricCriteria	Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.
MetricCriteria	Critère pour filtrer les métriques.
MetricDimension	Spécifie une dimension de métrique.
Operator	opérateur de critères.
WebtestLocationAvailabilityCriteria	Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

AggregationTypeEnum

les types d’agrégation de temps de critères.

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

DynamicMetricCriteria

Critère de seuil dynamique.

Nom	Type	Description
alertSensitivity	DynamicThresholdSensitivity	Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques.
criterionType	string: DynamicThresholdCriterion	Spécifie le type de critères de seuil
dimensions	MetricDimension[]	Liste des conditions de dimension.
failingPeriods	DynamicThresholdFailingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.
ignoreDataBefore	string	Utilisez cette option pour définir la date à partir de laquelle commencer l’apprentissage des données historiques de métriques et calculer les seuils dynamiques (au format ISO8601)
metricName	string	nom attribué à la métrique.
metricNamespace	string	Espace de noms de la métrique.
name	string	Nom des critères.
operator	DynamicThresholdOperator	Opérateur utilisé pour comparer la valeur de la métrique au seuil.
skipMetricValidation	boolean	Permet la création d’une règle d’alerte pour une métrique personnalisée qui n’a pas encore été émise, car l’étape de validation de la métrique a été ignorée.
timeAggregation	AggregationTypeEnum	les types d’agrégation de temps de critères.

DynamicThresholdFailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée pour déclencher une alerte.

Nom	Type	Description
minFailingPeriodsToAlert	number	Nombre de violations à déclencher une alerte. Doit être plus petit ou égal à numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Nombre de points de recherche en arrière agrégés. La fenêtre de temps de recherche en arrière est calculée en fonction de la granularité d’agrégation (windowSize) et du nombre sélectionné de points agrégés.

DynamicThresholdOperator

Opérateur utilisé pour comparer la valeur de la métrique au seuil.

Nom	Type	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

Étendue de l’écart nécessaire pour déclencher une alerte. Cela affectera la limite du seuil au modèle de série de métriques.

Nom	Type	Description
High	string
Low	string
Medium	string

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom	Type	Description
code	string	Code d'erreur
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

MetricAlertAction

Action d’alerte.

Nom	Type	Description
actionGroupId	string	ID du groupe d’actions à utiliser.
webHookProperties	object	Ce champ permet de spécifier des propriétés personnalisées, qui seraient ajoutées à la charge utile d’alerte envoyée en tant qu’entrée au webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.

Nom	Type	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	liste de plusieurs critères de métrique pour cette opération « all of ».
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	spécifie le type des critères d’alerte.

MetricAlertResource

Ressource d’alerte de métrique.

Nom	Type	Description
id	string	ID de ressource Azure
location	string	Emplacement de la ressource
name	string	Nom de la ressource Azure
properties.actions	MetricAlertAction[]	tableau d’actions qui sont effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.autoMitigate	boolean	Indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	définit les informations sur les critères d’alerte spécifiques.
properties.description	string	description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.
properties.enabled	boolean	Indicateur qui indique si l’alerte de métrique est activée.
properties.evaluationFrequency	string	la fréquence à laquelle l’alerte de métrique est évaluée représentée au format de durée ISO 8601.
properties.isMigrated	boolean	valeur indiquant si cette règle d’alerte est migrée.
properties.lastUpdatedTime	string	La dernière fois que la règle a été mise à jour dans ISO8601 format.
properties.scopes	string[]	liste des ID de ressource auxquels cette alerte de métrique est délimitée.
properties.severity	integer	Gravité de l’alerte {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	région de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.
properties.targetResourceType	string	type de ressource de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.
properties.windowSize	string	la période (au format de durée ISO 8601) utilisée pour surveiller l’activité des alertes en fonction du seuil.
tags	object	Balises de ressource
type	string	Type de ressource Azure

MetricAlertResourceCollection

Représente une collection de ressources de règle d’alerte.

Nom	Type	Description
value	MetricAlertResource[]	valeurs des ressources de la règle d’alerte.

MetricAlertSingleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.

Nom	Type	Description
allOf	MetricCriteria[]	Liste des critères de métrique pour cette opération « all of ».
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	spécifie le type des critères d’alerte.

MetricCriteria

Critère pour filtrer les métriques.

Nom	Type	Description
criterionType	string: StaticThresholdCriterion	Spécifie le type de critères de seuil
dimensions	MetricDimension[]	Liste des conditions de dimension.
metricName	string	nom attribué à la métrique.
metricNamespace	string	Espace de noms de la métrique.
name	string	Nom des critères.
operator	Operator	opérateur de critères.
skipMetricValidation	boolean	Permet la création d’une règle d’alerte pour une métrique personnalisée qui n’a pas encore été émise, car l’étape de validation de la métrique a été ignorée.
threshold	number	valeur de seuil de critère qui active l’alerte.
timeAggregation	AggregationTypeEnum	les types d’agrégation de temps de critères.

MetricDimension

Spécifie une dimension de métrique.

Nom	Type	Description
name	string	Nom de la dimension.
operator	string	opérateur de dimension. Seuls « Include » et « Exclude » sont pris en charge
values	string[]	liste de valeurs de dimension.

Operator

opérateur de critères.

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

WebtestLocationAvailabilityCriteria

Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

Nom	Type	Description
componentId	string	ID de ressource Application Insights.
failedLocationCount	number	Nombre d’emplacements ayant échoué.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	spécifie le type des critères d’alerte.
webTestId	string	ID de test web Application Insights.