Scheduled Query Rules - Get

Tjänst:: Monitor

API-version:: 2021-08-01

Hämta en schemalagd frågeregeldefinition.

GET 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 minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
ruleName	path	True	string	Namnet på regeln.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ScheduledQueryRuleResource	Lyckad begäran om att få en schemalagd frågeregel
Other Status Codes	ErrorContract	Felaktig Begäran

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

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

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a scheduled query rule for single resource

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Actions	Åtgärder som ska anropas när aviseringen utlöses.
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.
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 för Felsvar.
ErrorResponse	Felsvar
FailingPeriods	Det minsta antal överträdelser som krävs inom det valda återställningstidsfönstret som krävs för att skapa en avisering. Relevant endast 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.
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

Objekt

Å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

Uppräkning

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.

Värde	Description
0
1
2
3
4

Condition

Objekt

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 det valda återställningstidsfönstret som krävs för att skapa en avisering. Relevant endast för regler av typen LogAlert.
metricMeasureColumn	string	Kolumnen som innehåller måttmåttsnumret. Relevant endast 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	Loggfrågeavisering
resourceIdColumn	string	Kolumnen som innehåller resurs-ID:t. Innehållet i kolumnen måste vara en uri formaterad som resurs-ID. Relevant endast för regler av typen LogAlert.
threshold	number (double)	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

Uppräkning

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

Värde	Description
Equals
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

Dimension

Objekt

Definition för dimensionsdelning och filtrering

Name	Typ	Description
name	string	Dimensionens namn
operator	dimensionOperator	Operator för dimensionsvärden
values	string[]	Lista över dimensionsvärden

dimensionOperator

Uppräkning

Operator för dimensionsvärden

Värde	Description
Include
Exclude

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorContract

Objekt

Beskriver formatet för Felsvar.

Name	Typ	Description
error	ErrorResponse	Felsvar Felinformationen.

ErrorResponse

Objekt

Felsvar

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

FailingPeriods

Objekt

Det minsta antal överträdelser som krävs inom det valda återställningstidsfönstret som krävs för att skapa en avisering. Relevant endast för regler av typen LogAlert.

Name	Typ	Standardvärde	Description
minFailingPeriodsToAlert	integer (int64)	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 (int64)	1	Antalet aggregerade återblickspunkter. Lookback-tidsfönstret beräknas baserat på sammansättningskornigheten (windowSize) och det valda antalet aggregerade punkter. Standardvärdet är 1

Kind

Uppräkning

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

Värde	Description
LogAlert
LogToMetric

ScheduledQueryRuleCriteria

Objekt

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

Objekt

Den schemalagda frågeregelresursen.

Name	Typ	Description
etag	string	Fältet etag är inte krävs. 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. Relevant endast 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 falskt. Relevant endast 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 (duration)	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.isLegacyLogAnalyticsRule	boolean	Sant om aviseringsregeln är en äldre Log Analytic-regel
properties.isWorkspaceAlertsStorageConfigured	boolean	Flaggan som anger om den här schemalagda frågeregeln har konfigurerats för att lagras i kundens lagring. Standardvärdet är falskt.
properties.muteActionsDuration	string (duration)	Stäng av åtgärder för den valda tidsperioden (i ISO 8601-varaktighetsformat) efter att aviseringen har utlösts. Relevant endast för regler av typen LogAlert.
properties.overrideQueryTimeRange	string (duration)	Om det anges åsidosätter det frågetidsintervallet (standardvärdet är WindowSize*NumberOfEvaluationPeriods). Relevant endast 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 (int64)	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 falskt. Relevant endast 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 (duration)	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"

systemData

Objekt

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

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	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

Uppräkning

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

Värde	Description
Count
Average
Minimum
Maximum
Total

Dela via

Scheduled Query Rules - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Get a scheduled query rule for single resource

Exempelbegäran

Exempelsvar

Definitioner

Actions

AlertSeverity

Condition

conditionOperator

createdByType

Dimension

dimensionOperator

ErrorAdditionalInfo

ErrorContract

ErrorResponse

FailingPeriods

Kind

ScheduledQueryRuleCriteria

ScheduledQueryRuleResource

systemData

timeAggregation