Microsoft.Insights metricAlerts 2018-03-01

Artykuł
12/16/2024

Uwagi

Aby uzyskać wskazówki dotyczące wdrażania rozwiązań do monitorowania, zobacz Create monitoring resources by using Bicep.

Definicja zasobu Bicep

Typ zasobu metricAlerts można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/metricAlerts, dodaj następujący kod Bicep do szablonu.

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

Obiekty MetricAlertCriteria

Ustaw właściwość odata.type, aby określić typ obiektu.

W przypadku Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteriaużyj:

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

W przypadku Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteriaużyj:

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

W przypadku Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteriaużyj:

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

Obiekty MultiMetricCriteria

Ustaw właściwość type, aby określić typ obiektu.

W przypadku DynamicThresholdCriterionużyj:

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

W przypadku StaticThresholdCriterionużyj:

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

Wartości właściwości

DynamicMetricCriteria

Nazwa	Opis	Wartość
alertSensitivity	Zakres odchylenia wymagany do wyzwolenia alertu. Będzie to miało wpływ na to, jak mocno próg jest do wzorca serii metryk.	"Wysoki" "Niski" "Średni" (wymagany)
criterionType	Określa typ kryteriów progowych	"DynamicThresholdCriterion" (wymagane)
failPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu.	DynamicThresholdFailingPeriods (wymagane)
ignoreDataBefore	Użyj tej opcji, aby ustawić datę, od której chcesz rozpocząć naukę danych historycznych metryk i obliczyć progi dynamiczne (w formacie ISO8601)	struna
operator	Operator używany do porównywania wartości metryki z progiem.	"GreaterOrLessThan" "GreaterThan" "LessThan" (wymagany)

DynamicThresholdFailingPeriods

Nazwa	Opis	Wartość
minFailingPeriodsToAlert	Liczba naruszeń wyzwalania alertu. Powinna być mniejsza lub równa numberOfEvaluationPeriods.	int (wymagane)
numberOfEvaluationPeriods	Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów.	int (wymagane)

MetricAlertAction

Nazwa	Opis	Wartość
actionGroupId	identyfikator grupy akcji do użycia.	struna
webHookProperties	To pole umożliwia określenie właściwości niestandardowych, które zostaną dołączone do ładunku alertu wysłanego jako dane wejściowe do elementu webhook.	MetricAlertActionWebHookProperties

MetricAlertActionWebHookProperties

Nazwa	Opis	Wartość

MetricAlertCriteria

Nazwa	Opis	Wartość
odata.type	Ustaw wartość "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" dla typu MetricAlertMultipleResourceMultipleMetricCriteria. Ustaw wartość "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" dla typu MetricAlertSingleResourceMultipleMetricCriteria. Ustaw wartość "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" dla typu WebtestLocationAvailabilityCriteria.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" (wymagane)

MetricAlertMultipleResourceMultipleMetricCriteria

Nazwa	Opis	Wartość
allOf	lista wielu kryteriów metryk dla tej operacji "wszystkie".	MultiMetricCriteria[]
odata.type	określa typ kryteriów alertu.	"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" (wymagane)

Właściwości MetricAlertProperties

Nazwa	Opis	Wartość
akcje	tablica akcji, które są wykonywane, gdy reguła alertu stanie się aktywna, i gdy warunek alertu zostanie rozwiązany.	MetricAlertAction[]
autoMitigate	flaga wskazująca, czy alert powinien zostać automatycznie rozwiązany, czy nie. Wartość domyślna to true.	Bool
Kryteria	definiuje określone informacje o kryteriach alertu.	MetricAlertCriteria (wymagane)
opis	opis alertu dotyczącego metryk, który zostanie uwzględniony w wiadomości e-mail z alertem.	struna
Włączone	flaga wskazująca, czy alert metryki jest włączony.	bool (wymagane)
evaluationFrequency	częstotliwość oceniania alertu metryki w formacie czasu trwania ISO 8601.	ciąg (wymagany)
Zakresów	lista identyfikatorów zasobów, do których ma zakres ten alert metryki.	string[] (wymagane)
dotkliwość	Ważność alertu {0, 1, 2, 3, 4}	int (wymagane)
targetResourceRegion	region zasobów docelowych, na których jest tworzony/aktualizowany alert. Obowiązkowy, jeśli zakres zawiera subskrypcję, grupę zasobów lub więcej niż jeden zasób.	struna
targetResourceType	typ zasobu zasobów docelowych, na których jest tworzony/aktualizowany alert. Obowiązkowy, jeśli zakres zawiera subskrypcję, grupę zasobów lub więcej niż jeden zasób.	struna
windowSize	okres czasu (w formacie czasu trwania ISO 8601) używany do monitorowania aktywności alertów na podstawie progu.	ciąg (wymagany)

MetricAlertSingleResourceMultipleMetricCriteria

Nazwa	Opis	Wartość
allOf	Lista kryteriów metryk dla tej operacji "wszystkie".	MetricCriteria[]
odata.type	określa typ kryteriów alertu.	"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" (wymagane)

MetricCriteria

Nazwa	Opis	Wartość
criterionType	Określa typ kryteriów progowych	"DynamicThresholdCriterion" "StaticThresholdCriterion" (wymagane)
Wymiary	Lista warunków wymiarów.	MetricDimension[]
metricName	Nazwa metryki.	ciąg (wymagany)
metricNamespace	Przestrzeń nazw metryki.	struna
nazwa	Nazwa kryteriów.	ciąg (wymagany)
operator	operator kryteriów.	"Równa się" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane)
skipMetricValidation	Umożliwia utworzenie reguły alertu dla metryki niestandardowej, która nie jest jeszcze emitowana, powodując pomijanie walidacji metryk.	Bool
próg	wartość progowa kryteriów, która aktywuje alert.	int (wymagane)
timeAggregation	kryteria agregacji czasu.	"Średnia" "Liczba" "Maksimum" "Minimum" "Total" (wymagane)

MetricCriteria

Nazwa	Opis	Wartość
criterionType	Określa typ kryteriów progowych	"StaticThresholdCriterion" (wymagane)
operator	operator kryteriów.	"Równa się" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane)
próg	wartość progowa kryteriów, która aktywuje alert.	int (wymagane)

MetricDimension

Nazwa	Opis	Wartość
nazwa	Nazwa wymiaru.	ciąg (wymagany)
operator	operator wymiaru. Obsługiwane są tylko "Dołączanie" i "Wykluczanie"	ciąg (wymagany)
Wartości	lista wartości wymiarów.	string[] (wymagane)