Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artikel
08/15/2024

Bicep-Ressourcendefinition

Der ressourcentyp "scheduledQueryRules" 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.

Bemerkungen

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

Ressourcenformat

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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'
  }
}

Eigenschaftswerte

scheduledQueryRules

Name	Beschreibung	Wert
Name	Der Ressourcenname	Zeichenfolge (erforderlich) Zeichenlimit: 1-260 Gültige Zeichen: Kann nicht verwenden: `*<>%{}&:\\?/#\|` - oder Steuerzeichen Kann nicht mit Leerzeichen oder Punkt enden.
Ort	Der geografische Standort, an dem sich die Ressource befindet	Zeichenfolge (erforderlich)
Schilder	Ressourcentags.	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Eigenschaften	Die Regeleigenschaften der Ressource.	ScheduledQueryRuleProperties (erforderlich)

ScheduledQueryRuleProperties

Name	Beschreibung	Wert
Aktionen		Aktion[]
Kriterien	Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.	ScheduledQueryRuleCriteria
Beschreibung	Die Beschreibung der geplanten Abfrageregel.	Schnur
displayName	Der Anzeigename der Warnungsregel	Schnur
ermöglichte	Das Kennzeichen, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert sollte wahr oder falsch sein.	Bool
evaluationFrequency	Wie oft die geplante Abfrageregel im ISO 8601-Dauerformat ausgewertet wird.	Schnur
muteActionsDuration	Stummschalten sie Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde.	Schnur
overrideQueryTimeRange	Wenn angegeben, wird der Abfragezeitbereich überschrieben (Standardwert ist WindowSize*NumberOfEvaluationPeriods)	Schnur
Bereiche	Die Liste der Ressourcen-IDs, auf die diese geplante Abfrageregel eingestellt ist.	string[]
Strenge	Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten.	Int
targetResourceTypes	Liste der Ressourcentypen der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Wenn der Bereich beispielsweise eine Ressourcengruppe ist und targetResourceTypes "Microsoft.Compute/virtualMachines" ist, wird für jeden virtuellen Computer in der Ressourcengruppe, der die Warnungskriterien erfüllt, eine andere Warnung ausgelöst.	string[]
windowSize	Der Zeitraum (im ISO 8601-Dauerformat), für den die Warnungsabfrage ausgeführt wird (Bin-Größe).	Schnur

Aktion

Name	Beschreibung	Wert
actionGroupId	Aktionsgruppenressourcen-ID, die aufgerufen werden soll, wenn die Warnung ausgelöst wird.	Schnur
webHookProperties	Die Eigenschaften eines Webhook-Objekts.	ActionWebHookProperties

ActionWebHookProperties

Name	Beschreibung	Wert
{angepasste Eigenschaft}		Schnur

ScheduledQueryRuleCriteria

Name	Beschreibung	Wert
allOf	Eine Liste der Bedingungen, die für die angegebenen Bereiche ausgewertet werden sollen	Bedingung[]

Zustand

Name	Beschreibung	Wert
Dimensionen	Liste der Dimensionensbedingungen	Dimension[]
failPeriods	Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben.	ConditionFailingPeriods
metricMeasureColumn	Die Spalte, die die Metrik-Measurenummer enthält.	Schnur
Operator	Der Kriterienoperator.	"Gleich" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (erforderlich)
Frage	Protokollabfragebenachrichtigung	Schnur
resourceIdColumn	Die Spalte, die die Ressourcen-ID enthält. Der Inhalt der Spalte muss ein URI sein, der als Ressourcen-ID formatiert ist.	Schnur
Schwelle	der Schwellenwert für Kriterien, der die Warnung aktiviert.	int (erforderlich)
timeAggregation	Aggregationstyp	"Mittelwert" 'Count' "Maximum" "Minimum" "Summe" (erforderlich)

Dimension

Name	Beschreibung	Wert
Name	Name der Dimension	Zeichenfolge (erforderlich)
Operator	Operator für Dimensionswerte	"Ausschließen" "Einschließen" (erforderlich)
Werte	Liste der Dimensionswerte	string[] (erforderlich)

ConditionFailingPeriods

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

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer Warnungsregel für Azure-Geschäftskontinuitätselemente	Diese Vorlagen erstellen eine Warnungsregel und vom Benutzer zugewiesene MSI.This templates creates an alert rule and user assigned MSI. Außerdem weist sie dem Abonnement den MSI-Readerzugriff zu, damit die Warnungsregel Zugriff auf die erforderlichen geschützten Elemente und die neuesten Details des Wiederherstellungspunkts hat.

ARM-Vorlagenressourcendefinition

Der ressourcentyp "scheduledQueryRules" 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.

Bemerkungen

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

Ressourcenformat

Um eine Microsoft.Insights/scheduledQueryRules-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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"
  }
}

Eigenschaftswerte

scheduledQueryRules

