Metric Alerts - Update

Serviço:

Monitor

Versão da API:

2024-03-01-preview

Atualize uma definição de alerta de métrica.

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

Parâmetros do URI

Nome	Em	Obrigatório	Tipo	Descrição
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
ruleName	path	True	string	O nome da regra.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Nome	Tipo	Descrição
identity	Microsoft.Common.Identity	A identidade do recurso.
properties.actionProperties	object	As propriedades de uma ação.
properties.actions	MetricAlertAction[]	A matriz de ações que são 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 é verdadeiro.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define as informações dos critérios de alerta específicos.
properties.customProperties	object	As propriedades de uma carga útil de alerta.
properties.description	string	A descrição do alerta métrico que será incluído no e-mail de alerta.
properties.enabled	boolean	O sinalizador que indica se o alerta de métrica está habilitado.
properties.evaluationFrequency	string (duration)	A frequência com que o alerta métrico é avaliado representada no formato de duração ISO 8601.
properties.resolveConfiguration	ResolveConfiguration	A configuração de como o alerta é resolvido. Aplicável para PromQLCriteria.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo.
properties.severity	integer (int32)	Severidade do alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	A região do(s) recurso(s) de destino na qual o alerta é criado/atualizado. Obrigatório para MúltiplosRecursosMúltiplosCritériosMétricos.
properties.targetResourceType	string	O tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado. Obrigatório para MúltiplosRecursosMúltiplosCritériosMétricos.
properties.windowSize	string (duration)	O período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite.
tags	object	Etiquetas de recursos

Respostas

Nome	Tipo	Descrição
200 OK	MetricAlertResource	Operação do Azure concluída com êxito.
Other Status Codes	MetricAlertErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

Create or update an alert rule

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Nome	Descrição
AggregationTypeEnum	Os tipos de agregação temporal dos critérios. Valores não documentados anteriormente podem ser retornados
createdByType	O tipo de identidade que criou o recurso.
DynamicMetricCriteria	Critério para o limiar dinâmico.
DynamicPromQLCriteria	O critério para a consulta dinâmica do baile.
DynamicThresholdFailingPeriods	O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta.
DynamicThresholdOperator	O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados
DynamicThresholdSensitivity	A extensão do desvio necessário para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão de série métrica. Valores não documentados anteriormente podem ser retornados
IdentityType	Tipo de identidade de serviço gerenciado.
MetricAlertAction	Uma ação de alerta.
MetricAlertErrorResponse	Descreve o formato de Resposta de erro.
MetricAlertMultipleResourceMultipleMetricCriteria	Especifica os critérios de alerta de métrica para múltiplos recursos que têm múltiplos critérios de métrica.
MetricAlertResource	O recurso métrico de alerta.
MetricAlertResourcePatch	O recurso de alerta métrico para operações de patch.
MetricAlertSingleResourceMultipleMetricCriteria	Especifica os critérios de alerta de métrica para um único recurso que tem múltiplos critérios de métrica.
MetricCriteria	Critério para filtrar métricas.
MetricDimension	Especifica uma dimensão métrica.
Microsoft.Common.ErrorDetail	Descreve detalhes de uma resposta a erro.
Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
Microsoft.Common.Identity	Identidade do recurso.
Microsoft.Common.UserIdentityProperties	Propriedades da identidade atribuída pelo utilizador.
Odatatype	Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados
Operator	O operador de critérios. Valores não documentados anteriormente podem ser retornados
PromQLCriteria	Especifica os critérios PromQL para o recurso de alerta métrico.
QueryFailingPeriods	Configuração para períodos de falha em alertas baseados em consulta.
ResolveConfiguration
StaticPromQLCriteria	O critério para a consulta estática do prom.
systemData	Metadados referentes à criação e última modificação do recurso.
WebtestLocationAvailabilityCriteria	Especifica os critérios da regra de alerta métrica para um recurso de teste web.

AggregationTypeEnum

Enumeração

Os tipos de agregação temporal dos critérios. Valores não documentados anteriormente podem ser retornados

Valor	Descrição
Average	Mediano
Count	Count
Minimum	Mínimo
Maximum	Máximo
Total	Total

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

DynamicMetricCriteria

Object

Critério para o limiar dinâmico.

Nome	Tipo	Descrição
alertSensitivity	DynamicThresholdSensitivity	A extensão do desvio necessário para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão de série métrica. Valores não documentados anteriormente podem ser retornados
criterionType	string: DynamicThresholdCriterion	Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
dimensions	MetricDimension[]	Lista de condições de dimensão.
failingPeriods	DynamicThresholdFailingPeriods	O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta.
ignoreDataBefore	string (date-time)	Use esta opção para definir a data a partir 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. Valores não documentados anteriormente podem ser retornados
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 temporal dos critérios. Valores não documentados anteriormente podem ser retornados

DynamicPromQLCriteria

Object

O critério para a consulta dinâmica do baile.

