Microsoft.Insights metricAlerts 2018-03-01

Article
12/16/2024

Remarques

Pour obtenir des conseils sur le déploiement de solutions de supervision, consultez Créer des ressources de supervision à l’aide de Bicep.

Définition de ressource Bicep

Le type de ressource metricAlerts peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Insights/metricAlerts, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Insights/metricAlerts@2018-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    autoMitigate: bool
    criteria: {
      odata.type: 'string'
      // For remaining properties, see MetricAlertCriteria objects
    }
    description: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceRegion: 'string'
    targetResourceType: 'string'
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Objets MetricAlertCriteria

Définissez la propriété odata.type pour spécifier le type d’objet.

Pour Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria, utilisez :

{
  allOf: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      skipMetricValidation: bool
      timeAggregation: 'string'
      criterionType: 'string'
      // For remaining properties, see MultiMetricCriteria objects
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'
}

Pour Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria, utilisez :

{
  allOf: [
    {
      criterionType: 'string'
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
      metricNamespace: 'string'
      name: 'string'
      operator: 'string'
      skipMetricValidation: bool
      threshold: int
      timeAggregation: 'string'
    }
  ]
  odata.type: 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'
}

Pour Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria, utilisez :

{
  componentId: 'string'
  failedLocationCount: int
  odata.type: 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
  webTestId: 'string'
}

Objets MultiMetricCriteria

Définissez la propriété criterionType pour spécifier le type d’objet.

Pour DynamicThresholdCriterion, utilisez :

{
  alertSensitivity: 'string'
  criterionType: 'DynamicThresholdCriterion'
  failingPeriods: {
    minFailingPeriodsToAlert: int
    numberOfEvaluationPeriods: int
  }
  ignoreDataBefore: 'string'
  operator: 'string'
}

Pour StaticThresholdCriterion, utilisez :

{
  criterionType: 'StaticThresholdCriterion'
  operator: 'string'
  threshold: int
}

Valeurs de propriété

DynamicMetricCriteria

Nom	Description	Valeur
alertSensitivity	É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.	'High' 'Low' 'Medium' (obligatoire)
criterionType	Spécifie le type de critères de seuil	'DynamicThresholdCriterion' (obligatoire)
failingPeriods	Nombre minimal de violations requises dans la fenêtre de temps de recherche sélectionnée requise pour déclencher une alerte.	DynamicThresholdFailingPeriods (obligatoire)
ignoreDataBefore	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)	corde
opérateur	Opérateur utilisé pour comparer la valeur de métrique au seuil.	'GreaterOrLessThan' 'GreaterThan' 'LessThan' (obligatoire)

DynamicThresholdFailingPeriods

Nom	Description	Valeur
minFailingPeriodsToAlert	Nombre de violations à déclencher une alerte. Doit être inférieur ou égal à numberOfEvaluationPeriods.	int (obligatoire)
numberOfEvaluationPeriods	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.	int (obligatoire)

MetricAlertAction

Nom	Description	Valeur
actionGroupId	ID du groupe d’actions à utiliser.	corde
webHookProperties	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.	MetricAlertActionWebHookProperties

MetricAlertActionWebHookProperties

Nom	Description	Valeur

MetricAlertCriteria

Nom	Description	Valeur
odata.type	Défini sur « Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria » pour le type MetricAlertMultipleResourceMultipleMetricCriteria. Défini sur « Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria » pour le type MetricAlertSingleResourceMultipleMetricCriteria. Défini sur « Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria » pour le type WebtestLocationAvailabilityCriteria.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' (obligatoire)

MetricAlertMultipleResourceMultipleMetricCriteria

Nom	Description	Valeur
allOf	liste de plusieurs critères de métrique pour cette opération « tout ».	MultiMetricCriteria []
odata.type	spécifie le type des critères d’alerte.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' (obligatoire)

MetricAlertProperties

Nom	Description	Valeur
Actions	tableau d’actions effectuées lorsque la règle d’alerte devient active et lorsqu’une condition d’alerte est résolue.	MetricAlertAction[]
autoMitigate	indicateur qui indique si l’alerte doit être résolue automatiquement ou non. La valeur par défaut est true.	Bool
critères	définit les informations de critères d’alerte spécifiques.	MetricAlertCriteria (obligatoire)
description	description de l’alerte de métrique qui sera incluse dans l’e-mail d’alerte.	corde
Activé	indicateur qui indique si l’alerte de métrique est activée.	bool (obligatoire)
evaluationFrequency	fréquence à laquelle l’alerte de métrique est évaluée au format de durée ISO 8601.	chaîne (obligatoire)
Étendues	liste des ID de ressource auxquels cette alerte de métrique est limitée.	string[] (obligatoire)
sévérité	Gravité de l’alerte {0, 1, 2, 3, 4}	int (obligatoire)
targetResourceRegion	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.	corde
targetResourceType	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.	corde
windowSize	période (au format de durée ISO 8601) utilisée pour surveiller l’activité d’alerte en fonction du seuil.	chaîne (obligatoire)

MetricAlertSingleResourceMultipleMetricCriteria

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

MetricCriteria

Nom	Description	Valeur
criterionType	Spécifie le type de critères de seuil	'DynamicThresholdCriterion' 'StaticThresholdCriterion' (obligatoire)
taille	Liste des conditions de dimension.	MetricDimension[]
metricName	Nom de la métrique.	chaîne (obligatoire)
metricNamespace	Namespace de la métrique.	corde
nom	Nom des critères.	chaîne (obligatoire)
opérateur	opérateur de critères.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire)
skipMetricValidation	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.	Bool
seuil	valeur de seuil de critères qui active l’alerte.	int (obligatoire)
timeAggregation	les types d’agrégation de temps des critères.	'Average' 'Count' 'Maximum' 'Minimum' 'Total' (obligatoire)

MetricCriteria

Nom	Description	Valeur
criterionType	Spécifie le type de critères de seuil	'StaticThresholdCriterion' (obligatoire)
opérateur	opérateur de critères.	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (obligatoire)
seuil	valeur de seuil de critères qui active l’alerte.	int (obligatoire)

MetricDimension

Nom	Description	Valeur
nom	Nom de la dimension.	chaîne (obligatoire)
opérateur	opérateur de dimension. Seuls « Include » et « Exclude » sont pris en charge	chaîne (obligatoire)
Valeurs	liste des valeurs de dimension.	string[] (obligatoire)