Name	Beschreibung	Wert
Art	Der Ressourcentyp	"Microsoft.Insights/scheduledQueryRules"
apiVersion	Die Ressourcen-API-Version	"2020-05-01-preview"
Name	Der Ressourcenname	Zeichenfolge (erforderlich) Zeichenlimit: 1-260 Gültige Zeichen: Kann nicht verwenden: `*<>%{}&:\\?/#\|` - oder Steuerzeichen Kann nicht mit Leerzeichen oder Punkt enden.
Ort	Der geografische Standort, an dem sich die Ressource befindet	Zeichenfolge (erforderlich)
Schilder	Ressourcentags.	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Eigenschaften	Die Regeleigenschaften der Ressource.	ScheduledQueryRuleProperties (erforderlich)

ScheduledQueryRuleProperties

Name	Beschreibung	Wert
Aktionen		Aktion[]
Kriterien	Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.	ScheduledQueryRuleCriteria
Beschreibung	Die Beschreibung der geplanten Abfrageregel.	Schnur
displayName	Der Anzeigename der Warnungsregel	Schnur
ermöglichte	Das Kennzeichen, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert sollte wahr oder falsch sein.	Bool
evaluationFrequency	Wie oft die geplante Abfrageregel im ISO 8601-Dauerformat ausgewertet wird.	Schnur
muteActionsDuration	Stummschalten sie Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde.	Schnur
overrideQueryTimeRange	Wenn angegeben, wird der Abfragezeitbereich überschrieben (Standardwert ist WindowSize*NumberOfEvaluationPeriods)	Schnur
Bereiche	Die Liste der Ressourcen-IDs, auf die diese geplante Abfrageregel eingestellt ist.	string[]
Strenge	Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten.	Int
targetResourceTypes	Liste der Ressourcentypen der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Wenn der Bereich beispielsweise eine Ressourcengruppe ist und targetResourceTypes "Microsoft.Compute/virtualMachines" ist, wird für jeden virtuellen Computer in der Ressourcengruppe, der die Warnungskriterien erfüllt, eine andere Warnung ausgelöst.	string[]
windowSize	Der Zeitraum (im ISO 8601-Dauerformat), für den die Warnungsabfrage ausgeführt wird (Bin-Größe).	Schnur

Aktion

Name	Beschreibung	Wert
actionGroupId	Aktionsgruppenressourcen-ID, die aufgerufen werden soll, wenn die Warnung ausgelöst wird.	Schnur
webHookProperties	Die Eigenschaften eines Webhook-Objekts.	ActionWebHookProperties

ActionWebHookProperties

Name	Beschreibung	Wert
{angepasste Eigenschaft}		Schnur

ScheduledQueryRuleCriteria

Name	Beschreibung	Wert
allOf	Eine Liste der Bedingungen, die für die angegebenen Bereiche ausgewertet werden sollen	Bedingung[]

Zustand

Name	Beschreibung	Wert
Dimensionen	Liste der Dimensionensbedingungen	Dimension[]
failPeriods	Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben.	ConditionFailingPeriods
metricMeasureColumn	Die Spalte, die die Metrik-Measurenummer enthält.	Schnur
Operator	Der Kriterienoperator.	"Gleich" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (erforderlich)
Frage	Protokollabfragebenachrichtigung	Schnur
resourceIdColumn	Die Spalte, die die Ressourcen-ID enthält. Der Inhalt der Spalte muss ein URI sein, der als Ressourcen-ID formatiert ist.	Schnur
Schwelle	der Schwellenwert für Kriterien, der die Warnung aktiviert.	int (erforderlich)
timeAggregation	Aggregationstyp	"Mittelwert" 'Count' "Maximum" "Minimum" "Summe" (erforderlich)

Dimension

Name	Beschreibung	Wert
Name	Name der Dimension	Zeichenfolge (erforderlich)
Operator	Operator für Dimensionswerte	"Ausschließen" "Einschließen" (erforderlich)
Werte	Liste der Dimensionswerte	string[] (erforderlich)

ConditionFailingPeriods

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

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen einer Warnungsregel für Azure-Geschäftskontinuitätselemente	Diese Vorlagen erstellen eine Warnungsregel und vom Benutzer zugewiesene MSI.This templates creates an alert rule and user assigned MSI. Außerdem weist sie dem Abonnement den MSI-Readerzugriff zu, damit die Warnungsregel Zugriff auf die erforderlichen geschützten Elemente und die neuesten Details des Wiederherstellungspunkts hat.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der ressourcentyp "scheduledQueryRules" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Ressourcengruppen

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

Ressourcenformat

Um eine Microsoft.Insights/scheduledQueryRules-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
    }
  })
}

Eigenschaftswerte

scheduledQueryRules

