Scheduled Query Rules - Get

Referenz

Dienst:: Monitor

API-Version:: 2021-08-01

Rufen Sie eine Definition einer geplanten Abfrageregel ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2021-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
ruleName	path	True	string	Der Name der Regel.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ScheduledQueryRuleResource	Erfolgreiche Anforderung zum Abrufen einer geplanten Abfrageregel
Other Status Codes	ErrorContract	BadRequest

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get a scheduled query rule for single resource

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
  "name": "perf",
  "type": "microsoft.insights/scheduledqueryrules",
  "location": "eastus",
  "tags": {},
  "properties": {
    "description": "Performance rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
    ],
    "windowSize": "PT10M",
    "criteria": {
      "allOf": [
        {
          "query": "Perf | where ObjectName == \"Processor\"",
          "timeAggregation": "Average",
          "metricMeasureColumn": "% Processor Time",
          "resourceIdColumn": "resourceId",
          "dimensions": [
            {
              "name": "ComputerIp",
              "operator": "Exclude",
              "values": [
                "192.168.1.1"
              ]
            },
            {
              "name": "OSType",
              "operator": "Include",
              "values": [
                "*"
              ]
            }
          ],
          "operator": "GreaterThan",
          "threshold": 70,
          "failingPeriods": {
            "numberOfEvaluationPeriods": 1,
            "minFailingPeriodsToAlert": 1
          }
        }
      ]
    },
    "muteActionsDuration": "PT30M",
    "actions": {
      "actionGroups": [
        "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
      ],
      "customProperties": {
        "key11": "value11",
        "key12": "value12"
      }
    },
    "autoMitigate": true,
    "isWorkspaceAlertsStorageConfigured": true,
    "checkWorkspaceAlertsStorageConfigured": true,
    "skipQueryValidation": true
  }
}

Definitionen

Name	Beschreibung
Actions	Aktionen, die aufgerufen werden sollen, wenn die Warnung ausgelöst wird.
AlertSeverity	Schweregrad der Warnung Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und erforderlich nur für Regeln der Art LogAlert.
Condition	Eine Bedingung der geplanten Abfrageregel.
conditionOperator	Der Kriterienoperator. Relevant und erforderlich nur für Regeln der Art LogAlert.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
Dimension	Definition der Dimensionsaufteilung und -filterung
dimensionOperator	Operator für Dimensionswerte
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorContract	Beschreibt das Format der Fehlerantwort.
ErrorResponse	Fehlerantwort
FailingPeriods	Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen. Relevant nur für Regeln der Art LogAlert.
Kind	Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert.
ScheduledQueryRuleCriteria	Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.
ScheduledQueryRuleResource	Die Ressource der geplanten Abfrageregel.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
timeAggregation	Aggregationstyp. Relevant und erforderlich nur für Regeln der Art LogAlert.

Actions

Aktionen, die aufgerufen werden sollen, wenn die Warnung ausgelöst wird.

Name	Typ	Beschreibung
actionGroups	string[]	Aktionsgruppenressourcen-IDs, die aufgerufen werden sollen, wenn die Warnung ausgelöst wird.
customProperties	object	Die Eigenschaften einer Warnungsnutzlast.

AlertSeverity

Schweregrad der Warnung Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und erforderlich nur für Regeln der Art LogAlert.

Name	Typ	Beschreibung
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Eine Bedingung der geplanten Abfrageregel.

Name	Typ	Beschreibung
dimensions	Dimension[]	Liste der Dimensionsbedingungen
failingPeriods	FailingPeriods	Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen. Relevant nur für Regeln der Art LogAlert.
metricMeasureColumn	string	Die Spalte, die die Metrik-Measurenummer enthält. Relevant nur für Regeln der Art LogAlert.
metricName	string	Der Name der zu sendenden Metrik. Relevant und erforderlich nur für Regeln der Art LogToMetric.
operator	conditionOperator	Der Kriterienoperator. Relevant und erforderlich nur für Regeln der Art LogAlert.
query	string	Protokollabfragewarnung
resourceIdColumn	string	Die Spalte, die die Ressourcen-ID enthält. Der Inhalt der Spalte muss ein URI sein, der als Ressourcen-ID formatiert ist. Relevant nur für Regeln der Art LogAlert.
threshold	number	der Schwellenwert für Kriterien, der die Warnung aktiviert. Relevant und erforderlich nur für Regeln der Art LogAlert.
timeAggregation	timeAggregation	Aggregationstyp. Relevant und erforderlich nur für Regeln der Art LogAlert.

conditionOperator

Der Kriterienoperator. Relevant und erforderlich nur für Regeln der Art LogAlert.

Name	Typ	Beschreibung
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Definition der Dimensionsaufteilung und -filterung

Name	Typ	Beschreibung
name	string	Name der Dimension
operator	dimensionOperator	Operator für Dimensionswerte
values	string[]	Liste der Dimensionswerte

dimensionOperator

Operator für Dimensionswerte

