Scheduled Query Rules - Update

Service:

Monitor

API Version:

2021-08-01

Ütemezett lekérdezési szabály frissítése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
ruleName	path	True	string	A szabály neve.
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Típus	Description
properties.actions	Actions	A riasztás aktiválásakor meghívandó műveletek.
properties.autoMitigate	boolean	Az a jelző, amely jelzi, hogy a riasztást automatikusan fel kell-e oldani. Az alapértelmezett érték igaz. Csak a LogAlert típusú szabályokra vonatkozik.
properties.checkWorkspaceAlertsStorageConfigured	boolean	A jelző, amely azt jelzi, hogy az ütemezett lekérdezési szabályt az ügyfél tárolójában kell-e tárolni. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.criteria	ScheduledQueryRuleCriteria	Az ütemezett lekérdezési szabály feltételeit meghatározó szabályfeltételek.
properties.description	string	Az ütemezett lekérdezési szabály leírása.
properties.displayName	string	A riasztási szabály megjelenítendő neve
properties.enabled	boolean	A jelző, amely azt jelzi, hogy engedélyezve van-e ez az ütemezett lekérdezési szabály. Az értéknek igaznak vagy hamisnak kell lennie
properties.evaluationFrequency	string	Az ütemezett lekérdezési szabály kiértékelésének gyakorisága ISO 8601-es időtartamformátumban. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.muteActionsDuration	string	A riasztás aktiválása után elnémíthatja a kiválasztott időszakra vonatkozó műveleteket (ISO 8601-es időtartamformátumban). Csak a LogAlert típusú szabályokra vonatkozik.
properties.overrideQueryTimeRange	string	Ha meg van adva, felülbírálja a lekérdezés időtartományát (az alapértelmezett érték a WindowSize*NumberOfEvaluationPeriods). Csak a LogAlert típusú szabályokra vonatkozik.
properties.scopes	string[]	Azon erőforrás-azonosítók listája, amelyekre az ütemezett lekérdezési szabály hatóköre kiterjed.
properties.severity	AlertSeverity	A riasztás súlyossága. [0–4] közötti egész számnak kell lennie. A 0 érték a legsúlyosabb. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.skipQueryValidation	boolean	A jelző, amely azt jelzi, hogy a megadott lekérdezést ellenőrizni kell-e vagy sem. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.targetResourceTypes	string[]	Azon célerőforrás(ok) erőforrástípusának listája, amelyen a riasztás létrejön/frissül. Ha például a hatókör egy erőforráscsoport, a targetResourceTypes pedig Microsoft.Compute/virtualMachines, akkor a rendszer egy másik riasztást aktivál az erőforráscsoport minden virtuális gépére, amely megfelel a riasztási feltételeknek. Csak a LogAlert típusú szabályokra vonatkozik
properties.windowSize	string	Az az időtartam (ISO 8601-es időtartamformátumban), amelyen a riasztási lekérdezés végrehajtása történik (intervallum mérete). Csak a LogAlert típusú szabályok esetében releváns és kötelező.
tags	object	Erőforráscímkék

Válaszok

Name	Típus	Description
200 OK	ScheduledQueryRuleResource	Sikeres kérés ütemezett lekérdezési szabály frissítésére
Other Status Codes	ErrorContract	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

Create or update a scheduled query rule

Sample Request

HTTP

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

{
  "properties": {
    "enabled": false
  }
}

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": false,
    "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
  }
}

Definíciók

