Scheduled Query Rules - Get

Odwołanie

Usługa:: Monitor

Wersja interfejsu API:: 2021-08-01

Pobierz definicję reguły zaplanowanego zapytania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
ruleName	path	True	string	Nazwa reguły.
subscriptionId	path	True	string minLength: 1	Identyfikator subskrypcji docelowej.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ScheduledQueryRuleResource	Pomyślne żądanie pobrania reguły zaplanowanego zapytania
Other Status Codes	ErrorContract	NieprawidłoweŻądanie

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get a scheduled query rule for single resource

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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
  }
}

Definicje

Nazwa	Opis
Actions	Akcje do wywołania, gdy alert zostanie wyzwolony.
AlertSeverity	Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
Condition	Warunek reguły zaplanowanego zapytania.
conditionOperator	Operator kryteriów. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
createdByType	Typ tożsamości, która utworzyła zasób.
Dimension	Definicja dzielenia i filtrowania wymiarów
dimensionOperator	Operator dla wartości wymiarów
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorContract	Opisuje format odpowiedzi Błąd.
ErrorResponse	Odpowiedź na błąd
FailingPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu. Dotyczy tylko reguł rodzaju LogAlert.
Kind	Wskazuje typ reguły zaplanowanego zapytania. Wartość domyślna to LogAlert.
ScheduledQueryRuleCriteria	Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.
ScheduledQueryRuleResource	Zasób reguły zaplanowanej kwerendy.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
timeAggregation	Typ agregacji. Istotne i wymagane tylko dla reguł rodzaju LogAlert.

Actions

Objekt

Akcje do wywołania, gdy alert zostanie wyzwolony.

Nazwa	Typ	Opis
actionGroups	string[]	Identyfikatory zasobów grupy akcji do wywołania, gdy alert zostanie wyzwolony.
customProperties	object	Właściwości ładunku alertu.

AlertSeverity

Wyliczanie

Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa. Istotne i wymagane tylko dla reguł rodzaju LogAlert.

Wartość	Opis
0
1
2
3
4

Condition

Objekt

Warunek reguły zaplanowanego zapytania.

Nazwa	Typ	Opis
dimensions	Dimension[]	Lista warunków wymiarów
failingPeriods	FailingPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu. Dotyczy tylko reguł rodzaju LogAlert.
metricMeasureColumn	string	Kolumna zawierająca numer miary metryki. Dotyczy tylko reguł rodzaju LogAlert.
metricName	string	Nazwa metryki do wysłania. Odpowiednie i wymagane tylko dla reguł rodzaju LogToMetric.
operator	conditionOperator	Operator kryteriów. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
query	string	Alert zapytania dziennika
resourceIdColumn	string	Kolumna zawierająca identyfikator zasobu. Zawartość kolumny musi być identyfikatorem URI sformatowanym jako identyfikator zasobu. Dotyczy tylko reguł rodzaju LogAlert.
threshold	number (double)	wartość progowa kryteriów, która aktywuje alert. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
timeAggregation	timeAggregation	Typ agregacji. Istotne i wymagane tylko dla reguł rodzaju LogAlert.

conditionOperator

Wyliczanie

Operator kryteriów. Istotne i wymagane tylko dla reguł rodzaju LogAlert.

Wartość	Opis
Equals
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

Dimension

Objekt

Definicja dzielenia i filtrowania wymiarów

Nazwa	Typ	Opis
name	string	Nazwa wymiaru
operator	dimensionOperator	Operator dla wartości wymiarów
values	string[]	Lista wartości wymiarów

dimensionOperator

Wyliczanie

Operator dla wartości wymiarów

Wartość	Opis
Exclude
Include

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorContract

Objekt