Name	Typ	Beschreibung
Exclude	string
Include	string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorContract

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Die Fehlerdetails.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorResponse[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

FailingPeriods

Die mindeste Anzahl von Verstößen, die innerhalb des ausgewählten Lookbackzeitfensters erforderlich sind, um eine Warnung auszulösen. Relevant nur für Regeln der Art LogAlert.

Name	Typ	Standardwert	Beschreibung
minFailingPeriodsToAlert	integer	1	Die Anzahl der Verstöße, die eine Warnung auslösen sollen. Sollte kleiner oder gleich numberOfEvaluationPeriods sein. Der Standardwert ist 1.
numberOfEvaluationPeriods	integer	1	Die Anzahl aggregierter Lookbackpunkte. Das Lookbackzeitfenster wird basierend auf der Aggregationsgranularität (windowSize) und der ausgewählten Anzahl aggregierter Punkte berechnet. Der Standardwert ist 1.

Kind

Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert.

Name	Typ	Beschreibung
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.

Name	Typ	Beschreibung
allOf	Condition[]	Eine Liste der Bedingungen, die anhand der angegebenen Bereiche ausgewertet werden sollen

ScheduledQueryRuleResource

Die Ressource der geplanten Abfrageregel.

Name	Typ	Beschreibung
etag	string	Das etag-Feld ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie gemäß der normalen etag-Konvention auch als Header bereitgestellt werden. Entitätstags werden verwendet, um zwei oder mehr Entitäten aus derselben angeforderten Ressource zu vergleichen. HTTP/1.1 verwendet Entitätstags in den Kopfzeilenfeldern etag (Abschnitt 14.19), If-Match (Abschnitt 14.24), If-None-Match (Abschnitt 14.26) und If-Range (Abschnitt 14.27).
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Gibt den Typ der geplanten Abfrageregel an. Der Standardwert ist LogAlert.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.actions	Actions	Aktionen, die aufgerufen werden sollen, wenn die Warnung ausgelöst wird.
properties.autoMitigate	boolean	Das Flag, das angibt, ob die Warnung automatisch aufgelöst werden soll. Der Standardwert ist „true“. Relevant nur für Regeln der Art LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Das Flag, das angibt, ob diese geplante Abfrageregel im Speicher des Kunden gespeichert werden soll. Die Standardeinstellung ist „false“. Relevant nur für Regeln der Art LogAlert.
properties.createdWithApiVersion	string	Die api-Version, die beim Erstellen dieser Warnungsregel verwendet wird
properties.criteria	ScheduledQueryRuleCriteria	Die Regelkriterien, die die Bedingungen der geplanten Abfrageregel definieren.
properties.description	string	Die Beschreibung der geplanten Abfrageregel.
properties.displayName	string	Der Anzeigename der Warnungsregel
properties.enabled	boolean	Das Flag, das angibt, ob diese geplante Abfrageregel aktiviert ist. Der Wert muss "true" oder "false" sein.
properties.evaluationFrequency	string	Gibt an, wie oft die geplante Abfrageregel ausgewertet wird, dargestellt im ISO 8601-Dauerformat. Relevant und erforderlich nur für Regeln der Art LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	True, wenn es sich bei der Warnungsregel um eine Legacyregel für die Protokollanalyse handelt
properties.isWorkspaceAlertsStorageConfigured	boolean	Das Flag, das angibt, ob diese geplante Abfrageregel für die Speicherung im Speicher des Kunden konfiguriert wurde. Die Standardeinstellung ist „false“.
properties.muteActionsDuration	string	Stummschalten von Aktionen für den ausgewählten Zeitraum (im ISO 8601-Dauerformat), nachdem die Warnung ausgelöst wurde. Relevant nur für Regeln der Art LogAlert.
properties.overrideQueryTimeRange	string	Wenn angegeben, überschreibt den Abfragezeitbereich (Standardwert: WindowSize*NumberOfEvaluationPeriods). Relevant nur für Regeln der Art LogAlert.
properties.scopes	string[]	Die Liste der Ressourcen-IDs, für die diese geplante Abfrageregel gilt.
properties.severity	AlertSeverity	Schweregrad der Warnung Sollte eine ganze Zahl zwischen [0-4] sein. Der Wert 0 ist am schwerwiegendsten. Relevant und erforderlich nur für Regeln der Art LogAlert.
properties.skipQueryValidation	boolean	Das Flag, das angibt, ob die bereitgestellte Abfrage überprüft werden soll oder nicht. Die Standardeinstellung ist „false“. Relevant nur für Regeln der Art LogAlert.
properties.targetResourceTypes	string[]	Liste des Ressourcentyps der Zielressourcen, 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. Nur relevant für Regeln der Art LogAlert
properties.windowSize	string	Der Zeitraum (im ISO 8601-Dauerformat), in dem die Warnungsabfrage ausgeführt wird (Bin-Größe). Relevant und erforderlich nur für Regeln der Art LogAlert.
systemData	systemData	SystemDaten von ScheduledQueryRule.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

timeAggregation

Aggregationstyp. Relevant und erforderlich nur für Regeln der Art LogAlert.

Name	Typ	Beschreibung
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

Freigeben über