Scheduled Query Rules - Update

Referens

Tjänst:: Monitor

API-version:: 2021-08-01

Uppdatera en schemalagd frågeregel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
ruleName	path	True	string	Namnet på regeln.
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.actions	Actions	Åtgärder som ska anropas när aviseringen utlöses.
properties.autoMitigate	boolean	Flaggan som anger om aviseringen ska lösas automatiskt eller inte. Standardvärdet är true. Endast relevant för regler av typen LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln ska lagras i kundens lagring. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.criteria	ScheduledQueryRuleCriteria	Regelvillkoren som definierar villkoren för den schemalagda frågeregeln.
properties.description	string	Beskrivningen av den schemalagda frågeregeln.
properties.displayName	string	Aviseringsregelns visningsnamn
properties.enabled	boolean	Flaggan som anger om den här schemalagda frågeregeln är aktiverad. Värdet ska vara sant eller falskt
properties.evaluationFrequency	string	Hur ofta den schemalagda frågeregeln utvärderas representeras i ISO 8601-varaktighetsformat. Relevant och krävs endast för regler av typen LogAlert.
properties.muteActionsDuration	string	Stäng av ljudet för den valda tidsperioden (i iso 8601-varaktighetsformat) efter att aviseringen har utlösts. Endast relevant för regler av typen LogAlert.
properties.overrideQueryTimeRange	string	Om det anges åsidosätter det frågetidsintervallet (standard är WindowSize*NumberOfEvaluationPeriods). Endast relevant för regler av typen LogAlert.
properties.scopes	string[]	Listan över resurs-ID:t som den här schemalagda frågeregeln är begränsad till.
properties.severity	AlertSeverity	Allvarlighetsgrad för aviseringen. Ska vara ett heltal mellan [0–4]. Värdet 0 är allvarligast. Relevant och krävs endast för regler av typen LogAlert.
properties.skipQueryValidation	boolean	Flaggan som anger om den angivna frågan ska verifieras eller inte. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.targetResourceTypes	string[]	Lista över resurstypen för de målresurser där aviseringen skapas/uppdateras. Om omfånget till exempel är en resursgrupp och targetResourceTypes är Microsoft.Compute/virtualMachines utlöses en annan avisering för varje virtuell dator i resursgruppen som uppfyller aviseringsvillkoren. Endast relevant för regler av typen LogAlert
properties.windowSize	string	Tidsperioden (i ISO 8601-varaktighetsformat) som aviseringsfrågan ska köras på (intervallstorlek). Relevant och krävs endast för regler av typen LogAlert.
tags	object	Resurstaggar

Svar

Name	Typ	Description
200 OK	ScheduledQueryRuleResource	Lyckad begäran om att uppdatera en schemalagd frågeregel
Other Status Codes	ErrorContract	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Create or update a scheduled query rule

Exempelbegäran

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
  }
}

Exempelsvar

Statuskod:: 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
  }
}

Definitioner

Name	Description
Actions	Åtgärder som ska anropas när aviseringen utlöses.
AlertSeverity	Allvarlighetsgrad för aviseringen. Ska vara ett heltal mellan [0–4]. Värdet 0 är allvarligast. Relevant och krävs endast för regler av typen LogAlert.
Condition	Ett villkor för den schemalagda frågeregeln.
conditionOperator	Villkorsoperatorn. Relevant och krävs endast för regler av typen LogAlert.
createdByType	Den typ av identitet som skapade resursen.
Dimension	Definition för dimensionsdelning och filtrering
dimensionOperator	Operator för dimensionsvärden
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorContract	Beskriver formatet felsvar.
ErrorResponse	Felsvar
FailingPeriods	Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering. Endast relevant för regler av typen LogAlert.
Kind	Anger typen av schemalagd frågeregel. Standardvärdet är LogAlert.
ScheduledQueryRuleCriteria	Regelvillkoren som definierar villkoren för den schemalagda frågeregeln.
ScheduledQueryRuleResource	Den schemalagda frågeregelresursen.
ScheduledQueryRuleResourcePatch	Den schemalagda frågeregelresursen för korrigeringsåtgärder.
systemData	Metadata som rör skapande och senaste ändring av resursen.
timeAggregation	Sammansättningstyp. Relevant och krävs endast för regler av typen LogAlert.

Actions

Åtgärder som ska anropas när aviseringen utlöses.

Name	Typ	Description
actionGroups	string[]	Resurs-ID för åtgärdsgrupp som ska anropas när aviseringen utlöses.
customProperties	object	Egenskaperna för en aviseringsnyttolast.

