Metric Alerts - Update

Servicio:

Monitor

Versión de la API:

2024-03-01-preview

Actualizar una definición de alerta métrica.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
ruleName	path	True	string	Nombre de la regla.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
identity	Microsoft.Common.Identity	Identidad del recurso.
properties.actionProperties	object	Propiedades de una acción.
properties.actions	MetricAlertAction[]	Matriz de acciones que se realizan cuando la regla de alerta se activa y cuando se resuelve una condición de alerta.
properties.autoMitigate	boolean	La marca que indica si la alerta debe resolverse automáticamente o no. El valor predeterminado es true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define la información específica de los criterios de alerta.
properties.customProperties	object	Propiedades de una carga 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 (duration)	La frecuencia con la que se evalúa la alerta métrica representada en formato de duración ISO 8601.
properties.resolveConfiguration	ResolveConfiguration	La configuración de cómo se resuelve la alerta. Aplicable para PromQLCriteria.
properties.scopes	string[]	La lista de identificadores de recursos a los que se limita esta alerta de métrica.
properties.severity	integer (int32)	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 para Múltiples Criterios Múltiples de Recurso.
properties.targetResourceType	string	Tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Obligatorio para Múltiples Criterios Múltiples de Recurso.
properties.windowSize	string (duration)	El período de tiempo (en formato de duración ISO 8601) que se utiliza para supervisar la actividad de alertas en función del umbral.
tags	object	Etiquetas de recursos

Respuestas

Nombre	Tipo	Description
200 OK	MetricAlertResource	Operación de Azure completada con éxito.
Other Status Codes	MetricAlertErrorResponse	Una respuesta de error inesperada.

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	suplantar la cuenta de usuario

Ejemplos

Create or update an alert rule

Solicitud de ejemplo

HTTP

PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2024-03-01-preview

{
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": true,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "severity": 3,
    "windowSize": "PT15M"
  },
  "tags": {}
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python update_metric_alert.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.metric_alerts.update(
        resource_group_name="gigtest",
        rule_name="chiricutin",
        parameters={
            "properties": {
                "actions": [
                    {
                        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
                        "webHookProperties": {"key11": "value11", "key12": "value12"},
                    }
                ],
                "autoMitigate": True,
                "criteria": {
                    "allOf": [
                        {
                            "criterionType": "StaticThresholdCriterion",
                            "dimensions": [],
                            "metricName": "\\Processor(_Total)\\% Processor Time",
                            "name": "High_CPU_80",
                            "operator": "GreaterThan",
                            "threshold": 80.5,
                            "timeAggregation": "Average",
                        }
                    ],
                    "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
                },
                "description": "This is the description of the rule1",
                "enabled": True,
                "evaluationFrequency": "PT1M",
                "scopes": [
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
                ],
                "severity": 3,
                "windowSize": "PT15M",
            },
            "tags": {},
        },
    )
    print(response)


# x-ms-original-file: 2024-03-01-preview/UpdateMetricAlert.json
if __name__ == "__main__":
    main()

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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: 2024-03-01-preview/UpdateMetricAlert.json
func ExampleMetricAlertsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMetricAlertsClient().Update(ctx, "gigtest", "chiricutin", armmonitor.MetricAlertResourcePatch{
		Properties: &armmonitor.MetricAlertPropertiesPatch{
			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"),
					},
				},
			},
			AutoMitigate: to.Ptr(true),
			Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
				AllOf: []*armmonitor.MetricCriteria{
					{
						Name:            to.Ptr("High_CPU_80"),
						CriterionType:   to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
						Dimensions:      []*armmonitor.MetricDimension{},
						MetricName:      to.Ptr("\\Processor(_Total)\\% Processor Time"),
						Operator:        to.Ptr(armmonitor.OperatorGreaterThan),
						Threshold:       to.Ptr[float64](80.5),
						TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
					},
				},
				ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
			},
			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"),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armmonitor.MetricAlertsClientUpdateResponse{
	// 	MetricAlertResource: armmonitor.MetricAlertResource{
	// 		Type: to.Ptr("Microsoft.Insights/metricAlerts"),
	// 		ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin"),
	// 		Location: to.Ptr("global"),
	// 		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"),
	// 					},
	// 				},
	// 			},
	// 			AutoMitigate: to.Ptr(true),
	// 			Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
	// 				AllOf: []*armmonitor.MetricCriteria{
	// 					{
	// 						Name: to.Ptr("High_CPU_80"),
	// 						CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
	// 						Dimensions: []*armmonitor.MetricDimension{
	// 						},
	// 						MetricName: to.Ptr("\\Processor(_Total)\\% Processor Time"),
	// 						Operator: to.Ptr(armmonitor.OperatorGreaterThan),
	// 						Threshold: to.Ptr[float64](80.5),
	// 						TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
	// 					},
	// 				},
	// 				ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
	// 			},
	// 			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"),
	// 		},
	// 		Tags: map[string]*string{
	// 			"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 		},
	// 	},
	// }
}

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 update an metric alert definition.
 *
 * @summary update an metric alert definition.
 * x-ms-original-file: 2024-03-01-preview/UpdateMetricAlert.json
 */
