Scheduled Query Rules - List By Subscription

Reference

Služba:: Monitor

Verze rozhraní API:: 2021-08-01

Načtení definic pravidel naplánovaného dotazu v předplatném

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ScheduledQueryRuleResourceCollection	Úspěšná žádost o seznam pravidel naplánovaných dotazů
Other Status Codes	ErrorContract	Špatný požadavek

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

List scheduled query rules by subscription

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "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
      }
    },
    {
      "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/MyResourceGroupName2/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"
        ],
        "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
      }
    }
  ]
}

Definice

Name	Description
Actions	Akce, které se mají vyvolat při vyvolání výstrahy
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érií. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
createdByType	Typ identity, která prostředek vytvořila.
Dimension	Definice rozdělení dimenzí a filtrování
dimensionOperator	Operátor pro hodnoty dimenzí
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorContract	Popisuje formát odpovědi na chybu.
ErrorResponse	Odpověď na chybu
FailingPeriods	Minimální počet porušení požadovaných v rámci vybraného časového intervalu zpětného vyhledávání, které je nutné k vyvolání výstrahy. Relevantní pouze pro pravidla typu LogAlert.
Kind	Určuje typ pravidla naplánovaného dotazu. Výchozí hodnota je LogAlert.
ScheduledQueryRuleCriteria	Kritéria pravidla definující podmínky pravidla naplánovaného dotazu.
ScheduledQueryRuleResource	Prostředek pravidla naplánovaného dotazu.
ScheduledQueryRuleResourceCollection	Představuje kolekci prostředků pravidel naplánovaných dotazů.
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

Objekt

Akce, které se mají vyvolat při vyvolání výstrahy

Name	Typ	Description
actionGroups	string[]	ID prostředků skupiny akcí, které se mají vyvolat při vyvolání výstrahy
customProperties	object	Vlastnosti datové části upozornění

AlertSeverity

Výčet

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.

Hodnota	Description
0
1
2
3
4

Condition

Objekt

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 v rámci vybraného časového intervalu 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érií. 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 formátovaný jako ID prostředku. Relevantní pouze pro pravidla typu LogAlert.
threshold	number (double)	prahová hodnota kritérií, 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

Výčet

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

Hodnota	Description
Equals
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

createdByType

Výčet

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

Hodnota	Description
Application
Key
ManagedIdentity
User

Dimension

Objekt

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

Name	Typ	Description
name	string	Název dimenze
operator	dimensionOperator	Operátor pro hodnoty dimenzí
values	string[]	Seznam hodnot dimenzí

dimensionOperator

Výčet

Operátor pro hodnoty dimenzí

Hodnota	Description
Exclude
Include

ErrorAdditionalInfo

Objekt

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorContract

Objekt

Popisuje formát odpovědi na chybu.

Name	Typ	Description
error	ErrorResponse	Odpověď na chybu Podrobnosti o chybě.

ErrorResponse

Objekt

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

Objekt

Minimální počet porušení požadovaných v rámci vybraného časového intervalu 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 (int64)	1	Počet porušení, která se mají aktivovat upozornění. Měl by být menší nebo roven čísluOfEvaluationPeriods. Výchozí hodnota je 1
numberOfEvaluationPeriods	integer (int64)	1	Počet agregovaných bodů zpětného vyhledávání. Časové období zpětného vyhledávání se vypočítá na základě členitosti agregace (windowSize) a vybraného počtu agregovaných bodů. Výchozí hodnota je 1

Kind

Výčet

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

Hodnota	Description
LogAlert
LogToMetric

ScheduledQueryRuleCriteria

Objekt

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

Name	Typ	Description
allOf	Condition[]	Seznampodmínekch

ScheduledQueryRuleResource

Objekt

Prostředek pravidla naplánovaného dotazu.

Name	Typ	Description
etag	string	Pole etag je není povinné. Pokud je uvedený v textu odpovědi, musí být také uveden jako hlavička podle normální konvence značky 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 etagu (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 pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Určuje typ pravidla naplánovaného dotazu. Výchozí hodnota je LogAlert.
location	string	Geografické umístění, ve kterém se nachází zdroj
name	string	Název prostředku
properties.actions	Actions	Akce, které se mají vyvolat při vyvolání výstrahy
properties.autoMitigate	boolean	Příznak, který označuje, jestli se má výstraha automaticky vyřešit, 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í hodnota je false. Relevantní pouze pro pravidla typu LogAlert.
properties.createdWithApiVersion	string	Verze api použitá při vytváření tohoto pravidla upozornění
properties.criteria	ScheduledQueryRuleCriteria	Kritéria pravidla definující 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 označující, jestli je toto naplánované pravidlo dotazu povolené. Hodnota by měla být true nebo false
properties.evaluationFrequency	string (duration)	Jak často se naplánované pravidlo dotazu vyhodnocuje ve formátu doby trvání ISO 8601. Relevantní a vyžadované pouze pro pravidla typu LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	True if alert rule is legacy Log Analytic rule
properties.isWorkspaceAlertsStorageConfigured	boolean	Příznak, který označuje, jestli bylo toto naplánované pravidlo dotazu nakonfigurované tak, aby bylo uloženo v úložišti zákazníka. Výchozí hodnota je false.
properties.muteActionsDuration	string (duration)	Ztlumení akcí po zvolenou dobu (ve formátu doby trvání ISO 8601) po spuštění výstrahy Relevantní pouze pro pravidla typu LogAlert.
properties.overrideQueryTimeRange	string (duration)	Pokud zadáte, 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 naplánované pravidlo dotazu vymezeno.
properties.severity	AlertSeverity (int64)	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 označující, jestli se má zadaný dotaz ověřit, nebo ne. Výchozí hodnota je false. Relevantní pouze pro pravidla typu LogAlert.
properties.targetResourceTypes	string[]	Seznam typů prostředků cílových prostředků, pro které se výstraha vytvoří nebo aktualizuje Pokud je obor například skupina prostředků a targetResourceTypes je Microsoft.Compute/virtualMachines, pro každý virtuální počítač ve skupině prostředků, která splňuje kritéria upozornění, se aktivuje jiná výstraha. Relevantní pouze pro pravidla typu LogAlert
properties.windowSize	string (duration)	Časové období (ve formátu doby trvání ISO 8601), na kterém se spustí dotaz upozornění (velikost intervalu). Relevantní a vyžadované pouze pro pravidla typu LogAlert.
systemData	systemData	SystemData of ScheduledQueryRule.
tags	object	Značky prostředků
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ScheduledQueryRuleResourceCollection

Objekt

Představuje kolekci prostředků pravidel naplánovaných dotazů.

Name	Typ	Description
nextLink	string	Poskytuje odkaz pro načtení další sady prvků.
value	ScheduledQueryRuleResource[]	Hodnoty pro prostředky naplánovaného pravidla dotazu.

systemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

timeAggregation

Výčet

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

Hodnota	Description
Average
Count
Maximum
Minimum
Total

Sdílet prostřednictvím

Scheduled Query Rules - List By Subscription

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

List scheduled query rules by subscription

Ukázkový požadavek

Ukázková odpověď

Definice

Actions

AlertSeverity

Condition

conditionOperator

createdByType

Dimension

dimensionOperator

ErrorAdditionalInfo

ErrorContract

ErrorResponse

FailingPeriods

Kind

ScheduledQueryRuleCriteria

ScheduledQueryRuleResource

ScheduledQueryRuleResourceCollection

systemData

timeAggregation

Další materiály