Name	Description
Actions	A riasztás aktiválásakor meghívandó műveletek.
AlertSeverity	A riasztás súlyossága. [0–4] közötti egész számnak kell lennie. A 0 érték a legsúlyosabb. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
Condition	Az ütemezett lekérdezési szabály feltétele.
conditionOperator	A feltétel operátor. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
createdByType	Az erőforrást létrehozó identitás típusa.
Dimension	Dimenzió felosztási és szűrési definíciója
dimensionOperator	Dimenzióértékek operátora
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorContract	A hibaválasz formátumát ismerteti.
ErrorResponse	Hibaválasz
FailingPeriods	A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül. Csak a LogAlert típusú szabályokra vonatkozik.
Kind	Az ütemezett lekérdezési szabály típusát jelzi. Az alapértelmezett érték a LogAlert.
ScheduledQueryRuleCriteria	Az ütemezett lekérdezési szabály feltételeit meghatározó szabályfeltételek.
ScheduledQueryRuleResource	Az ütemezett lekérdezési szabály erőforrása.
ScheduledQueryRuleResourcePatch	A javítási műveletek ütemezett lekérdezésiszabály-erőforrása.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
timeAggregation	Összesítés típusa. Csak a LogAlert típusú szabályok esetében releváns és kötelező.

Actions

A riasztás aktiválásakor meghívandó műveletek.

Name	Típus	Description
actionGroups	string[]	A műveletcsoport erőforrás-azonosítói, amelyeket a riasztás aktiválásakor kell meghívni.
customProperties	object	A riasztás hasznos adatainak tulajdonságai.

AlertSeverity

A riasztás súlyossága. [0–4] közötti egész számnak kell lennie. A 0 érték a legsúlyosabb. Csak a LogAlert típusú szabályok esetében releváns és kötelező.

Name	Típus	Description
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Az ütemezett lekérdezési szabály feltétele.

Name	Típus	Description
dimensions	Dimension[]	Dimenziófeltételek listája
failingPeriods	FailingPeriods	A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül. Csak a LogAlert típusú szabályokra vonatkozik.
metricMeasureColumn	string	A metrikamérték számát tartalmazó oszlop. Csak a LogAlert típusú szabályokra vonatkozik.
metricName	string	Az elküldendő metrika neve. Csak a LogToMetric típusú szabályok esetében releváns és kötelező.
operator	conditionOperator	A feltétel operátor. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
query	string	Napló lekérdezési riasztás
resourceIdColumn	string	Az erőforrás-azonosítót tartalmazó oszlop. Az oszlop tartalmának erőforrás-azonosítóként formázott URI-nak kell lennie. Csak a LogAlert típusú szabályokra vonatkozik.
threshold	number	a riasztást aktiváló kritérium küszöbértéke. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
timeAggregation	timeAggregation	Összesítés típusa. Csak a LogAlert típusú szabályok esetében releváns és kötelező.

conditionOperator

A feltétel operátor. Csak a LogAlert típusú szabályok esetében releváns és kötelező.

Name	Típus	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Az erőforrást létrehozó identitás típusa.

Name	Típus	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Dimenzió felosztási és szűrési definíciója

Name	Típus	Description
name	string	A dimenzió neve
operator	dimensionOperator	Dimenzióértékek operátora
values	string[]	Dimenzióértékek listája

dimensionOperator

Dimenzióértékek operátora

Name	Típus	Description
Exclude	string
Include	string

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további adattípus.

ErrorContract

A hibaválasz formátumát ismerteti.

Name	Típus	Description
error	ErrorResponse	Hibaválasz A hiba részletei.

ErrorResponse

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célja.

FailingPeriods

A riasztás létrehozásához szükséges minimális számú szabálysértés a kijelölt visszatekintési időkereten belül. Csak a LogAlert típusú szabályokra vonatkozik.

Name	Típus	Alapértelmezett érték	Description
minFailingPeriodsToAlert	integer	1	A riasztást aktiváló szabálysértések száma. Kisebbnek vagy egyenlőnek kell lennie a numberOfEvaluationPeriods számmal. Az alapértelmezett érték 1
numberOfEvaluationPeriods	integer	1	Az összesített visszatekintési pontok száma. A visszatekintési időkeret kiszámítása az összesítés részletessége (windowSize) és a kiválasztott összesített pontok száma alapján történik. Az alapértelmezett érték 1

Kind

Az ütemezett lekérdezési szabály típusát jelzi. Az alapértelmezett érték a LogAlert.

Name	Típus	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Az ütemezett lekérdezési szabály feltételeit meghatározó szabályfeltételek.