Nome	Tipo	Descrição
alertSensitivity	DynamicThresholdSensitivity	A extensão do desvio necessário para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão de série métrica. Valores não documentados anteriormente podem ser retornados
criterionType	string: DynamicThresholdCriterion	Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
ignoreDataBefore	string (date-time)	Use esta opção para definir a data a partir da qual começar a aprender os dados históricos da métrica e calcular os limites dinâmicos (no formato ISO8601)
name	string	Nome dos critérios.
operator	DynamicThresholdOperator	O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados
query	string	A consulta usada para avaliar a regra de alerta

DynamicThresholdFailingPeriods

Object

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

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

DynamicThresholdOperator

Enumeração

O operador usado para comparar o valor da métrica com o limite. Valores não documentados anteriormente podem ser retornados

Valor	Descrição
GreaterThan	GreaterThan
LessThan	MenosQue
GreaterOrLessThan	MaiorOuMenosQue

DynamicThresholdSensitivity

Enumeração

A extensão do desvio necessário para disparar um alerta. Isso afetará o quão apertado é o limite para o padrão de série métrica. Valores não documentados anteriormente podem ser retornados

Valor	Descrição
Low	Low
Medium	Medium
High	Alto

IdentityType

Enumeração

Tipo de identidade de serviço gerenciado.

Valor	Descrição
SystemAssigned	Atribuído pelo Sistema
UserAssigned	UserAssigned
None	None

MetricAlertAction

Object

Uma ação de alerta.

Nome	Tipo	Descrição
actionGroupId	string	A id do grupo de ação a ser usado.
webHookProperties	object	Este campo permite especificar propriedades personalizadas, que seriam anexadas à carga útil de alerta enviada como entrada para o webhook.

MetricAlertErrorResponse

Object

Descreve o formato de Resposta de erro.

Nome	Tipo	Descrição
error	Microsoft.Common.ErrorResponseError

MetricAlertMultipleResourceMultipleMetricCriteria

Object

Especifica os critérios de alerta de métrica para múltiplos recursos que têm múltiplos critérios de métrica.

Nome	Tipo	Descrição
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	A lista de critérios métricos múltiplos para esta operação "toda".
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

MetricAlertResource

Object

O recurso métrico de alerta.

Nome	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	Microsoft.Common.Identity	A identidade do recurso.
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.actionProperties	object	As propriedades de uma ação.
properties.actions	MetricAlertAction[]	A matriz de ações que são 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 é verdadeiro.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define as informações dos critérios de alerta específicos.
properties.customProperties	object	As propriedades de uma carga útil de alerta.
properties.description	string	A descrição do alerta métrico que será incluído no e-mail de alerta.
properties.enabled	boolean	O sinalizador que indica se o alerta de métrica está habilitado.
properties.evaluationFrequency	string (duration)	A frequência com que o alerta métrico é avaliado representada no formato de duração ISO 8601.
properties.isMigrated	boolean	O valor que indica se esta regra de alerta foi migrada.
properties.lastUpdatedTime	string (date-time)	Da última vez, a regra foi atualizada ISO8601 formato.
properties.resolveConfiguration	ResolveConfiguration	A configuração de como o alerta é resolvido. Aplicável para PromQLCriteria.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo. Não é possível alterar o escopo de uma regra métrica com base em logs.
properties.severity	integer (int32)	Severidade do alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	A região do(s) recurso(s) de destino na qual o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, grupo de recursos ou mais de um recurso.
properties.targetResourceType	string	O tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado. Obrigatório se o escopo contiver uma assinatura, grupo de recursos ou mais de um recurso.
properties.windowSize	string (duration)	O período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

MetricAlertResourcePatch

Object

O recurso de alerta métrico para operações de patch.

