Delen via


Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Opmerkingen

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

Bicep-resourcedefinitie

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

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

Resource-indeling

Als u een Resource Microsoft.Insights/scheduledQueryRules wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Eigenschapswaarden

Actie

Naam Beschrijving Waarde
actionGroupId Resource-id van actiegroep die moet worden aangeroepen wanneer de waarschuwing wordt geactiveerd. snaar
webHookProperties De eigenschappen van een webhookobject. ActionWebHookProperties-

ActionWebHookProperties

Naam Beschrijving Waarde

Conditie

Naam Beschrijving Waarde
Dimensies Lijst met dimensievoorwaarden Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren. ConditionFailingPeriods
metricMeasureColumn De kolom met het meetnummer van de metrische waarde. snaar
bediener De criteriumoperator. 'Is gelijk aan'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
LessThanOrEqual (vereist)
vraag Waarschuwing voor logboekquery snaar
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id snaar
drempel de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. int (vereist)
timeAggregation Aggregatietype 'Gemiddelde'
'Aantal'
'Maximum'
'Minimum'
Totaal (vereist)

ConditionFailingPeriods

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

Dimensie

Naam Beschrijving Waarde
naam Naam van de dimensie tekenreeks (vereist)
bediener Operator voor dimensiewaarden 'Uitsluiten'
'Opnemen' (vereist)
waarden Lijst met dimensiewaarden tekenreeks[] (vereist)

Microsoft.Insights/scheduledQueryRules

Naam Beschrijving Waarde
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[^#<>%&:\?/{}*]{1,260}$ (vereist)
Eigenschappen De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen

ScheduledQueryRuleCriteria

Naam Beschrijving Waarde
allOf Een lijst met voorwaarden die moeten worden geëvalueerd op basis van de opgegeven bereiken Voorwaarde[]

ScheduledQueryRuleProperties

Naam Beschrijving Waarde
Acties actie[]
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. snaar
displayName De weergavenaam van de waarschuwingsregel snaar
Ingeschakeld De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn Bool
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd in iso 8601-duurnotatie. snaar
muteActionsDuration Demp acties voor de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. snaar
overrideQueryTimeRange Als dit is opgegeven, wordt het tijdsbereik van de query overschreven (standaard is WindowSize*NumberOfEvaluationPeriods) snaar
Scopes De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
strengheid Ernst van de waarschuwing. Moet een geheel getal tussen [0-4] zijn. De waarde van 0 is het zwaarst Int
targetResourceTypes Lijst met resourcetypen van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Als het bereik bijvoorbeeld een resourcegroep is en targetResourceTypes Microsoft.Compute/virtualMachines is, wordt er een andere waarschuwing geactiveerd voor elke virtuele machine in de resourcegroep die voldoet aan de waarschuwingscriteria tekenreeks[]
windowSize De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). snaar

TrackedResourceTags

Naam Beschrijving Waarde

Resourcedefinitie van ARM-sjabloon

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

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

Resource-indeling

Als u een Resource Microsoft.Insights/scheduledQueryRules wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {
          "{customized property}": "string"
        }
      }
    ],
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "scopes": [ "string" ],
    "severity": "int",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschapswaarden

Actie

Naam Beschrijving Waarde
actionGroupId Resource-id van actiegroep die moet worden aangeroepen wanneer de waarschuwing wordt geactiveerd. snaar
webHookProperties De eigenschappen van een webhookobject. ActionWebHookProperties-

ActionWebHookProperties

Naam Beschrijving Waarde

Conditie

Naam Beschrijving Waarde
Dimensies Lijst met dimensievoorwaarden Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren. ConditionFailingPeriods
metricMeasureColumn De kolom met het meetnummer van de metrische waarde. snaar
bediener De criteriumoperator. 'Is gelijk aan'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
LessThanOrEqual (vereist)
vraag Waarschuwing voor logboekquery snaar
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id snaar
drempel de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. int (vereist)
timeAggregation Aggregatietype 'Gemiddelde'
'Aantal'
'Maximum'
'Minimum'
Totaal (vereist)

ConditionFailingPeriods

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

Dimensie

Naam Beschrijving Waarde
naam Naam van de dimensie tekenreeks (vereist)
bediener Operator voor dimensiewaarden 'Uitsluiten'
'Opnemen' (vereist)
waarden Lijst met dimensiewaarden tekenreeks[] (vereist)

Microsoft.Insights/scheduledQueryRules