Name	Beschreibung	Wert
Art	Der Ressourcentyp	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
Name	Der Ressourcenname	Zeichenfolge (erforderlich) Zeichenlimit: 1-260 Gültige Zeichen: Kann nicht verwenden: `*<>%{}&:\\?/#\|` - oder Steuerzeichen Kann nicht mit Leerzeichen oder Punkt enden.
Ort	Der geografische Standort, an dem sich die Ressource befindet	Zeichenfolge (erforderlich)
parent_id	Verwenden Sie die ID dieser Ressourcengruppe, um sie in einer Ressourcengruppe bereitzustellen.	Zeichenfolge (erforderlich)
Schilder	Ressourcentags.	Wörterbuch der Tagnamen und -werte.
Eigenschaften	Die Regeleigenschaften der Ressource.	ScheduledQueryRuleProperties (erforderlich)

ScheduledQueryRuleProperties

Name	Beschreibung	Wert
Aktionen		Aktion[]
Kriterien	Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.	ScheduledQueryRuleCriteria
Beschreibung	Die Beschreibung der geplanten Abfrageregel.	Schnur
displayName	Der Anzeigename der Warnungsregel	Schnur
ermöglichte	Das Kennzeichen, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert sollte wahr oder falsch sein.	Bool
evaluationFrequency	Wie oft die geplante Abfrageregel im ISO 8601-Dauerformat ausgewertet wird.	Schnur
muteActionsDuration	Stummschalten sie Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde.	Schnur
overrideQueryTimeRange	Wenn angegeben, wird der Abfragezeitbereich überschrieben (Standardwert ist WindowSize*NumberOfEvaluationPeriods)	Schnur
Bereiche	Die Liste der Ressourcen-IDs, auf die diese geplante Abfrageregel eingestellt ist.	string[]
Strenge	Schweregrad der Warnung. Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten.	Int
targetResourceTypes	Liste der Ressourcentypen der Zielressource(n), für die die Warnung erstellt/aktualisiert wird. Wenn der Bereich beispielsweise eine Ressourcengruppe ist und targetResourceTypes "Microsoft.Compute/virtualMachines" ist, wird für jeden virtuellen Computer in der Ressourcengruppe, der die Warnungskriterien erfüllt, eine andere Warnung ausgelöst.	string[]
windowSize	Der Zeitraum (im ISO 8601-Dauerformat), für den die Warnungsabfrage ausgeführt wird (Bin-Größe).	Schnur

Aktion

Name	Beschreibung	Wert
actionGroupId	Aktionsgruppenressourcen-ID, die aufgerufen werden soll, wenn die Warnung ausgelöst wird.	Schnur
webHookProperties	Die Eigenschaften eines Webhook-Objekts.	ActionWebHookProperties

ActionWebHookProperties

Name	Beschreibung	Wert
{angepasste Eigenschaft}		Schnur

ScheduledQueryRuleCriteria

Name	Beschreibung	Wert
allOf	Eine Liste der Bedingungen, die für die angegebenen Bereiche ausgewertet werden sollen	Bedingung[]

Zustand

Name	Beschreibung	Wert
Dimensionen	Liste der Dimensionensbedingungen	Dimension[]
failPeriods	Die minimale Anzahl von Verletzungen, die innerhalb des ausgewählten Nachschlagezeitfensters erforderlich sind, um eine Warnung auszuheben.	ConditionFailingPeriods
metricMeasureColumn	Die Spalte, die die Metrik-Measurenummer enthält.	Schnur
Operator	Der Kriterienoperator.	"Gleich" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (erforderlich)
Frage	Protokollabfragebenachrichtigung	Schnur
resourceIdColumn	Die Spalte, die die Ressourcen-ID enthält. Der Inhalt der Spalte muss ein URI sein, der als Ressourcen-ID formatiert ist.	Schnur
Schwelle	der Schwellenwert für Kriterien, der die Warnung aktiviert.	int (erforderlich)
timeAggregation	Aggregationstyp	"Mittelwert" "Anzahl" "Maximum" "Minimum" "Summe" (erforderlich)

Dimension

Name	Beschreibung	Wert
Name	Name der Dimension	Zeichenfolge (erforderlich)
Operator	Operator für Dimensionswerte	"Ausschließen" "Einschließen" (erforderlich)
Werte	Liste der Dimensionswerte	string[] (erforderlich)

ConditionFailingPeriods

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

Freigeben über

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Bicep-Ressourcendefinition

Bemerkungen

Ressourcenformat

Eigenschaftswerte

scheduledQueryRules

ScheduledQueryRuleProperties

Aktion

ActionWebHookProperties

ScheduledQueryRuleCriteria

Zustand

Dimension

ConditionFailingPeriods

Schnellstartvorlagen

ARM-Vorlagenressourcendefinition

Bemerkungen

Ressourcenformat

Eigenschaftswerte

scheduledQueryRules

ScheduledQueryRuleProperties

Aktion

ActionWebHookProperties

ScheduledQueryRuleCriteria

Zustand

Dimension

ConditionFailingPeriods

Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

scheduledQueryRules

ScheduledQueryRuleProperties

Aktion

ActionWebHookProperties

ScheduledQueryRuleCriteria

Zustand

Dimension

ConditionFailingPeriods

Feedback

Zusätzliche Ressourcen