Microsoft.Insights metricAlerts

Artikel
12/16/2024

Opmerkingen

Zie Bewakingsbronnen maken met Bicepvoor hulp bij het implementeren van bewakingsoplossingen.

Bicep-resourcedefinitie

Het resourcetype metricAlerts kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.Insights/metricAlerts-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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-objecten

Stel de eigenschap odata.type in om het type object op te geven.

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

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

Gebruik voor Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria:

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

MultiMetricCriteria-objecten

Stel de eigenschap criterionType in om het type object op te geven.

Gebruik voor DynamicThresholdCriterion:

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

Gebruik voor StaticThresholdCriterion:

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

Eigenschapswaarden

DynamicMetricCriteria

Naam	Beschrijving	Waarde
alertSensitivity	De mate van afwijking die is vereist voor het activeren van een waarschuwing. Dit is van invloed op hoe strak de drempelwaarde is voor het patroon van de metrische reeks.	'Hoog' 'Laag' Gemiddeld (vereist)
criteriumType	Hiermee geeft u het type drempelwaarden op	DynamicThresholdCriterion (vereist)
failPeriods	Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren.	DynamicThresholdFailingPeriods (vereist)
ignoreDataBefore	Gebruik deze optie om de datum in te stellen van waaruit u de historische metrische gegevens wilt leren en de dynamische drempelwaarden (in ISO8601 notatie) wilt berekenen	snaar
bediener	De operator die wordt gebruikt om de metrische waarde te vergelijken met de drempelwaarde.	'GreaterOrLessThan' 'GreaterThan' LessThan (vereist)

DynamicThresholdFailingPeriods

Naam	Beschrijving	Waarde
minFailingPeriodsToAlert	Het aantal schendingen dat een waarschuwing activeert. Moet kleiner of gelijk zijn aan numberOfEvaluationPeriods.	int (vereist)
numberOfEvaluationPeriods	Het aantal geaggregeerde lookbackpunten. Het tijdvenster voor lookback wordt berekend op basis van de aggregatiegranulariteit (windowSize) en het geselecteerde aantal geaggregeerde punten.	int (vereist)

MetricAlertAction

Naam	Beschrijving	Waarde
actionGroupId	de id van de actiegroep die moet worden gebruikt.	snaar
webHookProperties	Met dit veld kunt u aangepaste eigenschappen opgeven, die worden toegevoegd aan de nettolading van de waarschuwing die als invoer naar de webhook wordt verzonden.	MetricAlertActionWebHookProperties

MetricAlertActionWebHookProperties

Naam	Beschrijving	Waarde

MetricAlertCriteria

Naam	Beschrijving	Waarde
odata.type	Ingesteld op 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' voor het type MetricAlertMultipleResourceMultipleMetricCriteria. Ingesteld op 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' voor het type MetricAlertSingleResourceMultipleMetricCriteria. Ingesteld op 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' voor het type WebtestLocationAvailabilityCriteria.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' (vereist)

MetricAlertMultipleResourceMultipleMetricCriteria

Naam	Beschrijving	Waarde
allOf	de lijst met meerdere metrische criteria voor deze 'all'-bewerking.	MultiMetricCriteria[]
odata.type	geeft het type van de waarschuwingscriteria op.	'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' (vereist)

MetricAlertProperties

Naam	Beschrijving	Waarde
Acties	de matrix van acties die worden uitgevoerd wanneer de waarschuwingsregel actief wordt en wanneer een waarschuwingsvoorwaarde is opgelost.	MetricAlertAction[]
autoMitigate	de vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is waar.	Bool
Criteria	definieert de specifieke informatie over waarschuwingscriteria.	MetricAlertCriteria (vereist)
beschrijving	de beschrijving van de metrische waarschuwing die wordt opgenomen in de waarschuwings-e-mail.	snaar
Ingeschakeld	de vlag die aangeeft of de waarschuwing voor metrische gegevens is ingeschakeld.	bool (vereist)
evaluationFrequency	hoe vaak de waarschuwing voor metrische gegevens wordt geëvalueerd in iso 8601-duurnotatie.	tekenreeks (vereist)
Scopes	de lijst met resource-id's waarop deze metrische waarschuwing is gericht.	tekenreeks[] (vereist)
strengheid	Ernst van waarschuwing {0, 1, 2, 3, 4}	int (vereist)
targetResourceRegion	de regio van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Verplicht als het bereik een abonnement, resourcegroep of meer dan één resource bevat.	snaar
targetResourceType	het resourcetype van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Verplicht als het bereik een abonnement, resourcegroep of meer dan één resource bevat.	snaar
windowSize	de periode (in ISO 8601-duurnotatie) die wordt gebruikt voor het bewaken van waarschuwingsactiviteiten op basis van de drempelwaarde.	tekenreeks (vereist)

MetricAlertSingleResourceMultipleMetricCriteria

Naam	Beschrijving	Waarde
allOf	De lijst met metrische criteria voor deze 'all'-bewerking.	MetricCriteria[]
odata.type	geeft het type van de waarschuwingscriteria op.	'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' (vereist)

MetricCriteria

Naam	Beschrijving	Waarde
criteriumType	Hiermee geeft u het type drempelwaarden op	'DynamicThresholdCriterion' 'StaticThresholdCriterion' (vereist)
Dimensies	Lijst met dimensievoorwaarden.	MetricDimension[]
metricName	Naam van de metrische waarde.	tekenreeks (vereist)
metricNamespace	Naamruimte van de metrische waarde.	snaar
naam	Naam van de criteria.	tekenreeks (vereist)
bediener	de criteriumoperator.	'Is gelijk aan' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' LessThanOrEqual (vereist)
skipMetricValidation	Hiermee kunt u een waarschuwingsregel maken voor een aangepaste metrische waarde die nog niet is verzonden, door ervoor te zorgen dat de metrische validatie wordt overgeslagen.	Bool
drempel	de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd.	int (vereist)
timeAggregation	de aggregatietypen voor criteriatijd.	'Gemiddelde' 'Aantal' 'Maximum' 'Minimum' Totaal (vereist)

MetricCriteria

Naam	Beschrijving	Waarde
criteriumType	Hiermee geeft u het type drempelwaarden op	'StaticThresholdCriterion' (vereist)
bediener	de criteriumoperator.	'Is gelijk aan' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' LessThanOrEqual (vereist)
drempel	de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd.	int (vereist)

MetricDimension

Naam	Beschrijving	Waarde
naam	Naam van de dimensie.	tekenreeks (vereist)
bediener	de dimensieoperator. Alleen Opnemen en Uitsluiten worden ondersteund	tekenreeks (vereist)
waarden	lijst met dimensiewaarden.	tekenreeks[] (vereist)