Naam Beschrijving Waarde
apiVersion De API-versie '2020-05-01-preview'
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[^#<>%&:\?/{}*]{1,260}$ (vereist)
Eigenschappen De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden. Zie Tags in sjablonen
type Het resourcetype 'Microsoft.Insights/scheduledQueryRules'

ScheduledQueryRuleCriteria

Naam Beschrijving Waarde
allOf Een lijst met voorwaarden die moeten worden geëvalueerd op basis van de opgegeven bereiken Voorwaarde[]

ScheduledQueryRuleProperties

Naam Beschrijving Waarde
Acties actie[]
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. snaar
displayName De weergavenaam van de waarschuwingsregel snaar
Ingeschakeld De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn Bool
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd in iso 8601-duurnotatie. snaar
muteActionsDuration Demp acties voor de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. snaar
overrideQueryTimeRange Als dit is opgegeven, wordt het tijdsbereik van de query overschreven (standaard is WindowSize*NumberOfEvaluationPeriods) snaar
Scopes De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
strengheid Ernst van de waarschuwing. Moet een geheel getal tussen [0-4] zijn. De waarde van 0 is het zwaarst Int
targetResourceTypes Lijst met resourcetypen van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Als het bereik bijvoorbeeld een resourcegroep is en targetResourceTypes Microsoft.Compute/virtualMachines is, wordt er een andere waarschuwing geactiveerd voor elke virtuele machine in de resourcegroep die voldoet aan de waarschuwingscriteria tekenreeks[]
windowSize De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). snaar

TrackedResourceTags

Naam Beschrijving Waarde

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon Beschrijving
Waarschuwingsregel maken voor azure-items voor bedrijfscontinuïteit

implementeren in Azure
Met deze sjablonen maakt u een waarschuwingsregel en door de gebruiker toegewezen MSI. Ook wordt de MSI-lezer toegang tot het abonnement toegewezen, zodat de waarschuwingsregel toegang heeft om query's uit te voeren op de vereiste beveiligde items en de meest recente details van het herstelpunt.

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

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

Resource-indeling

Als u een Resource Microsoft.Insights/scheduledQueryRules wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {
            {customized property} = "string"
          }
        }
      ]
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      scopes = [
        "string"
      ]
      severity = int
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

Eigenschapswaarden

Actie

Naam Beschrijving Waarde
actionGroupId Resource-id van actiegroep die moet worden aangeroepen wanneer de waarschuwing wordt geactiveerd. snaar
webHookProperties De eigenschappen van een webhookobject. ActionWebHookProperties-

ActionWebHookProperties

Naam Beschrijving Waarde

Conditie

Naam Beschrijving Waarde
Dimensies Lijst met dimensievoorwaarden Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist in het geselecteerde tijdvenster voor terugkijken dat is vereist om een waarschuwing te genereren. ConditionFailingPeriods
metricMeasureColumn De kolom met het meetnummer van de metrische waarde. snaar
bediener De criteriumoperator. 'Is gelijk aan'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
LessThanOrEqual (vereist)
vraag Waarschuwing voor logboekquery snaar
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id snaar
drempel de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. int (vereist)
timeAggregation Aggregatietype 'Gemiddelde'
'Aantal'
'Maximum'
'Minimum'
Totaal (vereist)

ConditionFailingPeriods

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

Dimensie

Naam Beschrijving Waarde
naam Naam van de dimensie tekenreeks (vereist)
bediener Operator voor dimensiewaarden 'Uitsluiten'
'Opnemen' (vereist)
waarden Lijst met dimensiewaarden tekenreeks[] (vereist)

Microsoft.Insights/scheduledQueryRules

Naam Beschrijving Waarde
plaats De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
naam De resourcenaam string

Beperkingen:
Patroon = ^[^#<>%&:\?/{}*]{1,260}$ (vereist)
Eigenschappen De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)
Tags Resourcetags Woordenlijst met tagnamen en -waarden.
type Het resourcetype "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"

ScheduledQueryRuleCriteria

Naam Beschrijving Waarde
allOf Een lijst met voorwaarden die moeten worden geëvalueerd op basis van de opgegeven bereiken Voorwaarde[]

ScheduledQueryRuleProperties

Naam Beschrijving Waarde
Acties actie[]
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. snaar
displayName De weergavenaam van de waarschuwingsregel snaar
Ingeschakeld De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn Bool
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd in iso 8601-duurnotatie. snaar
muteActionsDuration Demp acties voor de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. snaar
overrideQueryTimeRange Als dit is opgegeven, wordt het tijdsbereik van de query overschreven (standaard is WindowSize*NumberOfEvaluationPeriods) snaar
Scopes De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
strengheid Ernst van de waarschuwing. Moet een geheel getal tussen [0-4] zijn. De waarde van 0 is het zwaarst Int
targetResourceTypes Lijst met resourcetypen van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Als het bereik bijvoorbeeld een resourcegroep is en targetResourceTypes Microsoft.Compute/virtualMachines is, wordt er een andere waarschuwing geactiveerd voor elke virtuele machine in de resourcegroep die voldoet aan de waarschuwingscriteria tekenreeks[]
windowSize De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). snaar

TrackedResourceTags

Naam Beschrijving Waarde