Scheduled Query Rules - List By Subscription

Service:

Monitor

API-versie:

2021-08-01

Haal definities van een geplande queryregel op in een abonnement.

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

URI-parameters

Name	In	Vereist	Type	Description
subscriptionId	path	True	string	De id van het doelabonnement.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ScheduledQueryRuleResourceCollection	Geslaagde aanvraag voor een lijst met geplande queryregels
Other Status Codes	ErrorContract	BadRequest

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List scheduled query rules by subscription

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Actions	Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd.
AlertSeverity	Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert.
Condition	Een voorwaarde van de geplande queryregel.
conditionOperator	De operator criteria. Relevant en alleen vereist voor regels van het type LogAlert.
createdByType	Het type identiteit waarmee de resource is gemaakt.
Dimension	Definitie van het splitsen en filteren van dimensies
dimensionOperator	Operator voor dimensiewaarden
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorContract	Beschrijft de indeling van foutantwoord.
ErrorResponse	Foutreactie
FailingPeriods	Het minimale aantal schendingen dat is vereist binnen het geselecteerde tijdvenster voor lookback dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert.
Kind	Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert.
ScheduledQueryRuleCriteria	De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd.
ScheduledQueryRuleResource	De resource van de geplande queryregel.
ScheduledQueryRuleResourceCollection	Vertegenwoordigt een verzameling geplande queryregelresources.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
timeAggregation	Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert.

Actions

Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd.

Name	Type	Description
actionGroups	string[]	Resource-id's van actiegroep die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd.
customProperties	object	De eigenschappen van een waarschuwingspayload.

AlertSeverity

Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert.

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

Condition

Een voorwaarde van de geplande queryregel.

Name	Type	Description
dimensions	Dimension[]	Voorwaarden voor lijst met dimensies
failingPeriods	FailingPeriods	Het minimale aantal schendingen dat is vereist binnen het geselecteerde terugbliktijdvenster dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert.
metricMeasureColumn	string	De kolom met het metrische meetnummer. Alleen relevant voor regels van het type LogAlert.
metricName	string	De naam van het metrische gegeven dat moet worden verzonden. Relevant en alleen vereist voor regels van het type LogToMetric.
operator	conditionOperator	De criteriaoperator. Relevant en alleen vereist voor regels van het type LogAlert.
query	string	Waarschuwing voor logboekquery's
resourceIdColumn	string	De kolom met de resource-id. De inhoud van de kolom moet een URI zijn die is opgemaakt als resource-id. Alleen relevant voor regels van het type LogAlert.
threshold	number	de drempelwaarde voor criteria waarmee de waarschuwing wordt geactiveerd. Relevant en alleen vereist voor regels van het type LogAlert.
timeAggregation	timeAggregation	Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert.

conditionOperator

De operator criteria. Relevant en alleen vereist voor regels van het type LogAlert.

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

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Definitie van het splitsen en filteren van dimensies

Name	Type	Description
name	string	Naam van de dimensie
operator	dimensionOperator	Operator voor dimensiewaarden
values	string[]	Lijst met dimensiewaarden

dimensionOperator

Operator voor dimensiewaarden

Name	Type	Description
Exclude	string
Include	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorContract

Beschrijft de indeling van foutantwoord.

Name	Type	Description
error	ErrorResponse	Foutreactie De foutdetails.

ErrorResponse

