Metric Alerts - List By Subscription

Service:

Monitor

API Version:

2018-03-01

Recuperar definiciones de reglas de alerta en una suscripción.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	MetricAlertResourceCollection	Solicitud correcta para obtener una lista de alertas de métricas
Other Status Codes	ErrorResponse	BadRequest

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

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"
            }
          }
        ]
      }
    }
  ]
}

Definiciones

Nombre	Description
AggregationTypeEnum	los tipos de agregación de hora de criterios.
DynamicMetricCriteria	Criterio para el umbral dinámico.
DynamicThresholdFailingPeriods	El número mínimo de infracciones necesarias en la ventana de tiempo de devolución de búsqueda seleccionada necesaria para generar una alerta.
DynamicThresholdOperator	Operador que se usa para comparar el valor de la métrica con respecto al umbral.
DynamicThresholdSensitivity	La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la reducción del umbral al patrón de serie de métricas.
ErrorResponse	Describe el formato de respuesta de error.
MetricAlertAction	Una acción de alerta.
MetricAlertMultipleResourceMultipleMetricCriteria	Especifica los criterios de alerta de métrica para varios recursos que tienen varios criterios de métrica.
MetricAlertResource	Recurso de alerta de métrica.
MetricAlertResourceCollection	Representa una colección de recursos de regla de alertas.
MetricAlertSingleResourceMultipleMetricCriteria	Especifica los criterios de alerta de métrica para un único recurso que tiene varios criterios de métrica.
MetricCriteria	Criterio para filtrar las métricas.
MetricDimension	Especifica una dimensión de métrica.
Operator	operador criteria.
WebtestLocationAvailabilityCriteria	Especifica los criterios de regla de alertas de métricas para un recurso de prueba web.

AggregationTypeEnum

los tipos de agregación de hora de criterios.

Nombre	Tipo	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

Criterio para el umbral dinámico.

Nombre	Tipo	Description
alertSensitivity	DynamicThresholdSensitivity	La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la reducción del umbral al patrón de serie de métricas.
criterionType	string: DynamicThresholdCriterion	Especifica el tipo de criterios de umbral.
dimensions	MetricDimension[]	Lista de condiciones de dimensión.
failingPeriods	DynamicThresholdFailingPeriods	El número mínimo de infracciones necesarias en la ventana de tiempo de devolución de búsqueda seleccionada necesaria para generar una alerta.
ignoreDataBefore	string	Use esta opción para establecer la fecha desde la que empezar a aprender los datos históricos de métricas y calcular los umbrales dinámicos (en ISO8601 formato)
metricName	string	el nombre de la métrica.
metricNamespace	string	Espacio de nombres de la métrica.
name	string	Nombre de los criterios.
operator	DynamicThresholdOperator	Operador que se usa para comparar el valor de la métrica con respecto al umbral.
skipMetricValidation	boolean	Permite crear una regla de alertas sobre una métrica personalizada que todavía no se ha emitido mediante la omisión de la validación de métricas.
timeAggregation	AggregationTypeEnum	los tipos de agregación de hora de criterios.

DynamicThresholdFailingPeriods

El número mínimo de infracciones necesarias en la ventana de tiempo de devolución de búsqueda seleccionada necesaria para generar una alerta.

Nombre	Tipo	Description
minFailingPeriodsToAlert	number	Número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Número de puntos de búsqueda agregados. La ventana de tiempo de búsqueda se calcula en función de la granularidad de agregación (windowSize) y el número seleccionado de puntos agregados.

DynamicThresholdOperator

Operador que se usa para comparar el valor de la métrica con respecto al umbral.

Nombre	Tipo	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la reducción del umbral al patrón de serie de métricas.

Nombre	Tipo	Description
High	string
Low	string
Medium	string

ErrorResponse

Describe el formato de respuesta de error.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

MetricAlertAction

Una acción de alerta.

