Metric Alerts - List By Resource Group

Service:

Monitor

API Version:

2018-03-01

Recuperar definições de regra de alerta em um grupo de recursos.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	MetricAlertResourceCollection	Solicitação bem-sucedida para uma lista de alertas de métrica
Other Status Codes	ErrorResponse	BadRequest

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List metric alert rules

Sample Request

HTTP

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/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"
            }
          }
        ]
      }
    }
  ]
}

Definições

Nome	Description
AggregationTypeEnum	os tipos de agregação de tempo de critérios.
DynamicMetricCriteria	Critério para limite dinâmico.
DynamicThresholdFailingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.
DynamicThresholdOperator	O operador usado para comparar o valor da métrica com o limite.
DynamicThresholdSensitivity	A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas.
ErrorResponse	Descreve o formato da resposta de erro.
MetricAlertAction	Uma ação de alerta.
MetricAlertMultipleResourceMultipleMetricCriteria	Especifica os critérios de alerta de métrica para vários recursos que têm vários critérios de métrica.
MetricAlertResource	O recurso de alerta de métrica.
MetricAlertResourceCollection	Representa uma coleção de recursos de regra de alerta.
MetricAlertSingleResourceMultipleMetricCriteria	Especifica os critérios de alerta de métrica para um único recurso que tem vários critérios de métrica.
MetricCriteria	Critério para filtrar métricas.
MetricDimension	Especifica uma dimensão de métrica.
Operator	o operador criteria.
WebtestLocationAvailabilityCriteria	Especifica os critérios de regra de alerta de métrica para um recurso de teste da Web.

AggregationTypeEnum

os tipos de agregação de tempo de critérios.

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

DynamicMetricCriteria

Critério para limite dinâmico.

Nome	Tipo	Description
alertSensitivity	DynamicThresholdSensitivity	A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas.
criterionType	string: DynamicThresholdCriterion	Especifica o tipo de critérios de limite
dimensions	MetricDimension[]	Lista de condições de dimensão.
failingPeriods	DynamicThresholdFailingPeriods	O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.
ignoreDataBefore	string	Use essa opção para definir a data da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601)
metricName	string	Nome da métrica.
metricNamespace	string	Namespace da métrica.
name	string	Nome dos critérios.
operator	DynamicThresholdOperator	O operador usado para comparar o valor da métrica com o limite.
skipMetricValidation	boolean	Permite criar uma regra de alerta em uma métrica personalizada que ainda não foi emitida, fazendo com que a validação da métrica seja ignorada.
timeAggregation	AggregationTypeEnum	os tipos de agregação de tempo de critérios.

DynamicThresholdFailingPeriods

O número mínimo de violações necessárias na janela de tempo de pesquisa selecionada necessária para gerar um alerta.

Nome	Tipo	Description
minFailingPeriodsToAlert	number	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	O número de pontos de pesquisa agregados. A janela de tempo de pesquisa é calculada com base na granularidade de agregação (windowSize) e no número selecionado de pontos agregados.

DynamicThresholdOperator

O operador usado para comparar o valor da métrica com o limite.

Nome	Tipo	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

A extensão do desvio necessária para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão da série de métricas.

Nome	Tipo	Description
High	string
Low	string
Medium	string

ErrorResponse

Descreve o formato da resposta de erro.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

MetricAlertAction

Uma ação de alerta.

Nome	Tipo	Description
actionGroupId	string	a ID do grupo de ações a ser usado.
webHookProperties	object	Esse campo permite especificar propriedades personalizadas, que seriam acrescentadas à carga de alerta enviada como entrada para o webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Especifica os critérios de alerta de métrica para vários recursos que têm vários critérios de métrica.

Nome	Tipo	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	a lista de vários critérios de métrica para essa operação "tudo".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	especifica o tipo dos critérios de alerta.

MetricAlertResource

O recurso de alerta de métrica.

Nome	Tipo	Description
id	string	ID do recurso do Azure
location	string	Localização do recurso
name	string	Nome do recurso do Azure
properties.actions	MetricAlertAction[]	a matriz de ações executadas quando a regra de alerta se torna ativa e quando uma condição de alerta é resolvida.
properties.autoMitigate	boolean	o sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	define as informações específicas de critérios de alerta.
properties.description	string	a descrição do alerta de métrica que será incluído no email de alerta.
properties.enabled	boolean	o sinalizador que indica se o alerta de métrica está habilitado.
properties.evaluationFrequency	string	com que frequência o alerta de métrica é avaliado representado no formato de duração ISO 8601.
properties.isMigrated	boolean	o valor que indica se essa regra de alerta é migrada.
properties.lastUpdatedTime	string	Da última vez que a regra foi atualizada no formato ISO8601.
properties.scopes	string[]	a lista de IDs de recurso para a qual esse alerta de métrica está no escopo.
properties.severity	integer	Gravidade do alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	a região dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso.
properties.targetResourceType	string	o tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, um grupo de recursos ou mais de um recurso.
properties.windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.
tags	object	Marcações de recursos
type	string	Tipo de recurso do Azure

MetricAlertResourceCollection

Representa uma coleção de recursos de regra de alerta.

Nome	Tipo	Description
value	MetricAlertResource[]	os valores dos recursos da regra de alerta.

MetricAlertSingleResourceMultipleMetricCriteria

Especifica os critérios de alerta de métrica para um único recurso que tem vários critérios de métrica.

Nome	Tipo	Description
allOf	MetricCriteria[]	A lista de critérios de métrica para essa operação "tudo".
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	especifica o tipo dos critérios de alerta.

MetricCriteria

Critério para filtrar métricas.

Nome	Tipo	Description
criterionType	string: StaticThresholdCriterion	Especifica o tipo de critérios de limite
dimensions	MetricDimension[]	Lista de condições de dimensão.
metricName	string	Nome da métrica.
metricNamespace	string	Namespace da métrica.
name	string	Nome dos critérios.
operator	Operator	o operador criteria.
skipMetricValidation	boolean	Permite criar uma regra de alerta em uma métrica personalizada que ainda não foi emitida, fazendo com que a validação da métrica seja ignorada.
threshold	number	o valor do limite de critérios que ativa o alerta.
timeAggregation	AggregationTypeEnum	os tipos de agregação de tempo de critérios.

MetricDimension

Especifica uma dimensão de métrica.

Nome	Tipo	Description
name	string	Nome da dimensão.
operator	string	o operador de dimensão. Há suporte apenas para 'Incluir' e 'Excluir'
values	string[]	lista de valores de dimensão.

Operator

o operador criteria.

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

WebtestLocationAvailabilityCriteria

Especifica os critérios de regra de alerta de métrica para um recurso de teste da Web.

Nome	Tipo	Description
componentId	string	A ID do recurso do Application Insights.
failedLocationCount	number	O número de locais com falha.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	especifica o tipo dos critérios de alerta.
webTestId	string	A ID de teste da Web do Application Insights.