Foutreactie

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorResponse[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

FailingPeriods

Het minimale aantal schendingen dat is vereist binnen het geselecteerde tijdvenster voor lookback dat is vereist om een waarschuwing te genereren. Alleen relevant voor regels van het type LogAlert.

Name	Type	Default value	Description
minFailingPeriodsToAlert	integer	1	Het aantal schendingen dat een waarschuwing moet activeren. Moet kleiner of gelijk zijn aan numberOfEvaluationPeriods. De standaardwaarde is 1
numberOfEvaluationPeriods	integer	1	Het aantal geaggregeerde lookbackpunten. Het tijdvenster voor lookback wordt berekend op basis van de aggregatiegranulariteit (windowSize) en het geselecteerde aantal geaggregeerde punten. De standaardwaarde is 1

Kind

Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert.

Name	Type	Description
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd.

Name	Type	Description
allOf	Condition[]	Een lijst met voorwaarden om te evalueren op de opgegeven bereiken

ScheduledQueryRuleResource

De resource van de geplande queryregel.

Name	Type	Description
etag	string	Het veld etag is niet vereist. Als deze is opgegeven in de hoofdtekst van het antwoord, moet deze ook worden opgegeven als een header volgens de normale etag-conventie. Entiteitstags worden gebruikt voor het vergelijken van twee of meer entiteiten uit dezelfde aangevraagde resource. HTTP/1.1 maakt gebruik van entiteitstags in de koptekstvelden etag (sectie 14.19), If-Match (sectie 14.24), If-None-Match (sectie 14.26) en If-Range (sectie 14.27).
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	Kind	Geeft het type geplande queryregel aan. De standaardwaarde is LogAlert.
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.actions	Actions	Acties die moeten worden aangeroepen wanneer de waarschuwing wordt geactiveerd.
properties.autoMitigate	boolean	De vlag die aangeeft of de waarschuwing automatisch moet worden opgelost of niet. De standaardwaarde is true. Alleen relevant voor regels van het type LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	De vlag die aangeeft of deze geplande queryregel moet worden opgeslagen in de opslag van de klant. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert.
properties.createdWithApiVersion	string	De API-versie die wordt gebruikt bij het maken van deze waarschuwingsregel
properties.criteria	ScheduledQueryRuleCriteria	De regelcriteria waarmee de voorwaarden van de geplande queryregel worden gedefinieerd.
properties.description	string	De beschrijving van de geplande queryregel.
properties.displayName	string	De weergavenaam van de waarschuwingsregel
properties.enabled	boolean	De vlag die aangeeft of deze geplande queryregel is ingeschakeld. Waarde moet waar of onwaar zijn
properties.evaluationFrequency	string	Hoe vaak de geplande queryregel wordt geëvalueerd, wordt weergegeven in iso 8601-duurnotatie. Relevant en alleen vereist voor regels van het type LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	Waar als de waarschuwingsregel een verouderde Log Analytics-regel is
properties.isWorkspaceAlertsStorageConfigured	boolean	De vlag die aangeeft of deze geplande queryregel is geconfigureerd om te worden opgeslagen in de opslag van de klant. De standaardwaarde is false.
properties.muteActionsDuration	string	Acties dempen gedurende de gekozen periode (in ISO 8601-duurnotatie) nadat de waarschuwing is geactiveerd. Alleen relevant voor regels van het type LogAlert.
properties.overrideQueryTimeRange	string	Indien opgegeven overschrijft het querytijdbereik (standaard is WindowSize*NumberOfEvaluationPeriods). Alleen relevant voor regels van het type LogAlert.
properties.scopes	string[]	De lijst met resource-id's waarop deze geplande queryregel is gericht.
properties.severity	AlertSeverity	Ernst van de waarschuwing. Moet een geheel getal zijn tussen [0-4]. De waarde van 0 is het ernstigst. Relevant en alleen vereist voor regels van het type LogAlert.
properties.skipQueryValidation	boolean	De vlag die aangeeft of de opgegeven query moet worden gevalideerd of niet. De standaardwaarde is false. Alleen relevant voor regels van het type LogAlert.
properties.targetResourceTypes	string[]	Lijst met het resourcetype van de doelresource(s) waarop de waarschuwing wordt gemaakt/bijgewerkt. Als het bereik bijvoorbeeld een resourcegroep is en targetResourceTypes Microsoft.Compute/virtualMachines is, wordt er een andere waarschuwing geactiveerd voor elke virtuele machine in de resourcegroep die voldoet aan de waarschuwingscriteria. Alleen relevant voor regels van het type LogAlert
properties.windowSize	string	De periode (in ISO 8601-duurnotatie) waarop de waarschuwingsquery wordt uitgevoerd (bin-grootte). Relevant en alleen vereist voor regels van het type LogAlert.
systemData	systemData	SystemData van ScheduledQueryRule.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ScheduledQueryRuleResourceCollection

Vertegenwoordigt een verzameling geplande queryregelresources.

Name	Type	Description
nextLink	string	Biedt de koppeling om de volgende set elementen op te halen.
value	ScheduledQueryRuleResource[]	De waarden voor de resources van de geplande queryregels.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	Het tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

timeAggregation

Aggregatietype. Relevant en alleen vereist voor regels van het type LogAlert.

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