AlertSeverity

Allvarlighetsgrad för aviseringen. Ska vara ett heltal mellan [0–4]. Värdet 0 är allvarligast. Relevant och krävs endast för regler av typen LogAlert.

Name	Typ	Description
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Ett villkor för den schemalagda frågeregeln.

Name	Typ	Description
dimensions	Dimension[]	Lista över dimensionsvillkor
failingPeriods	FailingPeriods	Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering. Endast relevant för regler av typen LogAlert.
metricMeasureColumn	string	Kolumnen som innehåller måttmåttsnumret. Endast relevant för regler av typen LogAlert.
metricName	string	Namnet på måttet som ska skickas. Relevant och krävs endast för regler av typen LogToMetric.
operator	conditionOperator	Villkorsoperatorn. Relevant och krävs endast för regler av typen LogAlert.
query	string	Logga frågeavisering
resourceIdColumn	string	Kolumnen som innehåller resurs-ID:t. Innehållet i kolumnen måste vara en URI formaterad som resurs-ID. Endast relevant för regler av typen LogAlert.
threshold	number	villkorströskelvärdet som aktiverar aviseringen. Relevant och krävs endast för regler av typen LogAlert.
timeAggregation	timeAggregation	Sammansättningstyp. Relevant och krävs endast för regler av typen LogAlert.

conditionOperator

Villkorsoperatorn. Relevant och krävs endast för regler av typen LogAlert.

Name	Typ	Description
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Definition för dimensionsdelning och filtrering

Name	Typ	Description
name	string	Namnet på dimensionen
operator	dimensionOperator	Operator för dimensionsvärden
values	string[]	Lista över dimensionsvärden

dimensionOperator

Operator för dimensionsvärden

Name	Typ	Description
Exclude	string
Include	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorContract

Beskriver formatet felsvar.

Name	Typ	Description
error	ErrorResponse	Felsvar Felinformationen.

ErrorResponse