Name	Típus	Description
allOf	Condition[]	A megadott hatókörök alapján kiértékelendő feltételek listája

ScheduledQueryRuleResource

Az ütemezett lekérdezési szabály erőforrása.

Name	Típus	Description
etag	string	Az etag mezőre nincs szükség. Ha a válasz törzsében szerepel, akkor fejlécként is meg kell adni a normál etag-konvenciónak megfelelően. Az entitáscímkék két vagy több entitás összehasonlítására szolgálnak ugyanabból a kért erőforrásból. A HTTP/1.1 entitáscímkéket használ az etag (14.19 szakasz), If-Match (14.24. szakasz), If-None-Match (14.26. szakasz) és If-Range (14.27. szakasz) fejlécmezőkben.
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Az ütemezett lekérdezési szabály típusát jelzi. Az alapértelmezett érték a LogAlert.
location	string	A földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.actions	Actions	A riasztás aktiválásakor meghívandó műveletek.
properties.autoMitigate	boolean	Az a jelző, amely jelzi, hogy a riasztást automatikusan fel kell-e oldani. Az alapértelmezett érték igaz. Csak a LogAlert típusú szabályokra vonatkozik.
properties.checkWorkspaceAlertsStorageConfigured	boolean	A jelző, amely azt jelzi, hogy az ütemezett lekérdezési szabályt az ügyfél tárolójában kell-e tárolni. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.createdWithApiVersion	string	A riasztási szabály létrehozásakor használt API-verzió
properties.criteria	ScheduledQueryRuleCriteria	Az ütemezett lekérdezési szabály feltételeit meghatározó szabályfeltételek.
properties.description	string	Az ütemezett lekérdezési szabály leírása.
properties.displayName	string	A riasztási szabály megjelenítendő neve
properties.enabled	boolean	A jelző, amely azt jelzi, hogy engedélyezve van-e ez az ütemezett lekérdezési szabály. Az értéknek igaznak vagy hamisnak kell lennie
properties.evaluationFrequency	string	Az ütemezett lekérdezési szabály kiértékelésének gyakorisága ISO 8601-es időtartamformátumban. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.isLegacyLogAnalyticsRule	boolean	Igaz, ha a riasztási szabály örökölt napló-elemzési szabály
properties.isWorkspaceAlertsStorageConfigured	boolean	A jelző, amely azt jelzi, hogy az ütemezett lekérdezési szabály úgy lett-e konfigurálva, hogy az ügyfél tárolójában legyen tárolva. Az alapértelmezett érték hamis.
properties.muteActionsDuration	string	A riasztás aktiválása után elnémíthatja a kiválasztott időszakra vonatkozó műveleteket (ISO 8601-es időtartamformátumban). Csak a LogAlert típusú szabályokra vonatkozik.
properties.overrideQueryTimeRange	string	Ha meg van adva, felülbírálja a lekérdezés időtartományát (az alapértelmezett érték a WindowSize*NumberOfEvaluationPeriods). Csak a LogAlert típusú szabályokra vonatkozik.
properties.scopes	string[]	Azon erőforrás-azonosítók listája, amelyekre az ütemezett lekérdezési szabály hatóköre kiterjed.
properties.severity	AlertSeverity	A riasztás súlyossága. [0–4] közötti egész számnak kell lennie. A 0 érték a legsúlyosabb. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.skipQueryValidation	boolean	A jelző, amely azt jelzi, hogy a megadott lekérdezést ellenőrizni kell-e vagy sem. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.targetResourceTypes	string[]	Azon célerőforrás(ok) erőforrástípusának listája, amelyen a riasztás létrejön/frissül. Ha például a hatókör egy erőforráscsoport, a targetResourceTypes pedig Microsoft.Compute/virtualMachines, akkor a rendszer egy másik riasztást aktivál az erőforráscsoport minden virtuális gépére, amely megfelel a riasztási feltételeknek. Csak a LogAlert típusú szabályokra vonatkozik
properties.windowSize	string	Az az időtartam (ISO 8601-es időtartamformátumban), amelyen a riasztási lekérdezés végrehajtása történik (intervallum mérete). Csak a LogAlert típusú szabályok esetében releváns és kötelező.
systemData	systemData	SystemData a ScheduledQueryRule-ból.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ScheduledQueryRuleResourcePatch