async function createOrUpdateAnAlertRule() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.metricAlerts.update("gigtest", "chiricutin", {
    description: "This is the description of the rule1",
    actions: [
      {
        actionGroupId:
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        webHookProperties: { key11: "value11", key12: "value12" },
      },
    ],
    autoMitigate: true,
    criteria: {
      allOf: [
        {
          name: "High_CPU_80",
          criterionType: "StaticThresholdCriterion",
          dimensions: [],
          metricName: "\\Processor(_Total)\\% Processor Time",
          operator: "GreaterThan",
          threshold: 80.5,
          timeAggregation: "Average",
        },
      ],
      odataType: "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
    },
    enabled: true,
    evaluationFrequency: "PT1M",
    scopes: [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme",
    ],
    severity: 3,
    windowSize: "PT15M",
    tags: {},
  });
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "type": "Microsoft.Insights/metricAlerts",
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/microsoft.insights/metricalerts/chiricutin",
  "location": "global",
  "properties": {
    "description": "This is the description of the rule1",
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ],
    "autoMitigate": true,
    "criteria": {
      "allOf": [
        {
          "name": "High_CPU_80",
          "criterionType": "StaticThresholdCriterion",
          "dimensions": [],
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ],
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
    },
    "enabled": true,
    "evaluationFrequency": "PT1M",
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "severity": 3,
    "windowSize": "PT15M"
  },
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  }
}

Definiciones

Nombre	Description
AggregationTypeEnum	Los criterios de agregación de tiempo. Es posible que se devuelvan valores no documentados anteriormente
createdByType	Tipo de identidad que creó el recurso.
DynamicMetricCriteria	Criterio para el umbral dinámico.
DynamicPromQLCriteria	El criterio para la consulta dinámica del baile de graduación.
DynamicThresholdFailingPeriods	Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta.
DynamicThresholdOperator	Operador que se usa para comparar el valor de la métrica con respecto al umbral. Es posible que se devuelvan valores no documentados anteriormente
DynamicThresholdSensitivity	Extensión de desviación necesaria para desencadenar una alerta. Esto afectará a la limitación del umbral al patrón de serie de métricas. Es posible que se devuelvan valores no documentados anteriormente
IdentityType	Tipo de identidad de servicio administrada.
MetricAlertAction	Una acción de alerta.
MetricAlertErrorResponse	Describe el formato de respuesta de error.
MetricAlertMultipleResourceMultipleMetricCriteria	Especifica los criterios de alerta de métrica para múltiples recursos que tienen múltiples criterios de métrica.
MetricAlertResource	El recurso métrico de alerta.
MetricAlertResourcePatch	El recurso de alerta métrica para operaciones de parche.
MetricAlertSingleResourceMultipleMetricCriteria	Especifica los criterios de alerta de métrica para un único recurso que tiene múltiples criterios de métrica.
MetricCriteria	Criterio para filtrar métricas.
MetricDimension	Especifica una dimensión métrica.
Microsoft.Common.ErrorDetail	Describe detalles de una respuesta de error.
Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
Microsoft.Common.Identity	Identidad del recurso.
Microsoft.Common.UserIdentityProperties	Propiedades de la identidad asignada por el usuario.
Odatatype	Especifica el tipo de criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente
Operator	Operador criteria. Es posible que se devuelvan valores no documentados anteriormente
PromQLCriteria	Especifica los criterios PromQL para el recurso de alerta métrica.
QueryFailingPeriods	Configuración de períodos de error en alertas basadas en consultas.
ResolveConfiguration
StaticPromQLCriteria	El criterio para la consulta estática del prom.
systemData	Metadatos relativos a la creación y última modificación del recurso.
WebtestLocationAvailabilityCriteria	Especifica los criterios de la regla de alerta métrica para un recurso de prueba web.