Nombre	Tipo	Description
actionGroupId	string	el identificador del grupo de acciones que se va a usar.
webHookProperties	object	Este campo permite especificar propiedades personalizadas, que se anexarían a la carga de alerta enviada como entrada al webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Especifica los criterios de alerta de métrica para varios recursos que tienen varios criterios de métrica.

Nombre	Tipo	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	la lista de varios criterios de métricas para esta operación "todo".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	especifica el tipo de los criterios de alerta.

MetricAlertResource

Recurso de alerta de métrica.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
location	string	Ubicación de los recursos
name	string	Nombre de recurso de Azure
properties.actions	MetricAlertAction[]	matriz de acciones que se realizan cuando la regla de alertas se activa y cuando se resuelve una condición de alerta.
properties.autoMitigate	boolean	marca que indica si la alerta debe resolverse automáticamente o no. El valor predeterminado es true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	define la información de criterios de alerta específica.
properties.description	string	la descripción de la alerta de métrica que se incluirá en el correo electrónico de alerta.
properties.enabled	boolean	marca que indica si la alerta de métrica está habilitada.
properties.evaluationFrequency	string	la frecuencia con la que se evalúa la alerta de métrica en formato de duración ISO 8601.
properties.isMigrated	boolean	valor que indica si se migra esta regla de alertas.
properties.lastUpdatedTime	string	Última vez que la regla se actualizó en ISO8601 formato.
properties.scopes	string[]	la lista de identificadores de recurso a la que se limita esta alerta de métrica.
properties.severity	integer	Gravedad de alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	la región de los recursos de destino en la que se crea o actualiza la alerta. Obligatorio si el ámbito contiene una suscripción, un grupo de recursos o más de un recurso.
properties.targetResourceType	string	el tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Obligatorio si el ámbito contiene una suscripción, un grupo de recursos o más de un recurso.
properties.windowSize	string	el período de tiempo (en formato de duración ISO 8601) que se usa para supervisar la actividad de alertas en función del umbral.
tags	object	Etiquetas del recurso
type	string	Tipo de recurso de Azure

MetricAlertResourceCollection

Representa una colección de recursos de regla de alertas.

Nombre	Tipo	Description
value	MetricAlertResource[]	los valores de los recursos de la regla de alertas.

MetricAlertSingleResourceMultipleMetricCriteria

Especifica los criterios de alerta de métrica para un único recurso que tiene varios criterios de métrica.

Nombre	Tipo	Description
allOf	MetricCriteria[]	Lista de criterios de métrica para esta operación "todo".
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	especifica el tipo de los criterios de alerta.

MetricCriteria

Criterio para filtrar las métricas.

Nombre	Tipo	Description
criterionType	string: StaticThresholdCriterion	Especifica el tipo de criterios de umbral.
dimensions	MetricDimension[]	Lista de condiciones de dimensión.
metricName	string	el nombre de la métrica.
metricNamespace	string	Espacio de nombres de la métrica.
name	string	Nombre de los criterios.
operator	Operator	operador criteria.
skipMetricValidation	boolean	Permite crear una regla de alertas sobre una métrica personalizada que todavía no se ha emitido mediante la omisión de la validación de métricas.
threshold	number	el valor de umbral de criterios que activa la alerta.
timeAggregation	AggregationTypeEnum	los tipos de agregación de hora de criterios.

MetricDimension

Especifica una dimensión de métrica.

Nombre	Tipo	Description
name	string	Nombre de la dimensión.
operator	string	operador de dimensión. Solo se admiten 'Include' y 'Exclude'
values	string[]	lista de valores de dimensión.

Operator

operador criteria.

Nombre	Tipo	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Especifica los criterios de regla de alertas de métricas para un recurso de prueba web.

Nombre	Tipo	Description
componentId	string	Identificador de recurso de Application Insights.
failedLocationCount	number	Número de ubicaciones con errores.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	especifica el tipo de los criterios de alerta.
webTestId	string	Identificador de prueba web de Application Insights.