Scheduled Query Rules - Create Or Update

  • Odwołanie
Service:
Monitor
API Version:
2021-08-01

Tworzy lub aktualizuje zaplanowaną regułę zapytania.

PUT 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

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
ruleName
 path True

string

Nazwa reguły.
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Wymagane Typ Opis
location True

string

Lokalizacja geograficzna, w której znajduje się zasób
properties.criteria True

ScheduledQueryRuleCriteria

Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.
properties.enabled True

boolean

Flaga wskazująca, czy ta zaplanowana reguła zapytania jest włączona. Wartość powinna mieć wartość true lub false
properties.scopes True

string[]

Lista identyfikatorów zasobów, do których jest ograniczona ta zaplanowana reguła zapytania.
kind

Kind

Wskazuje typ reguły zaplanowanego zapytania. Wartość domyślna to LogAlert.
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ścią domyślną jest false. Dotyczy tylko reguł rodzaju LogAlert.
properties.description

string

Opis reguły zaplanowanego zapytania.
properties.displayName

string

Nazwa wyświetlana reguły alertu
properties.evaluationFrequency

string

Częstotliwość oceniania zaplanowanej reguły zapytania w formacie czasu trwania ISO 8601. Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
properties.muteActionsDuration

string

Akcje wyciszenia dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu. Dotyczy tylko reguł rodzaju LogAlert.
properties.overrideQueryTimeRange

string

Jeśli zostanie określony, zastępuje zakres czasu zapytania (wartość domyślna to WindowSize*NumberOfEvaluationPeriods). Dotyczy tylko reguł rodzaju LogAlert.
properties.severity

AlertSeverity

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

boolean

Flaga wskazująca, czy podane zapytanie powinno zostać zweryfikowane, czy nie. Wartością domyślną jest 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 element docelowyResourceTypes 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

Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika). Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
tags

object

Tagi zasobów.

Odpowiedzi

Nazwa Typ Opis
200 OK

ScheduledQueryRuleResource

Pomyślne żądanie zaktualizowania reguły zaplanowanego zapytania
201 Created

ScheduledQueryRuleResource

Utworzono zaplanowaną regułę zapytania
Other Status Codes

ErrorContract

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Create or update a scheduled query rule for Single Resource
Create or update a scheduled query rule on Resource group(s)
Create or update a scheduled query rule on Subscription

Create or update a scheduled query rule for Single Resource

Sample Request

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

{
  "location": "eastus",
  "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,
    "checkWorkspaceAlertsStorageConfigured": true,
    "skipQueryValidation": true
  }
}

Sample Response

Status code:
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
  }
}
Status code:
201 
{
  "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
  }
}

Create or update a scheduled query rule on Resource group(s)

Sample Request

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

{
  "location": "eastus",
  "properties": {
    "description": "Health check rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "windowSize": "PT10M",
    "criteria": {
      "allOf": [
        {
          "query": "Heartbeat",
          "timeAggregation": "Count",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 360,
          "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,
    "checkWorkspaceAlertsStorageConfigured": true,
    "skipQueryValidation": true
  }
}

Sample Response

Status code:
200 
{
  "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
  "name": "heartbeat",
  "type": "microsoft.insights/scheduledqueryrules",
  "location": "eastus",
  "tags": {},
  "properties": {
    "description": "Health check rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "windowSize": "PT10M",
    "criteria": {
      "allOf": [
        {
          "query": "Heartbeat",
          "timeAggregation": "Count",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 360,
          "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
  }
}
Status code:
201 
{
  "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
  "name": "heartbeat",
  "type": "microsoft.insights/scheduledqueryrules",
  "location": "eastus",
  "tags": {},
  "properties": {
    "description": "Health check rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "windowSize": "PT10M",
    "criteria": {
      "allOf": [
        {
          "query": "Heartbeat",
          "timeAggregation": "Count",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 360,
          "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
  }
}

Create or update a scheduled query rule on Subscription

Sample Request

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

{
  "location": "eastus",
  "properties": {
    "description": "Performance rule",
    "severity": 4,
    "enabled": true,
    "evaluationFrequency": "PT5M",
    "scopes": [
      "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "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,
    "checkWorkspaceAlertsStorageConfigured": true,
    "skipQueryValidation": true
  }
}

Sample Response

Status code:
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"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "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
  }
}
Status code:
201 
{
  "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"
    ],
    "targetResourceTypes": [
      "Microsoft.Compute/virtualMachines"
    ],
    "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. Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
Condition

Warunek reguły zaplanowanego zapytania.
conditionOperator

Operator kryteriów. Odpowiednie 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 na błąd.
ErrorResponse

Odpowiedź na błąd
FailingPeriods

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganego do wywołania 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. Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.

Actions

Akcje do wywołania, gdy alert zostanie wyzwolony.

Nazwa Typ Opis
actionGroups

string[]

Identyfikatory zasobów grupy akcji, które mają być wywoływane, gdy alert zostanie wyzwolony.
customProperties

object

Właściwości ładunku alertu.

AlertSeverity

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

Nazwa Typ Opis
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

Condition

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 wymaganego do wywołania 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. Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
query

string

Alert dotyczący 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

wartość progowa kryteriów, która aktywuje alert. Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
timeAggregation

timeAggregation

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

conditionOperator

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

Nazwa Typ Opis
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

createdByType

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

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

Dimension

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

Operator dla wartości wymiarów

Nazwa Typ Opis
Exclude

string

Include

string

ErrorAdditionalInfo

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorContract

Opisuje format odpowiedzi na błąd.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Szczegóły błędu.

ErrorResponse

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

Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganego do wywołania alertu. Dotyczy tylko reguł rodzaju LogAlert.

Nazwa Typ Wartość domyślna Opis
minFailingPeriodsToAlert

integer

1

Liczba naruszeń wyzwalających alert. Powinna być mniejsza lub równa liczbieOfEvaluationPeriods. Wartość domyślna to 1
numberOfEvaluationPeriods

integer

1

Liczba zagregowanych punktów wyszukiwania. Okno czasu wyszukiwania jest obliczane na podstawie szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów. Wartość domyślna to 1

Kind

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

Nazwa Typ Opis
LogAlert

string

LogToMetric

string

ScheduledQueryRuleCriteria

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

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ą etagu. 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łówków.
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ścią domyślną jest 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

Częstotliwość oceniania zaplanowanej reguły zapytania w formacie czasu trwania ISO 8601. Odpowiednie 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ścią domyślną jest false.
properties.muteActionsDuration

string

Akcje wyciszenia dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu. Dotyczy tylko reguł rodzaju LogAlert.
properties.overrideQueryTimeRange

string

Jeśli zostanie określony, zastępuje 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

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

boolean

Flaga wskazująca, czy podane zapytanie powinno zostać zweryfikowane, czy nie. Wartością domyślną jest 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 element docelowyResourceTypes 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

Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika). Odpowiednie i wymagane tylko dla reguł rodzaju LogAlert.
systemData

systemData

SystemData elementu ScheduledQueryRule.
tags

object

Tagi zasobów.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

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

Sygnatura czasowa 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

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

Nazwa Typ Opis
Average

string

Count

string

Maximum

string

Minimum

string

Total

string