AggregationTypeEnum

Enumeración

Los criterios de agregación de tiempo. Es posible que se devuelvan valores no documentados anteriormente

Valor	Description
Average	Average
Count	Contar
Minimum	Mínima
Maximum	Máxima
Total	Total

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DynamicMetricCriteria

Objeto

Criterio para el umbral dinámico.

Nombre	Tipo	Description
alertSensitivity	DynamicThresholdSensitivity	Extensión de desviación necesaria para desencadenar una alerta. Esto afectará a la limitación del umbral al patrón de serie de métricas. Es posible que se devuelvan valores no documentados anteriormente
criterionType	string: DynamicThresholdCriterion	Especifica el tipo de criterios de umbral. Es posible que se devuelvan valores no documentados anteriormente
dimensions	MetricDimension[]	Lista de condiciones de dimensión.
failingPeriods	DynamicThresholdFailingPeriods	Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta.
ignoreDataBefore	string (date-time)	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 formato ISO8601)
metricName	string	Nombre de la métrica.
metricNamespace	string	Namespace 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. Es posible que se devuelvan valores no documentados anteriormente
skipMetricValidation	boolean	Permite crear una regla de alerta en una métrica personalizada que aún no se ha emitido, lo que provoca que se omita la validación de métricas.
timeAggregation	AggregationTypeEnum	Los criterios de agregación de tiempo. Es posible que se devuelvan valores no documentados anteriormente

DynamicPromQLCriteria

Objeto

El criterio para la consulta dinámica del baile de graduación.

Nombre	Tipo	Description
alertSensitivity	DynamicThresholdSensitivity	Extensión de desviación necesaria para desencadenar una alerta. Esto afectará a la limitación del umbral al patrón de serie de métricas. Es posible que se devuelvan valores no documentados anteriormente
criterionType	string: DynamicThresholdCriterion	Especifica el tipo de criterios de umbral. Es posible que se devuelvan valores no documentados anteriormente
ignoreDataBefore	string (date-time)	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 formato ISO8601)
name	string	Nombre de los criterios.
operator	DynamicThresholdOperator	Operador que se usa para comparar el valor de la métrica con respecto al umbral. Es posible que se devuelvan valores no documentados anteriormente
query	string	La consulta utilizada para evaluar la regla de alerta

DynamicThresholdFailingPeriods

Objeto

Número mínimo de infracciones necesarias en el período de tiempo de búsqueda seleccionado necesario para generar una alerta.

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

DynamicThresholdOperator

Enumeración

Operador que se usa para comparar el valor de la métrica con respecto al umbral. Es posible que se devuelvan valores no documentados anteriormente

Valor	Description
GreaterThan	GreaterThan
LessThan	LessThan
GreaterOrLessThan	MayorOMenosQue

DynamicThresholdSensitivity

Enumeración

Extensión de desviación necesaria para desencadenar una alerta. Esto afectará a la limitación del umbral al patrón de serie de métricas. Es posible que se devuelvan valores no documentados anteriormente

Valor	Description
Low	Low
Medium	Medium
High	Alto

IdentityType

Enumeración

Tipo de identidad de servicio administrada.

Valor	Description
SystemAssigned	AsignadoPorElSistema
UserAssigned	UserAssigned
None	Ninguno

MetricAlertAction

Objeto

Una acción de alerta.

Nombre	Tipo	Description
actionGroupId	string	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.

MetricAlertErrorResponse

Objeto

Describe el formato de respuesta de error.

Nombre	Tipo	Description
error	Microsoft.Common.ErrorResponseError

MetricAlertMultipleResourceMultipleMetricCriteria

Objeto

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

Nombre	Tipo	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	La lista de múltiples criterios de métricas para esta operación "toda".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	Especifica el tipo de criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente

MetricAlertResource

Objeto

