Microsoft.Insights scheduledQueryRules 01-08-2021

  • Artikel

Bicep-resourcedefinitie

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

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Opmerkingen

Zie Bewakingsresources maken met bicep voor hulp bij het implementeren van bewakingsoplossingen.

Resource-indeling

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2021-08-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      customProperties: {}
    }
    autoMitigate: bool
    checkWorkspaceAlertsStorageConfigured: bool
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          metricName: '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
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

Eigenschapswaarden

scheduledQueryRules

Naam Description Waarde
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-260

Geldige tekens:
Kan het volgende niet gebruiken:
*<>%{}&:\\?/# of besturingstekens

Kan niet eindigen met een spatie of punt.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
Soort Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert. 'LogAlert'
'LogToMetric'
properties De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)

ScheduledQueryRuleProperties

Naam Description Waarde
acties Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. Acties
autoMitigate De vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is true. Alleen relevant voor regels van het type LogAlert. booleaans
checkWorkspaceAlertsStorageConfigured De vlag die aangeeft of deze geplande queryregel moet worden opgeslagen in de opslag van de klant. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. tekenreeks
displayName De weergavenaam van de waarschuwingsregel tekenreeks
enabled De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn booleaans
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd, wordt weergegeven in iso 8601-duurnotatie. Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks
muteActionsDuration Acties dempen gedurende de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. Alleen relevant voor regels van het type LogAlert. tekenreeks
overschrijvenQueryTimeRange Indien opgegeven overschrijft het querytijdbereik (standaard is WindowSize*NumberOfEvaluationPeriods). Alleen relevant voor regels van het type LogAlert. tekenreeks
bereiken De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
ernst Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert. int
skipQueryValidation De vlag die aangeeft of de opgegeven query moet worden gevalideerd of niet. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
targetResourceTypes Lijst met het resourcetype 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. Alleen relevant voor regels van het type LogAlert tekenreeks[]
windowSize De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks

Acties

Naam Description Waarde
actionGroups Resource-id's van actiegroep die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. tekenreeks[]
Customproperties De eigenschappen van een waarschuwingspayload. object

ScheduledQueryRuleCriteria

Naam Description Waarde
allOf Een lijst met voorwaarden om te evalueren op de opgegeven bereiken Voorwaarde[]

Voorwaarde

Naam Description Waarde
Dimensies Voorwaarden voor lijst met dimensies Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist binnen het geselecteerde terugbliktijdvenster dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert. ConditionFailingPeriods
metricMeasureColumn De kolom met het metrische meetnummer. Alleen relevant voor regels van het type LogAlert. tekenreeks
metricName De naam van het metrische gegeven dat moet worden verzonden. Relevant en alleen vereist voor regels van het type LogToMetric. tekenreeks
operator De criteriaoperator. Relevant en alleen vereist voor regels van het type LogAlert. 'Is gelijk aan'
'GreaterThan'
'GreaterThanOrequal'
'LessThan'
'LessThanOrequal'
query Waarschuwing voor logboekquery's tekenreeks
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id. Alleen relevant voor regels van het type LogAlert. tekenreeks
threshold de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. Relevant en alleen vereist voor regels van het type LogAlert. int
timeAggregation Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert. 'Gemiddeld'
'Aantal'
'Maximum'
'Minimum'
'Totaal'

Dimensie

Naam Description Waarde
naam Naam van de dimensie tekenreeks (vereist)
operator Operator voor dimensiewaarden 'Uitsluiten'
'Opnemen' (vereist)
values Lijst met dimensiewaarden tekenreeks[] (vereist)

ConditionFailingPeriods

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

Resourcedefinitie van ARM-sjabloon

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

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Opmerkingen

Zie Bewakingsresources maken met bicep voor hulp bij het implementeren van bewakingsoplossingen.

Resource-indeling

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2021-08-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "customProperties": {}
    },
    "autoMitigate": "bool",
    "checkWorkspaceAlertsStorageConfigured": "bool",
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "metricName": "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",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

Eigenschapswaarden

scheduledQueryRules

Naam Description Waarde
type Het resourcetype 'Microsoft.Insights/scheduledQueryRules'
apiVersion De resource-API-versie '2021-08-01'
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-260

Geldige tekens:
Kan het volgende niet gebruiken:
*<>%{}&:\\?/# of besturingstekens

Kan niet eindigen met een spatie of punt.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken
Soort Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert. 'LogAlert'
'LogToMetric'
properties De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)

ScheduledQueryRuleProperties

