Sdílet prostřednictvím

Scheduled Query Rules - Get

  • Reference
Služba:
Monitor
Verze rozhraní API:
2021-08-01

Načte definici pravidla naplánovaného dotazu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
ruleName
 path True

string

Název pravidla.
subscriptionId
 path True

string

ID cílového předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

ScheduledQueryRuleResource

Úspěšný požadavek na získání pravidla naplánovaného dotazu
Other Status Codes

ErrorContract

BadRequest

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Get a scheduled query rule for single resource

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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
  }
}

Definice

Name Description
Actions

Akce, které se mají vyvolat, když se výstraha aktivuje.
AlertSeverity

Závažnost výstrahy. Mělo by to být celé číslo mezi [0–4]. Hodnota 0 je nejtěžší. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
Condition

Podmínka pravidla naplánovaného dotazu.
conditionOperator

Operátor kritéria. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
createdByType

Typ identity, která vytvořila prostředek.
Dimension

Definice rozdělení a filtrování dimenzí
dimensionOperator

Operátor pro hodnoty dimenzí
ErrorAdditionalInfo

Další informace o chybě správy prostředků
ErrorContract

Popisuje formát chybové odpovědi.
ErrorResponse

Odpověď na chybu
FailingPeriods

Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy. Relevantní pouze pro pravidla typu LogAlert.
Kind

Označuje typ pravidla naplánovaného dotazu. Výchozí hodnota je LogAlert.
ScheduledQueryRuleCriteria

Kritéria pravidla, která definují podmínky pravidla naplánovaného dotazu.
ScheduledQueryRuleResource

Prostředek pravidla naplánovaného dotazu.
systemData

Metadata týkající se vytvoření a poslední změny prostředku
timeAggregation

Typ agregace. Relevantní a vyžadované pouze pro pravidla typu LogAlert.

Actions

Akce, které se mají vyvolat, když se výstraha aktivuje.

Name Typ Description
actionGroups

string[]

ID prostředků skupiny akcí, které se mají vyvolat při aktivaci výstrahy.
customProperties

object

Vlastnosti datové části upozornění.

AlertSeverity

Závažnost výstrahy. Mělo by to být celé číslo mezi [0–4]. Hodnota 0 je nejtěžší. Relevantní a vyžadované pouze pro pravidla typu LogAlert.

Name Typ Description
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

Condition

Podmínka pravidla naplánovaného dotazu.

Name Typ Description
dimensions

Dimension[]

Seznam podmínek dimenzí
failingPeriods

FailingPeriods

Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy. Relevantní pouze pro pravidla typu LogAlert.
metricMeasureColumn

string

Sloupec obsahující číslo míry metriky. Relevantní pouze pro pravidla typu LogAlert.
metricName

string

Název metriky, která se má odeslat. Relevantní a vyžadované pouze pro pravidla typu LogToMetric.
operator

conditionOperator

Operátor kritéria. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
query

string

Upozornění dotazu protokolu
resourceIdColumn

string

Sloupec obsahující ID prostředku. Obsah sloupce musí být identifikátor URI naformátovaný jako ID prostředku. Relevantní pouze pro pravidla typu LogAlert.
threshold

number

prahová hodnota kritéria, která aktivuje výstrahu. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
timeAggregation

timeAggregation

Typ agregace. Relevantní a vyžadované pouze pro pravidla typu LogAlert.

conditionOperator

Operátor kritéria. Relevantní a vyžadované pouze pro pravidla typu LogAlert.

Name Typ Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

Dimension

Definice rozdělení a filtrování dimenzí

Name Typ Description
name

string

Název dimenze
operator

dimensionOperator

Operátor pro hodnoty dimenzí
values

string[]

Seznam hodnot dimenzí

dimensionOperator

Operátor pro hodnoty dimenzí

Name Typ Description
Exclude

string

Include

string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorContract

Popisuje formát chybové odpovědi.

Name Typ Description
error

ErrorResponse

Odpověď na chybu
Podrobnosti o chybě

ErrorResponse

Odpověď na chybu

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě
code

string

Kód chyby
details

ErrorResponse[]

Podrobnosti o chybě
message

string

Chybová zpráva
target

string

Cíl chyby.

FailingPeriods

Minimální počet porušení požadovaných ve vybraném časovém intervalu doby zpětného vyhledávání, který je nutný k vyvolání výstrahy. Relevantní pouze pro pravidla typu LogAlert.

Name Typ Default value Description
minFailingPeriodsToAlert

integer

1

Počet porušení pro aktivaci výstrahy Měl by být menší nebo roven hodnotě numberOfEvaluationPeriods. Výchozí hodnota je 1.
numberOfEvaluationPeriods

integer

1

Počet agregovaných bodů zpětného vyhledávání. Časové období zpětného vyhledávání se počítá na základě agregační členitosti (windowSize) a vybraného počtu agregovaných bodů. Výchozí hodnota je 1.

