Metric Alerts - List By Subscription

Recupera las definiciones de reglas de alerta de una suscripción.

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

Parámetros de identificador URI

Name In Required Type Description
subscriptionId
path True
  • string

IDENTIFICADOR de la suscripción de destino.

api-version
query True
  • string

Versión de API que se va a usar para esta operación.

Respuestas

Name Type Description
200 OK

Solicitud correcta para una lista de alertas de métricas

Other Status Codes

BadRequest

Seguridad

azure_auth

Azure Active Directory flujo de OAuth2

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

Scopes

Name Description
user_impersonation suplantar su cuenta de usuario

Ejemplos

List metric alert rules

Sample Request

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

Sample Response

{
  "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

AggregationTypeEnum

los tipos de agregación Time de criterios.

DynamicMetricCriteria

Criterio de umbral dinámico.

DynamicThresholdFailingPeriods

Número mínimo de infracciones que se requieren en la ventana de tiempo de lookback seleccionada necesaria para generar una alerta.

DynamicThresholdOperator

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

DynamicThresholdSensitivity

La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la precisión del umbral en el patrón de serie métrica.

ErrorResponse

Describe el formato de la respuesta de error.

MetricAlertAction

Una acción de alerta.

MetricAlertMultipleResourceMultipleMetricCriteria

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

MetricAlertResource

El recurso de alerta de métricas.

MetricAlertResourceCollection

Representa una colección de recursos de la regla de alerta.

MetricAlertSingleResourceMultipleMetricCriteria

Especifica los criterios de alerta de métricas 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

el operador de criterios.

WebtestLocationAvailabilityCriteria

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

AggregationTypeEnum

los tipos de agregación Time de criterios.

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

DynamicMetricCriteria

Criterio de umbral dinámico.

Name Type Description
alertSensitivity

La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la precisión del umbral en el patrón de serie métrica.

criterionType string:
  • DynamicThresholdCriterion

Especifica el tipo de criterios de umbral

dimensions

Lista de condiciones de dimensión.

failingPeriods

Número mínimo de infracciones que se requieren en la ventana de tiempo de lookback seleccionada necesaria para generar una alerta.

ignoreDataBefore
  • string

Use esta opción para establecer la fecha desde la que se va a empezar a aprender los datos históricos de métricas y calcular los umbrales dinámicos (en formato ISO8601).

metricName
  • string

el nombre de la métrica.

metricNamespace
  • string

Espacio de nombres de la métrica.

name
  • string

Nombre de los criterios.

operator

Operador que se usa para comparar el valor de métrica con el 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

los tipos de agregación Time de criterios.

DynamicThresholdFailingPeriods

Número mínimo de infracciones que se requieren en la ventana de tiempo de lookback seleccionada necesaria para generar una alerta.

Name Type Description
minFailingPeriodsToAlert
  • number

El número de infracciones para desencadenar una alerta. Debe ser menor o igual que numberOfEvaluationPeriods.

numberOfEvaluationPeriods
  • number

Número de puntos de lookback agregados. La ventana de tiempo lookback se calcula en función de la granularidad de agregación (windowS) y el número seleccionado de puntos agregados.

DynamicThresholdOperator

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

Name Type Description
GreaterOrLessThan
  • string
GreaterThan
  • string
LessThan
  • string

DynamicThresholdSensitivity

La extensión de la desviación necesaria para desencadenar una alerta. Esto afectará a la precisión del umbral en el patrón de serie métrica.

Name Type Description
High
  • string
Low
  • string
Medium
  • string

ErrorResponse

Describe el formato de la respuesta de error.

Name Type 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.

Name Type Description
actionGroupId
  • string

identificador del grupo de acciones que se va a usar.

webHookProperties
  • object

Este campo permite especificar propiedades personalizadas, que se anexarán a la carga de alerta enviada como entrada al webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

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

Name Type Description
allOf MultiMetricCriteria[]:

la lista de varios criterios de métrica para esta operación ' todo '.

odata.type string:
  • Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

especifica el tipo de los criterios de alerta.

MetricAlertResource

El recurso de alerta de métricas.

Name Type Description
id
  • string

Identificador de recurso de Azure

location
  • string

Ubicación de los recursos

name
  • string

Nombre de recurso de Azure

properties.actions

la matriz de acciones que se realizan cuando se activa la regla de alerta 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:

define la información específica de los criterios de alerta.

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

frecuencia con la que se evalúa la alerta de métricas en formato de duración ISO 8601.

properties.isMigrated
  • boolean

valor que indica si se migra esta regla de alerta.

properties.lastUpdatedTime
  • string

Última vez que se actualizó la regla en formato ISO8601.

properties.scopes
  • string[]

lista de identificadores de recursos a los que se limita esta alerta de métrica.

properties.severity
  • integer

Gravedad de la 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 alerta según el umbral.

tags
  • object

Etiquetas del recurso

type
  • string

Tipo de recurso de Azure

MetricAlertResourceCollection

Representa una colección de recursos de la regla de alerta.

Name Type Description
value

los valores de los recursos de la regla de alerta.

MetricAlertSingleResourceMultipleMetricCriteria

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

Name Type Description
allOf

La lista de criterios de métricas 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.

Name Type Description
criterionType string:
  • StaticThresholdCriterion

Especifica el tipo de criterios de umbral

dimensions

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

el operador de criterios.

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

los tipos de agregación Time de criterios.

MetricDimension

Especifica una dimensión de métrica.

Name Type 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

el operador de criterios.

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

WebtestLocationAvailabilityCriteria

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

Name Type Description
componentId
  • string

Identificador de recurso de Application Insights.

failedLocationCount
  • number

El 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 la prueba Web de Application Insights.