Compartir a través de


Metric Alerts - List By Subscription

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

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

List metric alert rules

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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[]:

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:

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.