Kind

Označuje typ pravidla naplánovaného dotazu. Výchozí hodnota je LogAlert.

Name Typ Description
LogAlert

string

LogToMetric

string

ScheduledQueryRuleCriteria

Kritéria pravidla, která definují podmínky pravidla naplánovaného dotazu.

Name Typ Description
allOf

Condition[]

Seznam podmínek, které se mají vyhodnotit podle zadaných oborů

ScheduledQueryRuleResource

Prostředek pravidla naplánovaného dotazu.

Name Typ Description
etag

string

Pole etag není povinné. Pokud je uveden v textu odpovědi, musí být také uveden jako hlavička podle normální konvence etag. Značky entit se používají k porovnání dvou nebo více entit ze stejného požadovaného prostředku. HTTP/1.1 používá značky entit v polích etag (oddíl 14.19), If-Match (oddíl 14.24), If-None-Match (oddíl 14.26) a If-Range (oddíl 14.27).
id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

Kind

Označuje typ pravidla naplánovaného dotazu. Výchozí hodnota je LogAlert.
location

string

Geografické umístění, ve kterém se nachází prostředek
name

string

Název prostředku
properties.actions

Actions

Akce, které se mají vyvolat, když se výstraha aktivuje.
properties.autoMitigate

boolean

Příznak, který označuje, jestli má být upozornění automaticky vyřešeno, nebo ne. Výchozí hodnota je true. Relevantní pouze pro pravidla typu LogAlert.
properties.checkWorkspaceAlertsStorageConfigured

boolean

Příznak, který označuje, jestli má být toto naplánované pravidlo dotazu uloženo v úložišti zákazníka. Výchozí hodnotou je hodnota false. Relevantní pouze pro pravidla typu LogAlert.
properties.createdWithApiVersion

string

Verze rozhraní API použitá při vytváření tohoto pravidla upozornění
properties.criteria

ScheduledQueryRuleCriteria

Kritéria pravidla, která definují podmínky pravidla naplánovaného dotazu.
properties.description

string

Popis pravidla naplánovaného dotazu.
properties.displayName

string

Zobrazovaný název pravidla upozornění
properties.enabled

boolean

Příznak, který označuje, jestli je toto pravidlo naplánovaného dotazu povolené. Hodnota by měla být pravda nebo nepravda.
properties.evaluationFrequency

string

Jak často se pravidlo naplánovaného dotazu vyhodnocuje ve formátu doby trvání ISO 8601. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
properties.isLegacyLogAnalyticsRule

boolean

True, pokud je pravidlo upozornění starší verzí pravidla Log Analytic
properties.isWorkspaceAlertsStorageConfigured

boolean

Příznak, který označuje, jestli je toto naplánované pravidlo dotazu nakonfigurované tak, aby se uložilo do úložiště zákazníka. Výchozí hodnotou je hodnota false.
properties.muteActionsDuration

string

Ztlumit akce po zvolenou dobu (ve formátu doby trvání ISO 8601) po aktivaci výstrahy. Relevantní pouze pro pravidla typu LogAlert.
properties.overrideQueryTimeRange

string

Pokud je zadaný, přepíše časový rozsah dotazu (výchozí hodnota je WindowSize*NumberOfEvaluationPeriods). Relevantní pouze pro pravidla typu LogAlert.
properties.scopes

string[]

Seznam ID prostředku, na který je toto pravidlo naplánovaného dotazu vymezeno.
properties.severity

AlertSeverity

Závažnost výstrahy. Mělo by to být celé číslo mezi [0–4]. Hodnota 0 je nejtěžší. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
properties.skipQueryValidation

boolean

Příznak, který označuje, jestli se má zadaný dotaz ověřit, nebo ne. Výchozí hodnotou je hodnota false. Relevantní pouze pro pravidla typu LogAlert.
properties.targetResourceTypes

string[]

Seznam typů prostředků cílových prostředků, pro které je výstraha vytvořena nebo aktualizována. Pokud je například oborem skupina prostředků a targetResourceTypes je Microsoft.Compute/virtualMachines, aktivuje se pro každý virtuální počítač ve skupině prostředků jiná výstraha, která splňuje kritéria upozornění. Relevantní pouze pro pravidla typu LogAlert
properties.windowSize

string

Časové období (ve formátu doby trvání ISO 8601), ve kterém se bude dotaz výstrahy spouštět (velikost intervalu). Relevantní a vyžadované pouze pro pravidla typu LogAlert.
systemData

systemData

SystemData pro ScheduledQueryRule.
tags

object

Značky prostředků.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)
createdBy

string

Identita, která prostředek vytvořila.
createdByType

createdByType

Typ identity, která vytvořila prostředek.
lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

timeAggregation

Typ agregace. Relevantní a vyžadované pouze pro pravidla typu LogAlert.

Name Typ Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string