El recurso métrico de alerta.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Microsoft.Common.Identity	Identidad del recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.actionProperties	object	Propiedades de una acción.
properties.actions	MetricAlertAction[]	Matriz de acciones que se realizan cuando la regla de alerta se activa y cuando se resuelve una condición de alerta.
properties.autoMitigate	boolean	La marca que indica si la alerta debe resolverse automáticamente o no. El valor predeterminado es true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define la información específica de los criterios de alerta.
properties.customProperties	object	Propiedades de una carga 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 (duration)	La frecuencia con la que se evalúa la alerta métrica representada en formato de duración ISO 8601.
properties.isMigrated	boolean	El valor que indica si esta regla de alerta ha sido migrada.
properties.lastUpdatedTime	string (date-time)	La última vez la regla se actualizó en ISO8601 formato.
properties.resolveConfiguration	ResolveConfiguration	La configuración de cómo se resuelve la alerta. Aplicable para PromQLCriteria.
properties.scopes	string[]	La lista de identificadores de recursos a los que se limita esta alerta de métrica. No se puede cambiar el ámbito de una regla de métricas en función de los registros.
properties.severity	integer (int32)	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	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 (duration)	El período de tiempo (en formato de duración ISO 8601) que se utiliza para supervisar la actividad de alertas en función del umbral.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

MetricAlertResourcePatch

Objeto

El recurso de alerta métrica para operaciones de parche.

Nombre	Tipo	Description
identity	Microsoft.Common.Identity	Identidad del recurso.
properties.actionProperties	object	Propiedades de una acción.
properties.actions	MetricAlertAction[]	Matriz de acciones que se realizan cuando la regla de alerta se activa y cuando se resuelve una condición de alerta.
properties.autoMitigate	boolean	La marca que indica si la alerta debe resolverse automáticamente o no. El valor predeterminado es true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define la información específica de los criterios de alerta.
properties.customProperties	object	Propiedades de una carga 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 (duration)	La frecuencia con la que se evalúa la alerta métrica representada en formato de duración ISO 8601.
properties.isMigrated	boolean	El valor que indica si esta regla de alerta ha sido migrada.
properties.lastUpdatedTime	string (date-time)	La última vez la regla se actualizó en ISO8601 formato.
properties.resolveConfiguration	ResolveConfiguration	La configuración de cómo se resuelve la alerta. Aplicable para PromQLCriteria.
properties.scopes	string[]	La lista de identificadores de recursos a los que se limita esta alerta de métrica.
properties.severity	integer (int32)	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 para Múltiples Criterios Múltiples de Recurso.
properties.targetResourceType	string	Tipo de recurso de los recursos de destino en los que se crea o actualiza la alerta. Obligatorio para Múltiples Criterios Múltiples de Recurso.
properties.windowSize	string (duration)	El período de tiempo (en formato de duración ISO 8601) que se utiliza para supervisar la actividad de alertas en función del umbral.
tags	object	Etiquetas de recursos

MetricAlertSingleResourceMultipleMetricCriteria

Objeto

Especifica los criterios de alerta de métrica para un único recurso que tiene múltiples 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 criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente

MetricCriteria

Objeto

Criterio para filtrar métricas.

Nombre	Tipo	Description
criterionType	string: StaticThresholdCriterion	Especifica el tipo de criterios de umbral. Es posible que se devuelvan valores no documentados anteriormente
dimensions	MetricDimension[]	Lista de condiciones de dimensión.
metricName	string	Nombre de la métrica.
metricNamespace	string	Namespace de la métrica.
name	string	Nombre de los criterios.
operator	Operator	Operador criteria. Es posible que se devuelvan valores no documentados anteriormente
skipMetricValidation	boolean	Permite crear una regla de alerta en una métrica personalizada que aún no se ha emitido, lo que provoca que se omita la validación de métricas.
threshold	number (double)	El valor de umbral de criterios que activa la alerta.
timeAggregation	AggregationTypeEnum	Los criterios de agregación de tiempo. Es posible que se devuelvan valores no documentados anteriormente

MetricDimension

Objeto

Especifica una dimensión métrica.

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

Microsoft.Common.ErrorDetail

Objeto

Describe detalles de una respuesta de error.

Nombre	Tipo	Description
additionalInfo	Microsoft.Common.ErrorDetailAdditionalInfoItem[]	Un conjunto de objetos con propiedades de 'tipo' e 'info'. El esquema de 'info' es específico de cada servicio y depende de la cadena de 'tipo'.
code	string	Cadena no localizada que puede usarse para identificar programáticamente el error.
message	string	Describe el error en detalle y proporciona información de depuración.
target	string	El destino del error concreto (por ejemplo, el nombre de la propiedad con error).