Felsvar

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorResponse[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

FailingPeriods

Det minsta antal överträdelser som krävs inom den valda lookback-tidsperioden som krävs för att skapa en avisering. Endast relevant för regler av typen LogAlert.

Name	Typ	Standardvärde	Description
minFailingPeriodsToAlert	integer	1	Antalet överträdelser för att utlösa en avisering. Bör vara mindre eller lika med numberOfEvaluationPeriods. Standardvärdet är 1
numberOfEvaluationPeriods	integer	1	Antalet aggregerade återblickspunkter. Lookback-tidsperioden beräknas baserat på sammansättningskornigheten (windowSize) och det valda antalet aggregerade punkter. Standardvärdet är 1

Kind

Anger typen av schemalagd frågeregel. Standardvärdet är LogAlert.

Name	Typ	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Regelvillkoren som definierar villkoren för den schemalagda frågeregeln.

Name	Typ	Description
allOf	Condition[]	En lista över villkor som ska utvärderas mot de angivna omfången

ScheduledQueryRuleResource

Den schemalagda frågeregelresursen.

Name	Typ	Description
etag	string	Fältet etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala etag-konventionen. Entitetstaggar används för att jämföra två eller flera entiteter från samma begärda resurs. HTTP/1.1 använder entitetstaggar i etag (avsnitt 14.19), If-Match (avsnitt 14.24), If-None-Match (avsnitt 14.26) och If-Range (avsnitt 14.27) rubrikfält.
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Anger typen av schemalagd frågeregel. Standardvärdet är LogAlert.
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.actions	Actions	Åtgärder som ska anropas när aviseringen utlöses.
properties.autoMitigate	boolean	Flaggan som anger om aviseringen ska matchas automatiskt eller inte. Standardvärdet är sant. Endast relevant för regler av typen LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln ska lagras i kundens lagring. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.createdWithApiVersion	string	Api-versionen som används när du skapar den här aviseringsregeln
properties.criteria	ScheduledQueryRuleCriteria	Regelvillkoren som definierar villkoren för den schemalagda frågeregeln.
properties.description	string	Beskrivningen av den schemalagda frågeregeln.
properties.displayName	string	Visningsnamnet för aviseringsregeln
properties.enabled	boolean	Flaggan som anger om den här schemalagda frågeregeln är aktiverad. Värdet ska vara sant eller falskt
properties.evaluationFrequency	string	Hur ofta den schemalagda frågeregeln utvärderas visas i ISO 8601-varaktighetsformat. Relevant och krävs endast för regler av typen LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	Sant om aviseringsregeln är en äldre loganalysregel
properties.isWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln har konfigurerats att lagras i kundens lagring. Standardvärdet är False.
properties.muteActionsDuration	string	Stäng av åtgärder för den valda tidsperioden (i ISO 8601-varaktighetsformat) efter att aviseringen har utlösts. Endast relevant för regler av typen LogAlert.
properties.overrideQueryTimeRange	string	Om det anges åsidosätter du frågetidsintervallet (standard är WindowSize*NumberOfEvaluationPeriods). Endast relevant för regler av typen LogAlert.
properties.scopes	string[]	Listan över resurs-ID:t som den här schemalagda frågeregeln är begränsad till.
properties.severity	AlertSeverity	Allvarlighetsgrad för aviseringen. Bör vara ett heltal mellan [0–4]. Värdet 0 är allvarligast. Relevant och krävs endast för regler av typen LogAlert.
properties.skipQueryValidation	boolean	Flaggan som anger om den angivna frågan ska verifieras eller inte. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.targetResourceTypes	string[]	Lista över resurstypen för de målresurser där aviseringen skapas/uppdateras. Om omfånget till exempel är en resursgrupp och targetResourceTypes är Microsoft.Compute/virtualMachines utlöses en annan avisering för varje virtuell dator i resursgruppen som uppfyller aviseringskriterierna. Endast relevant för regler av typen LogAlert
properties.windowSize	string	Tidsperioden (i ISO 8601-varaktighetsformat) som aviseringsfrågan ska köras på (intervallstorlek). Relevant och krävs endast för regler av typen LogAlert.
systemData	systemData	SystemData för ScheduledQueryRule.
tags	object	Resurstaggar.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ScheduledQueryRuleResourcePatch

Den schemalagda frågeregelresursen för korrigeringsåtgärder.

Name	Typ	Description
properties.actions	Actions	Åtgärder som ska anropas när aviseringen utlöses.
properties.autoMitigate	boolean	Flaggan som anger om aviseringen ska matchas automatiskt eller inte. Standardvärdet är sant. Endast relevant för regler av typen LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln ska lagras i kundens lagring. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.createdWithApiVersion	string	Api-versionen som används när du skapar den här aviseringsregeln
properties.criteria	ScheduledQueryRuleCriteria	Regelvillkoren som definierar villkoren för den schemalagda frågeregeln.
properties.description	string	Beskrivningen av den schemalagda frågeregeln.
properties.displayName	string	Visningsnamnet för aviseringsregeln
properties.enabled	boolean	Flaggan som anger om den här schemalagda frågeregeln är aktiverad. Värdet ska vara sant eller falskt
properties.evaluationFrequency	string	Hur ofta den schemalagda frågeregeln utvärderas visas i ISO 8601-varaktighetsformat. Relevant och krävs endast för regler av typen LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	Sant om aviseringsregeln är en äldre loganalysregel
properties.isWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln har konfigurerats att lagras i kundens lagring. Standardvärdet är False.
properties.muteActionsDuration	string	Stäng av åtgärder för den valda tidsperioden (i ISO 8601-varaktighetsformat) efter att aviseringen har utlösts. Endast relevant för regler av typen LogAlert.
properties.overrideQueryTimeRange	string	Om det anges åsidosätter du frågetidsintervallet (standard är WindowSize*NumberOfEvaluationPeriods). Endast relevant för regler av typen LogAlert.
properties.scopes	string[]	Listan över resurs-ID:t som den här schemalagda frågeregeln är begränsad till.
properties.severity	AlertSeverity	Allvarlighetsgrad för aviseringen. Bör vara ett heltal mellan [0–4]. Värdet 0 är allvarligast. Relevant och krävs endast för regler av typen LogAlert.
properties.skipQueryValidation	boolean	Flaggan som anger om den angivna frågan ska verifieras eller inte. Standardvärdet är False. Endast relevant för regler av typen LogAlert.
properties.targetResourceTypes	string[]	Lista över resurstypen för de målresurser där aviseringen skapas/uppdateras. Om omfånget till exempel är en resursgrupp och targetResourceTypes är Microsoft.Compute/virtualMachines utlöses en annan avisering för varje virtuell dator i resursgruppen som uppfyller aviseringskriterierna. Endast relevant för regler av typen LogAlert
properties.windowSize	string	Tidsperioden (i ISO 8601-varaktighetsformat) som aviseringsfrågan ska köras på (intervallstorlek). Relevant och krävs endast för regler av typen LogAlert.
tags	object	Resurstaggar

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

timeAggregation

Sammansättningstyp. Relevant och krävs endast för regler av typen LogAlert.

Name	Typ	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

Dela via