Opisuje format odpowiedzi Błąd.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd Szczegóły błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorResponse[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

FailingPeriods

Objekt

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu. Dotyczy tylko reguł rodzaju LogAlert.

Nazwa	Typ	Domyślna wartość	Opis
minFailingPeriodsToAlert	integer (int64)	1	Liczba naruszeń wyzwalania alertu. Powinna być mniejsza lub równa numberOfEvaluationPeriods. Wartość domyślna to 1
numberOfEvaluationPeriods	integer (int64)	1	Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów. Wartość domyślna to 1

Kind

Wyliczanie

Wskazuje typ reguły zaplanowanego zapytania. Wartość domyślna to LogAlert.

Wartość	Opis
LogAlert
LogToMetric

ScheduledQueryRuleCriteria

Objekt

Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.

Nazwa	Typ	Opis
allOf	Condition[]	Lista warunków do oceny pod kątem określonych zakresów

ScheduledQueryRuleResource

Objekt

Zasób reguły zaplanowanej kwerendy.

Nazwa	Typ	Opis
etag	string	Pole etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją etag. Tagi jednostek są używane do porównywania co najmniej dwóch jednostek z tego samego żądanego zasobu. Protokół HTTP/1.1 używa tagów jednostek w elemecie etag (sekcja 14.19), If-Match (sekcja 14.24), if-None-Match (sekcja 14.26) i If-Range (sekcja 14.27) pól nagłówka.
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Wskazuje typ reguły zaplanowanego zapytania. Wartość domyślna to LogAlert.
location	string	Lokalizacja geograficzna, w której znajduje się zasób
name	string	Nazwa zasobu
properties.actions	Actions	Akcje do wywołania, gdy alert zostanie wyzwolony.
properties.autoMitigate	boolean	Flaga wskazująca, czy alert powinien zostać automatycznie rozwiązany, czy nie. Wartość domyślna to true. Dotyczy tylko reguł rodzaju LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Flaga wskazująca, czy ta zaplanowana reguła zapytania powinna być przechowywana w magazynie klienta. Wartość domyślna to false. Dotyczy tylko reguł rodzaju LogAlert.
properties.createdWithApiVersion	string	Wersja interfejsu API używana podczas tworzenia tej reguły alertu
properties.criteria	ScheduledQueryRuleCriteria	Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.
properties.description	string	Opis reguły zaplanowanego zapytania.
properties.displayName	string	Nazwa wyświetlana reguły alertu
properties.enabled	boolean	Flaga wskazująca, czy ta zaplanowana reguła zapytania jest włączona. Wartość powinna mieć wartość true lub false
properties.evaluationFrequency	string (duration)	Częstotliwość oceniania reguły zaplanowanego zapytania jest reprezentowana w formacie czasu trwania ISO 8601. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	Prawda, jeśli reguła alertu jest starszą regułą analizy dzienników
properties.isWorkspaceAlertsStorageConfigured	boolean	Flaga wskazująca, czy ta zaplanowana reguła zapytania została skonfigurowana do przechowywania w magazynie klienta. Wartość domyślna to false.
properties.muteActionsDuration	string (duration)	Akcje wyciszania dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu. Dotyczy tylko reguł rodzaju LogAlert.
properties.overrideQueryTimeRange	string (duration)	Jeśli zostanie określony, zastąpi zakres czasu zapytania (wartość domyślna to WindowSize*NumberOfEvaluationPeriods). Dotyczy tylko reguł rodzaju LogAlert.
properties.scopes	string[]	Lista identyfikatorów zasobów, do których jest ograniczona ta zaplanowana reguła zapytania.
properties.severity	AlertSeverity (int64)	Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa. Istotne i wymagane tylko dla reguł rodzaju LogAlert.
properties.skipQueryValidation	boolean	Flaga wskazująca, czy podane zapytanie powinno zostać zweryfikowane, czy nie. Wartość domyślna to false. Dotyczy tylko reguł rodzaju LogAlert.
properties.targetResourceTypes	string[]	Lista typów zasobów docelowych zasobów, na których jest tworzony/aktualizowany alert. Jeśli na przykład zakres to grupa zasobów, a targetResourceTypes to Microsoft.Compute/virtualMachines, zostanie wyzwolony inny alert dla każdej maszyny wirtualnej w grupie zasobów, która spełnia kryteria alertu. Istotne tylko dla reguł rodzaju LogAlert
properties.windowSize	string (duration)	Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika). Istotne i wymagane tylko dla reguł rodzaju LogAlert.
systemData	systemData	SystemData of ScheduledQueryRule.
tags	object	Tagi zasobów.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

timeAggregation

Wyliczanie

Typ agregacji. Istotne i wymagane tylko dla reguł rodzaju LogAlert.

Wartość	Opis
Average
Count
Maximum
Minimum
Total

Udostępnij za pośrednictwem

Scheduled Query Rules - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Get a scheduled query rule for single resource

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Actions

AlertSeverity

Condition

conditionOperator

createdByType

Dimension

dimensionOperator

ErrorAdditionalInfo

ErrorContract

ErrorResponse

FailingPeriods

Kind

ScheduledQueryRuleCriteria

ScheduledQueryRuleResource

systemData

timeAggregation

Dodatkowe zasoby