A javítási műveletek ütemezett lekérdezésiszabály-erőforrása.

Name	Típus	Description
properties.actions	Actions	A riasztás aktiválásakor meghívandó műveletek.
properties.autoMitigate	boolean	Az a jelző, amely jelzi, hogy a riasztást automatikusan fel kell-e oldani. Az alapértelmezett érték igaz. Csak a LogAlert típusú szabályokra vonatkozik.
properties.checkWorkspaceAlertsStorageConfigured	boolean	A jelző, amely azt jelzi, hogy az ütemezett lekérdezési szabályt az ügyfél tárolójában kell-e tárolni. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.createdWithApiVersion	string	A riasztási szabály létrehozásakor használt API-verzió
properties.criteria	ScheduledQueryRuleCriteria	Az ütemezett lekérdezési szabály feltételeit meghatározó szabályfeltételek.
properties.description	string	Az ütemezett lekérdezési szabály leírása.
properties.displayName	string	A riasztási szabály megjelenítendő neve
properties.enabled	boolean	A jelző, amely azt jelzi, hogy engedélyezve van-e ez az ütemezett lekérdezési szabály. Az értéknek igaznak vagy hamisnak kell lennie
properties.evaluationFrequency	string	Az ütemezett lekérdezési szabály kiértékelésének gyakorisága ISO 8601-es időtartamformátumban. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.isLegacyLogAnalyticsRule	boolean	Igaz, ha a riasztási szabály örökölt napló-elemzési szabály
properties.isWorkspaceAlertsStorageConfigured	boolean	A jelző, amely azt jelzi, hogy az ütemezett lekérdezési szabály úgy lett-e konfigurálva, hogy az ügyfél tárolójában legyen tárolva. Az alapértelmezett érték hamis.
properties.muteActionsDuration	string	A riasztás aktiválása után elnémíthatja a kiválasztott időszakra vonatkozó műveleteket (ISO 8601-es időtartamformátumban). Csak a LogAlert típusú szabályokra vonatkozik.
properties.overrideQueryTimeRange	string	Ha meg van adva, felülbírálja a lekérdezés időtartományát (az alapértelmezett érték a WindowSize*NumberOfEvaluationPeriods). Csak a LogAlert típusú szabályokra vonatkozik.
properties.scopes	string[]	Azon erőforrás-azonosítók listája, amelyekre az ütemezett lekérdezési szabály hatóköre kiterjed.
properties.severity	AlertSeverity	A riasztás súlyossága. [0–4] közötti egész számnak kell lennie. A 0 érték a legsúlyosabb. Csak a LogAlert típusú szabályok esetében releváns és kötelező.
properties.skipQueryValidation	boolean	A jelző, amely azt jelzi, hogy a megadott lekérdezést ellenőrizni kell-e vagy sem. Az alapértelmezett érték hamis. Csak a LogAlert típusú szabályokra vonatkozik.
properties.targetResourceTypes	string[]	Azon célerőforrás(ok) erőforrástípusának listája, amelyen a riasztás létrejön/frissül. Ha például a hatókör egy erőforráscsoport, a targetResourceTypes pedig Microsoft.Compute/virtualMachines, akkor a rendszer egy másik riasztást aktivál az erőforráscsoport minden virtuális gépére, amely megfelel a riasztási feltételeknek. Csak a LogAlert típusú szabályokra vonatkozik
properties.windowSize	string	Az az időtartam (ISO 8601-es időtartamformátumban), amelyen a riasztási lekérdezés végrehajtása történik (intervallum mérete). Csak a LogAlert típusú szabályok esetében releváns és kötelező.
tags	object	Erőforráscímkék

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást utoljára módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

timeAggregation

Összesítés típusa. Csak a LogAlert típusú szabályok esetében releváns és kötelező.

Name	Típus	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string