Microsoft.Common.ErrorDetailAdditionalInfoItem

Objeto

Nombre	Tipo	Description
info		La información adicional específica del tipo.
type	string	El tipo de información adicional.

Microsoft.Common.ErrorResponseError

Objeto

Nombre	Tipo	Description
additionalInfo	Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]	Un conjunto de objetos con propiedades de 'tipo' e 'info'. El esquema de 'info' es específico de cada servicio y depende de la cadena de 'tipo'.
code	string	Cadena no localizada que puede usarse para identificar programáticamente el error.
details	Microsoft.Common.ErrorDetail[]	Matriz de objetos de información de respuesta de error anidados adicionales, como se describe en este contrato.
message	string	Describe el error en detalle y proporciona información de depuración. Si Accept-Language está configurado en la solicitud, debe localizarse a ese idioma.
target	string	El destino del error concreto (por ejemplo, el nombre de la propiedad con error).

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Objeto

Nombre	Tipo	Description
info		La información adicional específica del tipo.
type	string	El tipo de información adicional.

Microsoft.Common.Identity

Objeto

Identidad del recurso.

Nombre	Tipo	Description
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.
tenantId	string	Identificador de inquilino del recurso.
type	IdentityType	Tipo de identidad de servicio administrada.
userAssignedIdentities	<string,  Microsoft.Common.UserIdentityProperties>	Lista de identidades de usuario asociadas al recurso. Las referencias de clave de diccionario de identidad de usuario serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Microsoft.Common.UserIdentityProperties

Objeto

Propiedades de la identidad asignada por el usuario.

Nombre	Tipo	Description
clientId	string	El ID del cliente de la identidad del recurso.
principalId	string	Identificador de entidad de seguridad de la identidad del recurso.

Odatatype

Enumeración

Especifica el tipo de criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente

Valor	Description
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria
Microsoft.Azure.Monitor.PromQLCriteria	Microsoft.Azure.Monitor.PromQLCriteria

Operator

Enumeración

Operador criteria. Es posible que se devuelvan valores no documentados anteriormente

Valor	Description
Equals	Es igual
GreaterThan	GreaterThan
GreaterThanOrEqual	GreaterThanOrEqual
LessThan	LessThan
LessThanOrEqual	LessThanOrEqual

PromQLCriteria

Objeto

Especifica los criterios PromQL para el recurso de alerta métrica.

Nombre	Tipo	Description
allOf	MultiPromQLCriteria[]: DynamicPromQLCriteria[] StaticPromQLCriteria[]	La lista de criterios de promQL. La alerta se activará cuando se cumplan todas las condiciones.
failingPeriods	QueryFailingPeriods	Configuración de períodos de error en alertas basadas en consultas.
odata.type	string: Microsoft.Azure.Monitor.PromQLCriteria	Especifica el tipo de criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente

QueryFailingPeriods

Objeto

Configuración de períodos de error en alertas basadas en consultas.

Nombre	Tipo	Description
for	string (duration)	La cantidad de tiempo (en formato de duración ISO 8601) de alerta debe estar activa antes de disparar.

ResolveConfiguration

Objeto

Nombre	Tipo	Description
autoResolved	boolean	Indica si la alerta debe resolverse automáticamente
timeToResolve	string (duration)	La hora (en formato de duración ISO 8601) después de la cual la alerta debe resolverse automáticamente

StaticPromQLCriteria

Objeto

El criterio para la consulta estática del prom.

Nombre	Tipo	Description
criterionType	string: StaticThresholdCriterion	Especifica el tipo de criterios de umbral. Es posible que se devuelvan valores no documentados anteriormente
name	string	Nombre de los criterios.
query	string	La consulta utilizada para evaluar la regla de alerta

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

WebtestLocationAvailabilityCriteria

Objeto

Especifica los criterios de la regla de alerta métrica para un recurso de prueba web.

Nombre	Tipo	Description
componentId	string	Identificador de recurso de Application Insights.
failedLocationCount	number (float)	Número de ubicaciones con errores.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	Especifica el tipo de criterios de alerta. Es posible que se devuelvan valores no documentados anteriormente
webTestId	string	Identificador de prueba web de Application Insights.