Naam Description Waarde
acties Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. Acties
autoMitigate De vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is true. Alleen relevant voor regels van het type LogAlert. booleaans
checkWorkspaceAlertsStorageConfigured De vlag die aangeeft of deze geplande queryregel moet worden opgeslagen in de opslag van de klant. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. tekenreeks
displayName De weergavenaam van de waarschuwingsregel tekenreeks
enabled De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn booleaans
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd, wordt weergegeven in iso 8601-duurnotatie. Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks
muteActionsDuration Acties dempen gedurende de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. Alleen relevant voor regels van het type LogAlert. tekenreeks
overschrijvenQueryTimeRange Indien opgegeven overschrijft het querytijdbereik (standaard is WindowSize*NumberOfEvaluationPeriods). Alleen relevant voor regels van het type LogAlert. tekenreeks
bereiken De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
ernst Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert. int
skipQueryValidation De vlag die aangeeft of de opgegeven query moet worden gevalideerd of niet. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
targetResourceTypes Lijst met het resourcetype 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. Alleen relevant voor regels van het type LogAlert tekenreeks[]
windowSize De periode (in iso 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks

Acties

Naam Description Waarde
actionGroups Resource-id's van actiegroep die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. tekenreeks[]
Customproperties De eigenschappen van een nettolading van een waarschuwing. object

ScheduledQueryRuleCriteria

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

Voorwaarde

Naam Description Waarde
Dimensies Voorwaarden voor lijst met dimensies Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist binnen het geselecteerde tijdvenster voor lookback dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert. ConditionFailingPeriods
metricMeasureColumn De kolom met het metrische meetnummer. Alleen relevant voor regels van het type LogAlert. tekenreeks
metricName De naam van het metrische gegeven dat moet worden verzonden. Relevant en alleen vereist voor regels van het type LogToMetric. tekenreeks
operator De operator criteria. Relevant en alleen vereist voor regels van het type LogAlert. 'Is gelijk aan'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'
query Waarschuwing voor logboekquery tekenreeks
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id. Alleen relevant voor regels van het type LogAlert. tekenreeks
threshold de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. Relevant en alleen vereist voor regels van het type LogAlert. int
timeAggregation Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert. 'Gemiddeld'
'Aantal'
Maximum
'Minimum'
Totaal

Dimensie

Naam Description Waarde
naam Naam van de dimensie tekenreeks (vereist)
operator Operator voor dimensiewaarden 'Uitsluiten'
'Opnemen' (vereist)
values Lijst met dimensiewaarden tekenreeks[] (vereist)

ConditionFailingPeriods

Naam Description Waarde
minFailingPeriodsToAlert Het aantal schendingen dat een waarschuwing moet activeren. 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

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2021-08-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        customProperties = {}
      }
      autoMitigate = bool
      checkWorkspaceAlertsStorageConfigured = bool
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            metricName = "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
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
    kind = "string"
  })
}

Eigenschapswaarden

scheduledQueryRules

Naam Description Waarde
type Het resourcetype "Microsoft.Insights/scheduledQueryRules@2021-08-01"
naam De resourcenaam tekenreeks (vereist)

Tekenlimiet: 1-260

Geldige tekens:
Kan het volgende niet gebruiken:
*<>%{}&:\\?/# of besturingstekens

Kan niet eindigen met spatie of punt.
location De geografische locatie waar de resource zich bevindt tekenreeks (vereist)
parent_id Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. tekenreeks (vereist)
tags Resourcetags. Woordenlijst met tagnamen en -waarden.
Soort Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert. "LogAlert"
"LogToMetric"
properties De regeleigenschappen van de resource. ScheduledQueryRuleProperties (vereist)

ScheduledQueryRuleProperties

Naam Description Waarde
acties Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. Acties
autoMitigate De vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is true. Alleen relevant voor regels van het type LogAlert. booleaans
checkWorkspaceAlertsStorageConfigured De vlag die aangeeft of deze geplande queryregel moet worden opgeslagen in de opslag van de klant. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
Criteria De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd. ScheduledQueryRuleCriteria
beschrijving De beschrijving van de geplande queryregel. tekenreeks
displayName De weergavenaam van de waarschuwingsregel tekenreeks
enabled De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet true of false zijn booleaans
evaluationFrequency Hoe vaak de geplande queryregel wordt geëvalueerd, weergegeven in de ISO 8601-duurnotatie. Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks
muteActionsDuration Acties dempen voor de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. Alleen relevant voor regels van het type LogAlert. tekenreeks
overrideQueryTimeRange Indien opgegeven overschrijft het querytijdbereik (standaard is WindowSize*NumberOfEvaluationPeriods). Alleen relevant voor regels van het type LogAlert. tekenreeks
bereiken De lijst met resource-id's waarop deze geplande queryregel is gericht. tekenreeks[]
ernst Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert. int
skipQueryValidation De vlag die aangeeft of de opgegeven query moet worden gevalideerd of niet. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert. booleaans
targetResourceTypes Lijst met het resourcetype 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. Alleen relevant voor regels van het type LogAlert tekenreeks[]
windowSize De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). Relevant en alleen vereist voor regels van het type LogAlert. tekenreeks

Acties

Naam Description Waarde
actionGroups Resource-id's van actiegroep die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd. tekenreeks[]
Customproperties De eigenschappen van een waarschuwingspayload. object

ScheduledQueryRuleCriteria

Naam Description Waarde
allOf Een lijst met voorwaarden om te evalueren op de opgegeven bereiken Voorwaarde[]

Voorwaarde

Naam Description Waarde
Dimensies Voorwaarden voor lijst met dimensies Dimensie[]
failPeriods Het minimale aantal schendingen dat is vereist binnen het geselecteerde terugbliktijdvenster dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert. ConditionFailingPeriods
metricMeasureColumn De kolom met het metrische meetnummer. Alleen relevant voor regels van het type LogAlert. tekenreeks
metricName De naam van het metrische gegeven dat moet worden verzonden. Relevant en alleen vereist voor regels van het type LogToMetric. tekenreeks
operator De criteriaoperator. Relevant en alleen vereist voor regels van het type LogAlert. "Is gelijk aan"
"GreaterThan"
"GreaterThanOrequal"
"LessThan"
"LessThanOrequal"
query Waarschuwing voor logboekquery's tekenreeks
resourceIdColumn De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id. Alleen relevant voor regels van het type LogAlert. tekenreeks
threshold de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. Relevant en alleen vereist voor regels van het type LogAlert. int
timeAggregation Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert. "Gemiddeld"
"Aantal"
"Maximum"
"Minimum"
"Totaal"

Dimensie

Naam Description Waarde
naam Naam van de dimensie tekenreeks (vereist)
operator Operator voor dimensiewaarden "Uitsluiten"
"Opnemen" (vereist)
values Lijst met dimensiewaarden tekenreeks[] (vereist)

ConditionFailingPeriods

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