Nome	Tipo	Descrição
identity	Microsoft.Common.Identity	A identidade do recurso.
properties.actionProperties	object	As propriedades de uma ação.
properties.actions	MetricAlertAction[]	A matriz de ações que são 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 é verdadeiro.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	Define as informações dos critérios de alerta específicos.
properties.customProperties	object	As propriedades de uma carga útil de alerta.
properties.description	string	A descrição do alerta métrico que será incluído no e-mail de alerta.
properties.enabled	boolean	O sinalizador que indica se o alerta de métrica está habilitado.
properties.evaluationFrequency	string (duration)	A frequência com que o alerta métrico é avaliado representada no formato de duração ISO 8601.
properties.isMigrated	boolean	O valor que indica se esta regra de alerta foi migrada.
properties.lastUpdatedTime	string (date-time)	Da última vez, a regra foi atualizada ISO8601 formato.
properties.resolveConfiguration	ResolveConfiguration	A configuração de como o alerta é resolvido. Aplicável para PromQLCriteria.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo.
properties.severity	integer (int32)	Severidade do alerta {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	A região do(s) recurso(s) de destino na qual o alerta é criado/atualizado. Obrigatório para MúltiplosRecursosMúltiplosCritériosMétricos.
properties.targetResourceType	string	O tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado. Obrigatório para MúltiplosRecursosMúltiplosCritériosMétricos.
properties.windowSize	string (duration)	O período de tempo (no formato de duração ISO 8601) que é usado para monitorar a atividade de alerta com base no limite.
tags	object	Etiquetas de recursos

MetricAlertSingleResourceMultipleMetricCriteria

Object

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

Nome	Tipo	Descrição
allOf	MetricCriteria[]	A lista de critérios métricos para esta operação "toda".
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

MetricCriteria

Object

Critério para filtrar métricas.

Nome	Tipo	Descrição
criterionType	string: StaticThresholdCriterion	Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
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 de critérios. Valores não documentados anteriormente podem ser retornados
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 (double)	O valor limite de critérios que ativa o alerta.
timeAggregation	AggregationTypeEnum	Os tipos de agregação temporal dos critérios. Valores não documentados anteriormente podem ser retornados

MetricDimension

Object

Especifica uma dimensão métrica.

Nome	Tipo	Descrição
name	string	Nome da dimensão.
operator	string	O operador de dimensão. Apenas 'Incluir' e 'Excluir' são suportados
values	string[]	Lista de valores de dimensão.

Microsoft.Common.ErrorDetail

Object

Descreve detalhes de uma resposta a erro.

Nome	Tipo	Descrição
additionalInfo	Microsoft.Common.ErrorDetailAdditionalInfoItem[]	Um array de objetos com propriedades de 'tipo' e 'informação'. O esquema de 'informação' é específico de cada serviço e depende da cadeia de 'tipo'.
code	string	Cadeia não localizada que pode ser usada para identificar programaticamente o erro.
message	string	Descreve o erro em detalhe e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

Microsoft.Common.ErrorDetailAdditionalInfoItem

Object

Nome	Tipo	Descrição
info		A informação adicional específica para o tipo.
type	string	O tipo de informação adicional.

Microsoft.Common.ErrorResponseError

Object

Nome	Tipo	Descrição
additionalInfo	Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]	Um array de objetos com propriedades de 'tipo' e 'informação'. O esquema de 'informação' é específico de cada serviço e depende da cadeia de 'tipo'.
code	string	Cadeia não localizada que pode ser usada para identificar programaticamente o erro.
details	Microsoft.Common.ErrorDetail[]	Uma matriz de objetos adicionais aninhados de informações de resposta de erro, conforme descrito por este contrato.
message	string	Descreve o erro em detalhe e fornece informações de depuração. Se Accept-Language estiver definido no pedido, deve ser localizado para essa língua.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Object

Nome	Tipo	Descrição
info		A informação adicional específica para o tipo.
type	string	O tipo de informação adicional.

Microsoft.Common.Identity

Object

Identidade do recurso.

Nome	Tipo	Descrição
principalId	string	A ID principal da identidade do recurso.
tenantId	string	A ID do locatário do recurso.
type	IdentityType	Tipo de identidade de serviço gerenciado.
userAssignedIdentities	<string,  Microsoft.Common.UserIdentityProperties>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Microsoft.Common.UserIdentityProperties

Object

Propriedades da identidade atribuída pelo utilizador.

Nome	Tipo	Descrição
clientId	string	O ID do cliente da identidade do recurso.
principalId	string	A ID principal da identidade do recurso.

Odatatype

Enumeração

Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

Valor	Descrição
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

Enumeração

O operador de critérios. Valores não documentados anteriormente podem ser retornados

Valor	Descrição
Equals	Igual
GreaterThan	GreaterThan
GreaterThanOrEqual	GreaterThanOrEqual
LessThan	MenosQue
LessThanOrEqual	LessThanOrEqual

PromQLCriteria

Object

Especifica os critérios PromQL para o recurso de alerta métrico.

Nome	Tipo	Descrição
allOf	MultiPromQLCriteria[]: DynamicPromQLCriteria[] StaticPromQLCriteria[]	A lista de critérios promQL. O alerta será disparado quando todas as condições forem cumpridas.
failingPeriods	QueryFailingPeriods	Configuração para períodos de falha em alertas baseados em consulta.
odata.type	string: Microsoft.Azure.Monitor.PromQLCriteria	Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados

QueryFailingPeriods

Object

Configuração para períodos de falha em alertas baseados em consulta.

Nome	Tipo	Descrição
for	string (duration)	O alerta de tempo (no formato de duração ISO 8601) deve estar ativo antes de ser disparado.

ResolveConfiguration

Object

Nome	Tipo	Descrição
autoResolved	boolean	Indica se o alerta deve ser resolvido automaticamente
timeToResolve	string (duration)	O tempo (no formato de duração ISO 8601) após o qual o alerta deve ser resolvido automaticamente

StaticPromQLCriteria

Object

O critério para a consulta estática do prom.

Nome	Tipo	Descrição
criterionType	string: StaticThresholdCriterion	Especifica o tipo de critério de limite. Valores não documentados anteriormente podem ser retornados
name	string	Nome dos critérios.
query	string	A consulta usada para avaliar a regra de alerta

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

WebtestLocationAvailabilityCriteria

Object

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

Nome	Tipo	Descrição
componentId	string	A ID do recurso do Application Insights.
failedLocationCount	number (float)	O número de locais com falha.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	Especifica o tipo dos critérios de alerta. Valores não documentados anteriormente podem ser retornados
webTestId	string	O ID de teste da Web do Application Insights.