Microsoft.Insights metricAlerts 2018-03-01

Artikel
12/16/2024

Bemerkungen

Anleitungen zum Bereitstellen von Überwachungslösungen finden Sie unter Erstellen von Überwachungsressourcen mithilfe von Bicep.

Bicep-Ressourcendefinition

Der Ressourcentyp "metricAlerts" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Insights/metricAlerts-Ressource zu erstellen, fügen Sie ihrer Vorlage die folgende Bicep hinzu.

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

MetricAlertCriteria-Objekte

Legen Sie die odata.type-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria:

{
  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'
}

Verwenden Sie für Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria:

{
  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'
}

Verwenden Sie für Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria:

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

MultiMetricCriteria-Objekte

Legen Sie die criterionType--Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für DynamicThresholdCriterion:

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

Verwenden Sie für StaticThresholdCriterion:

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

Eigenschaftswerte

DynamicMetricCriteria

Name	Beschreibung	Wert
alertSensitivity	Der Umfang der Abweichung, die erforderlich ist, um eine Warnung auszulösen. Dies wirkt sich darauf aus, wie eng der Schwellenwert für das metrische Reihenmuster ist.	"Hoch" "Niedrig" "Mittel" (erforderlich)
criterionType	Gibt den Typ der Schwellenwertkriterien an.	"DynamicThresholdCriterion" (erforderlich)
failPeriods	Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben.	DynamicThresholdFailingPeriods (erforderlich)
ignoreDataBefore	Verwenden Sie diese Option, um das Datum festzulegen, ab dem sie mit dem Erlernen der metrischen Verlaufsdaten beginnen und die dynamischen Schwellenwerte (im ISO8601 Format) berechnen möchten.	Schnur
Operator	Der Operator, der zum Vergleichen des Metrikwerts mit dem Schwellenwert verwendet wird.	"GreaterOrLessThan" "GreaterThan" "LessThan" (erforderlich)

DynamicThresholdFailingPeriods

Name	Beschreibung	Wert
minFailingPeriodsToAlert	Die Anzahl der Verletzungen, um eine Warnung auszulösen. Sollte kleiner oder gleich "NumberOfEvaluationPeriods" sein.	int (erforderlich)
numberOfEvaluationPeriods	Die Anzahl der aggregierten Lookbackpunkte. Das Nachschlagezeitfenster wird basierend auf der Aggregations granularität (windowSize) und der ausgewählten Anzahl aggregierter Punkte berechnet.	int (erforderlich)

MetricAlertAction

Name	Beschreibung	Wert
actionGroupId	die ID der zu verwendenden Aktionsgruppe.	Schnur
webHookProperties	Dieses Feld ermöglicht das Angeben von benutzerdefinierten Eigenschaften, die an die Warnungsnutzlast angefügt werden, die als Eingabe an den Webhook gesendet wird.	MetricAlertActionWebHookProperties-

MetricAlertActionWebHookProperties

Name	Beschreibung	Wert

MetricAlertCriteria

Name	Beschreibung	Wert
odata.type	Set to 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' for type MetricAlertMultipleResourceMultipleMetricCriteria. Set to 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' for type MetricAlertSingleResourceMultipleMetricCriteria. Auf "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" für den Typ WebtestLocationAvailabilityCriteriafestgelegt.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" (erforderlich)

MetricAlertMultipleResourceMultipleMetricCriteria

Name	Beschreibung	Wert
allOf	die Liste mit mehreren Metrikkriterien für diesen "all of"-Vorgang.	MultiMetricCriteria[]
odata.type	Gibt den Typ der Warnungskriterien an.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" (erforderlich)

MetricAlertProperties

Name	Beschreibung	Wert
Aktionen	das Array von Aktionen, die ausgeführt werden, wenn die Warnungsregel aktiv wird und wenn eine Warnungsbedingung aufgelöst wird.	MetricAlertAction-[]
autoMitigate	das Kennzeichen, das angibt, ob die Warnung automatisch aufgelöst werden soll oder nicht. Der Standardwert ist "true".	Bool
Kriterien	definiert die spezifischen Warnungskriterieninformationen.	MetricAlertCriteria (erforderlich)
Beschreibung	die Beschreibung der Metrikwarnung, die in die Benachrichtigungs-E-Mail aufgenommen wird.	Schnur
ermöglichte	das Flag, das angibt, ob die Metrikwarnung aktiviert ist.	bool (erforderlich)
evaluationFrequency	wie oft die Metrikwarnung im ISO 8601-Dauerformat ausgewertet wird.	Zeichenfolge (erforderlich)
Bereiche	die Liste der Ressourcen-IDs, auf die diese Metrikwarnung abgegrenzt ist.	string[] (erforderlich)
Strenge	Warnungsschweregrad {0, 1, 2, 3, 4}	int (erforderlich)
targetResourceRegion	die Region der Zielressource(n), in der die Warnung erstellt/aktualisiert wird. Obligatorisch, wenn der Bereich ein Abonnement, eine Ressourcengruppe oder mehrere Ressourcen enthält.	Schnur
targetResourceType	der Ressourcentyp der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Obligatorisch, wenn der Bereich ein Abonnement, eine Ressourcengruppe oder mehrere Ressourcen enthält.	Schnur
windowSize	den Zeitraum (im ISO 8601-Dauerformat), der zum Überwachen der Warnungsaktivität basierend auf dem Schwellenwert verwendet wird.	Zeichenfolge (erforderlich)

MetricAlertSingleResourceMultipleMetricCriteria

Name	Beschreibung	Wert
allOf	Die Liste der Metrikkriterien für diesen "all of"-Vorgang.	MetricCriteria[]
odata.type	Gibt den Typ der Warnungskriterien an.	"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" (erforderlich)

MetricCriteria

Name	Beschreibung	Wert
criterionType	Gibt den Typ der Schwellenwertkriterien an.	"DynamicThresholdCriterion" "StaticThresholdCriterion" (erforderlich)
Dimensionen	Liste der Dimensionsbedingungen.	MetricDimension[]
metricName	Name der Metrik.	Zeichenfolge (erforderlich)
metricNamespace	Namespace der Metrik.	Schnur
Name	Name der Kriterien.	Zeichenfolge (erforderlich)
Operator	den Kriterienoperator.	"Gleich" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (erforderlich)
skipMetricValidation	Ermöglicht das Erstellen einer Warnungsregel für eine benutzerdefinierte Metrik, die noch nicht ausgegeben wird, indem die Metriküberprüfung übersprungen wird.	Bool
Schwelle	der Schwellenwert für Kriterien, der die Warnung aktiviert.	int (erforderlich)
timeAggregation	die Kriterien-Zeitaggregationstypen.	"Mittelwert" 'Count' "Maximum" "Minimum" "Summe" (erforderlich)

MetricCriteria

Name	Beschreibung	Wert
criterionType	Gibt den Typ der Schwellenwertkriterien an.	"StaticThresholdCriterion" (erforderlich)
Operator	den Kriterienoperator.	"Gleich" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (erforderlich)
Schwelle	der Schwellenwert für Kriterien, der die Warnung aktiviert.	int (erforderlich)

Metrikdimension

Name	Beschreibung	Wert
Name	Name der Dimension.	Zeichenfolge (erforderlich)
Operator	der Bemaßungsoperator. Es werden nur 'Include' und 'Exclude' unterstützt.	Zeichenfolge (erforderlich)
Werte	Liste der Dimensionswerte.	string[] (erforderlich)