Metric Alerts - Update

Serviço:

Monitor

Versão da API:

2018-03-01

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

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	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	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
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 é true.
properties.criteria	MetricAlertCriteria: MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria MetricAlertMultipleResourceMultipleMetricCriteria	define as informações sobre os critérios de alerta específicos.
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	a frequência com que o alerta métrico é avaliado, representada no formato de duração ISO 8601.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo.
properties.severity	integer	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 MultipleResourceMultipleMetricCriteria.
properties.targetResourceType	string	O tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria.
properties.windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.
tags	object	Tags de recursos

Respostas

Name	Tipo	Description
200 OK	MetricAlertResource	OK
Other Status Codes	ErrorResponse	BadRequest

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
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=2018-03-01

{
  "tags": {},
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Java

import com.azure.resourcemanager.monitor.models.AggregationTypeEnum;
import com.azure.resourcemanager.monitor.models.MetricAlertAction;
import com.azure.resourcemanager.monitor.models.MetricAlertResourcePatch;
import com.azure.resourcemanager.monitor.models.MetricAlertSingleResourceMultipleMetricCriteria;
import com.azure.resourcemanager.monitor.models.MetricCriteria;
import com.azure.resourcemanager.monitor.models.Operator;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for MetricAlerts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
     */
    /**
     * Sample code: Create or update an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts()
            .updateWithResponse("gigtest", "chiricutin", new MetricAlertResourcePatch().withTags(mapOf())
                .withDescription("This is the description of the rule1").withSeverity(3).withEnabled(true)
                .withScopes(Arrays.asList(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"))
                .withEvaluationFrequency(Duration.parse("Pt1m")).withWindowSize(Duration.parse("Pt15m"))
                .withCriteria(new MetricAlertSingleResourceMultipleMetricCriteria().withAllOf(Arrays.asList(
                    new MetricCriteria().withName("High_CPU_80").withMetricName("\\Processor(_Total)\\% Processor Time")
                        .withTimeAggregation(AggregationTypeEnum.AVERAGE).withDimensions(Arrays.asList())
                        .withOperator(Operator.GREATER_THAN).withThreshold(80.5))))
                .withAutoMitigate(true)
                .withActions(Arrays.asList(new MetricAlertAction().withActionGroupId(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2")
                    .withWebhookProperties(mapOf("key11", "fakeTokenPlaceholder", "key12", "fakeTokenPlaceholder")))),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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: https://github.com/Azure/azure-rest-api-specs/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/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("<subscription-id>", 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{
				ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
				AllOf: []*armmonitor.MetricCriteria{
					{
						Name:            to.Ptr("High_CPU_80"),
						CriterionType:   to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
						Dimensions:      []*armmonitor.MetricDimension{},
						MetricName:      to.Ptr("\\Processor(_Total)\\% Processor Time"),
						TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
						Operator:        to.Ptr(armmonitor.OperatorGreaterThan),
						Threshold:       to.Ptr[float64](80.5),
					}},
			},
			Enabled:             to.Ptr(true),
			EvaluationFrequency: to.Ptr("Pt1m"),
			Scopes: []*string{
				to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
			Severity:   to.Ptr[int32](3),
			WindowSize: to.Ptr("Pt15m"),
		},
		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.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"),
	// 	Tags: map[string]*string{
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.MetricAlertProperties{
	// 		Description: to.Ptr("This is the description of the rule1"),
	// 		Actions: []*armmonitor.MetricAlertAction{
	// 			{
	// 				ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
	// 				WebHookProperties: map[string]*string{
	// 					"key11": to.Ptr("value11"),
	// 					"key12": to.Ptr("value12"),
	// 				},
	// 		}},
	// 		AutoMitigate: to.Ptr(true),
	// 		Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
	// 			ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
	// 			AllOf: []*armmonitor.MetricCriteria{
	// 				{
	// 					Name: to.Ptr("High_CPU_80"),
	// 					CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
	// 					Dimensions: []*armmonitor.MetricDimension{
	// 					},
	// 					MetricName: to.Ptr("\\Processor(_Total)\\% Processor Time"),
	// 					TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
	// 					Operator: to.Ptr(armmonitor.OperatorGreaterThan),
	// 					Threshold: to.Ptr[float64](80.5),
	// 			}},
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		EvaluationFrequency: to.Ptr("Pt1m"),
	// 		Scopes: []*string{
	// 			to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
	// 			Severity: to.Ptr[int32](3),
	// 			WindowSize: to.Ptr("Pt15m"),
	// 		},
	// 	}
}

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: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
 */
async function createOrUpdateAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "gigtest";
  const ruleName = "chiricutin";
  const parameters = {
    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,
    tags: {},
    windowSize: "Pt15m",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.metricAlerts.update(resourceGroupName, ruleName, parameters);
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
// this example is just showing the usage of "MetricAlerts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MetricAlertResource created on azure
// for more information of creating MetricAlertResource, please refer to the document of MetricAlertResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
string ruleName = "chiricutin";
ResourceIdentifier metricAlertResourceId = MetricAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
MetricAlertResource metricAlert = client.GetMetricAlertResource(metricAlertResourceId);

// invoke the operation
MetricAlertPatch patch = new MetricAlertPatch()
{
    Tags =
    {
    },
    Description = "This is the description of the rule1",
    Severity = 3,
    IsEnabled = true,
    Scopes =
    {
    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    },
    EvaluationFrequency = XmlConvert.ToTimeSpan("Pt1m"),
    WindowSize = XmlConvert.ToTimeSpan("Pt15m"),
    Criteria = new MetricAlertSingleResourceMultipleMetricCriteria()
    {
        AllOf =
        {
        new MetricCriteria("High_CPU_80","\\Processor(_Total)\\% Processor Time",MetricCriteriaTimeAggregationType.Average,MetricCriteriaOperator.GreaterThan,80.5)
        {
        Dimensions =
        {
        },
        }
        },
    },
    IsAutoMitigateEnabled = true,
    Actions =
    {
    new MetricAlertAction()
    {
    ActionGroupId = new ResourceIdentifier("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
    WebHookProperties =
    {
    ["key11"] = "value11",
    ["key12"] = "value12",
    },
    }
    },
};
MetricAlertResource result = await metricAlert.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MetricAlertData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "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": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Definições

Name	Description
AdditionalInfo	Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.
AggregationTypeEnum	os tipos de agregação temporal dos critérios.
DynamicMetricCriteria	Critério de limiar dinâmico.
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.
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.
Error
ErrorDetail	Descreve os detalhes de uma resposta de erro.
ErrorResponse	Descreve o formato de Resposta de erro.
MetricAlertAction	Uma ação de alerta.
MetricAlertMultipleResourceMultipleMetricCriteria	Especifica os critérios de alerta de métrica para vários recursos que têm vários critérios métricos.
MetricAlertResource	O recurso de alerta métrico.
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 vários critérios métricos.
MetricCriteria	Critério para filtrar métricas.
MetricDimension	Especifica uma dimensão métrica.
Operator	o operador de critérios.
WebtestLocationAvailabilityCriteria	Especifica os critérios da regra de alerta métrico para um recurso de teste da Web.

AdditionalInfo

Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.

Name	Tipo	Description
info	object	As informações adicionais específicas do tipo.
type	string	O tipo de informação adicional.

AggregationTypeEnum

os tipos de agregação temporal dos critérios.

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

DynamicMetricCriteria

Critério de limiar dinâmico.

Name	Tipo	Description
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.
criterionType	string: DynamicThresholdCriterion	Especifica o tipo de critérios de limite
dimensions	MetricDimension[]	Lista de condições de dimensão.
failingPeriods	DynamicThresholdFailingPeriods	O número mínimo de violações necessárias dentro da janela de tempo de retrospetiva selecionada necessária para gerar um alerta.
ignoreDataBefore	string	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.
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.

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.

Name	Tipo	Description
minFailingPeriodsToAlert	number	O número de violações para disparar um alerta. Deve ser menor ou igual a numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	O número de pontos de 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

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

Name	Tipo	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

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.

Name	Tipo	Description
High	string
Low	string
Medium	string

Error

Name	Tipo	Description
additionalInfo	AdditionalInfo[]	Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.
code	string	String não localizada que pode ser usada para identificar programaticamente o erro.
details	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 detalhes e fornece informações de depuração. Se Accept-Language estiver definido na solicitação, ela deverá ser localizada para esse idioma.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

ErrorDetail

Descreve os detalhes de uma resposta de erro.

Name	Tipo	Description
additionalInfo	AdditionalInfo[]	Uma matriz de objetos com propriedades 'type' e 'info'. O esquema de 'info' é específico do serviço e depende da cadeia de caracteres 'type'.
code	string	String não localizada que pode ser usada para identificar programaticamente o erro.
message	string	Descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

ErrorResponse

Descreve o formato de Resposta de erro.

Name	Tipo	Description
error	Error

MetricAlertAction

Uma ação de alerta.

Name	Tipo	Description
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.

MetricAlertMultipleResourceMultipleMetricCriteria

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

Name	Tipo	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	a lista de critérios métricos múltiplos para esta operação «todas».
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	Especifica o tipo dos critérios de alerta.

MetricAlertResource

O recurso de alerta métrico.

Name	Tipo	Description
id	string	ID do recurso do Azure
location	string	Localização do recurso
name	string	Nome do recurso do Azure
properties.actions	MetricAlertAction[]	A matriz de ações 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 é true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	define as informações sobre os critérios de alerta específicos.
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	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 essa regra de alerta foi migrada.
properties.lastUpdatedTime	string	Da última vez que a regra foi atualizada em ISO8601 formato.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo.
properties.severity	integer	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	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.
tags	object	Tags de recursos
type	string	Tipo de recurso do Azure

MetricAlertResourcePatch

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

Name	Tipo	Description
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 é true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	define as informações sobre os critérios de alerta específicos.
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	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 essa regra de alerta foi migrada.
properties.lastUpdatedTime	string	Da última vez que a regra foi atualizada em ISO8601 formato.
properties.scopes	string[]	A lista de IDs de recursos para os quais esse alerta de métrica tem escopo.
properties.severity	integer	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 MultipleResourceMultipleMetricCriteria.
properties.targetResourceType	string	O tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado. Obrigatório para MultipleResourceMultipleMetricCriteria.
properties.windowSize	string	o período de tempo (no formato de duração ISO 8601) usado para monitorar a atividade de alerta com base no limite.
tags	object	Tags de recursos

MetricAlertSingleResourceMultipleMetricCriteria

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

Name	Tipo	Description
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.

MetricCriteria

Critério para filtrar métricas.

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

MetricDimension

Especifica uma dimensão métrica.

Name	Tipo	Description
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.

Operator

o operador de critérios.

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

WebtestLocationAvailabilityCriteria

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

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