Metric Alerts - Update

Service:

Monitor

Version d'API:

2018-03-01

Mettez à jour une définition d’alerte de métrique.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
ruleName	path	True	string	Nom de la règle.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.actions	MetricAlertAction[]	tableau d’actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.autoMitigate	boolean	indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.
properties.criteria	MetricAlertCriteria: MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria MetricAlertMultipleResourceMultipleMetricCriteria	définit les informations de critères d’alerte spécifiques.
properties.description	string	description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.
properties.enabled	boolean	indicateur qui indique si l’alerte de métrique est activée.
properties.evaluationFrequency	string	fréquence à laquelle l’alerte de métrique est évaluée au format de durée ISO 8601.
properties.scopes	string[]	liste des ID de ressource auxquels cette alerte de métrique est limitée.
properties.severity	integer	Gravité de l’alerte {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	région de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire pour MultipleResourceMultipleMetricCriteria.
properties.targetResourceType	string	type de ressource des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire pour MultipleResourceMultipleMetricCriteria.
properties.windowSize	string	période (au format de durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil.
tags	object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	MetricAlertResource	D’ACCORD
Other Status Codes	ErrorResponse	BadRequest

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Create or update an alert rule

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
AdditionalInfo	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
AggregationTypeEnum	les types d’agrégation de temps des critères.
DynamicMetricCriteria	Critère de seuil dynamique.
DynamicThresholdFailingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.
DynamicThresholdOperator	Opérateur utilisé pour comparer la valeur de métrique au seuil.
DynamicThresholdSensitivity	Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.
Error
ErrorDetail	Décrit les détails d’une réponse d’erreur.
ErrorResponse	Décrit le format de la réponse d’erreur.
MetricAlertAction	Action d’alerte.
MetricAlertMultipleResourceMultipleMetricCriteria	Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.
MetricAlertResource	Ressource d’alerte de métrique.
MetricAlertResourcePatch	Ressource d’alerte de métrique pour les opérations correctives.
MetricAlertSingleResourceMultipleMetricCriteria	Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.
MetricCriteria	Critère pour filtrer les métriques.
MetricDimension	Spécifie une dimension de métrique.
Operator	opérateur de critères.
WebtestLocationAvailabilityCriteria	Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

AdditionalInfo

Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».

Nom	Type	Description
info	object	Informations supplémentaires spécifiques au type.
type	string	Type d’informations supplémentaires.

AggregationTypeEnum

les types d’agrégation de temps des critères.

Nom	Type	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

Critère de seuil dynamique.

Nom	Type	Description
alertSensitivity	DynamicThresholdSensitivity	Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.
criterionType	string: DynamicThresholdCriterion	Spécifie le type de critères de seuil
dimensions	MetricDimension[]	Liste des conditions de dimension.
failingPeriods	DynamicThresholdFailingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.
ignoreDataBefore	string	Utilisez cette option pour définir la date à partir de laquelle commencer à apprendre les données historiques des métriques et calculer les seuils dynamiques (au format ISO8601)
metricName	string	Nom de la métrique.
metricNamespace	string	Espace de noms de la métrique.
name	string	Nom des critères.
operator	DynamicThresholdOperator	Opérateur utilisé pour comparer la valeur de métrique au seuil.
skipMetricValidation	boolean	Permet de créer une règle d’alerte sur une métrique personnalisée qui n’est pas encore émise, en provoquant l’omission de la validation de la métrique.
timeAggregation	AggregationTypeEnum	les types d’agrégation de temps des critères.

DynamicThresholdFailingPeriods

Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.

Nom	Type	Description
minFailingPeriodsToAlert	number	Nombre de violations à déclencher une alerte. Doit être inférieur ou égal à numberOfEvaluationPeriods.
numberOfEvaluationPeriods	number	Nombre de points de recherche agrégés. La fenêtre de temps de recherche est calculée en fonction de la granularité d’agrégation (windowSize) et du nombre sélectionné de points agrégés.

DynamicThresholdOperator

Opérateur utilisé pour comparer la valeur de métrique au seuil.

Nom	Type	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

Étendue de l’écart requis pour déclencher une alerte. Cela aura une incidence sur la limite du seuil au modèle de série de métriques.

Nom	Type	Description
High	string
Low	string
Medium	string

Error

Nom	Type	Description
additionalInfo	AdditionalInfo[]	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
code	string	Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.
details	ErrorDetail[]	Tableau d’objets d’informations de réponse d’erreur imbriqués supplémentaires, comme décrit par ce contrat.
message	string	Décrit l’erreur en détail et fournit des informations de débogage. Si Accept-Language est défini dans la requête, elle doit être localisée dans cette langue.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorDetail

Décrit les détails d’une réponse d’erreur.

Nom	Type	Description
additionalInfo	AdditionalInfo[]	Tableau d’objets avec les propriétés « type » et « info ». Le schéma de « info » est propre au service et dépend de la chaîne « type ».
code	string	Chaîne non localisée qui peut être utilisée pour identifier l’erreur par programmation.
message	string	Décrit l’erreur en détail et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

ErrorResponse

Décrit le format de la réponse d’erreur.

Nom	Type	Description
error	Error

MetricAlertAction

Action d’alerte.

Nom	Type	Description
actionGroupId	string	ID du groupe d’actions à utiliser.
webHookProperties	object	Ce champ permet de spécifier des propriétés personnalisées, qui seraient ajoutées à la charge utile d’alerte envoyée en tant qu’entrée au webhook.

MetricAlertMultipleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour plusieurs ressources qui ont plusieurs critères de métrique.

Nom	Type	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	liste de plusieurs critères de métrique pour cette opération « tout ».
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	spécifie le type des critères d’alerte.

MetricAlertResource

Ressource d’alerte de métrique.

Nom	Type	Description
id	string	ID de ressource Azure
location	string	Emplacement des ressources
name	string	Nom de la ressource Azure
properties.actions	MetricAlertAction[]	tableau d’actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.autoMitigate	boolean	indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	définit les informations de critères d’alerte spécifiques.
properties.description	string	description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.
properties.enabled	boolean	indicateur qui indique si l’alerte de métrique est activée.
properties.evaluationFrequency	string	fréquence à laquelle l’alerte de métrique est évaluée au format de durée ISO 8601.
properties.isMigrated	boolean	valeur indiquant si cette règle d’alerte est migrée.
properties.lastUpdatedTime	string	Dernière fois que la règle a été mise à jour au format ISO8601.
properties.scopes	string[]	liste des ID de ressource auxquels cette alerte de métrique est limitée.
properties.severity	integer	Gravité de l’alerte {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	région de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.
properties.targetResourceType	string	type de ressource des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire si l’étendue contient un abonnement, un groupe de ressources ou plusieurs ressources.
properties.windowSize	string	période (au format de durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil.
tags	object	Balises de ressource
type	string	Type de ressource Azure

MetricAlertResourcePatch

Ressource d’alerte de métrique pour les opérations correctives.

Nom	Type	Description
properties.actions	MetricAlertAction[]	tableau d’actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.
properties.autoMitigate	boolean	indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	définit les informations de critères d’alerte spécifiques.
properties.description	string	description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.
properties.enabled	boolean	indicateur qui indique si l’alerte de métrique est activée.
properties.evaluationFrequency	string	fréquence à laquelle l’alerte de métrique est évaluée au format de durée ISO 8601.
properties.isMigrated	boolean	valeur indiquant si cette règle d’alerte est migrée.
properties.lastUpdatedTime	string	Dernière fois que la règle a été mise à jour au format ISO8601.
properties.scopes	string[]	liste des ID de ressource auxquels cette alerte de métrique est limitée.
properties.severity	integer	Gravité de l’alerte {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	région de la ou des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire pour MultipleResourceMultipleMetricCriteria.
properties.targetResourceType	string	type de ressource des ressources cibles sur lesquelles l’alerte est créée/mise à jour. Obligatoire pour MultipleResourceMultipleMetricCriteria.
properties.windowSize	string	période (au format de durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil.
tags	object	Balises de ressource

MetricAlertSingleResourceMultipleMetricCriteria

Spécifie les critères d’alerte de métrique pour une seule ressource qui a plusieurs critères de métrique.

Nom	Type	Description
allOf	MetricCriteria[]	Liste des critères de métrique pour cette opération « tout ».
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	spécifie le type des critères d’alerte.

MetricCriteria

Critère pour filtrer les métriques.

Nom	Type	Description
criterionType	string: StaticThresholdCriterion	Spécifie le type de critères de seuil
dimensions	MetricDimension[]	Liste des conditions de dimension.
metricName	string	Nom de la métrique.
metricNamespace	string	Espace de noms de la métrique.
name	string	Nom des critères.
operator	Operator	opérateur de critères.
skipMetricValidation	boolean	Permet de créer une règle d’alerte sur une métrique personnalisée qui n’est pas encore émise, en provoquant l’omission de la validation de la métrique.
threshold	number	valeur de seuil de critères qui active l’alerte.
timeAggregation	AggregationTypeEnum	les types d’agrégation de temps des critères.

MetricDimension

Spécifie une dimension de métrique.

Nom	Type	Description
name	string	Nom de la dimension.
operator	string	opérateur de dimension. Seuls « Include » et « Exclude » sont pris en charge
values	string[]	liste des valeurs de dimension.

Operator

opérateur de critères.

Nom	Type	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Spécifie les critères de règle d’alerte de métrique pour une ressource de test web.

Nom	Type	Description
componentId	string	ID de ressource Application Insights.
failedLocationCount	number	Nombre d’emplacements ayant échoué.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	spécifie le type des critères d’alerte.
webTestId	string	ID de test web Application Insights.