Scheduled Query Rules - List By Resource Group

Recuperare le definizioni delle regole di query pianificate in un gruppo di risorse.

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

Parametri dell'URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True
  • string

ID della sottoscrizione di destinazione.

api-version
query True
  • string

Versione dell'API da usare per questa operazione.

Risposte

Name Type Description
200 OK

Richiesta riuscita per un elenco di regole di query pianificate

Other Status Codes

BadRequest

Sicurezza

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 rappresentare l'account utente

Esempio

List scheduled query rules by resource group

Sample Request

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

Sample Response

{
  "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/resourceGroups/scopeResourceGroup1"
        ],
        "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/QueryResourceGroupName/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/resourceGroups/scopeResourceGroup1"
        ],
        "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
      }
    }
  ]
}

Definizioni

Actions

Azioni da richiamare quando viene generato l'avviso.

AlertSeverity

Gravità dell'avviso Deve essere un numero intero compreso tra [0-4]. Il valore 0 è il più grave. Pertinente e obbligatorio solo per le regole di tipo LogAlert.

Condition

Condizione della regola di query pianificata.

conditionOperator

Operatore di criteri. Rilevante e obbligatorio solo per regole di tipo LogAlert.

createdByType

Tipo di identità che ha creato la risorsa.

Dimension

Definizione di suddivisione e filtro delle dimensioni

dimensionOperator

Operatore per i valori delle dimensioni

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorContract

Descrive il formato della risposta di errore.

ErrorResponse

Risposta di errore

FailingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso. Rilevante solo per le regole del tipo LogAlert.

Kind

Indica il tipo di regola di query pianificata. Il valore predefinito è LogAlert.

ScheduledQueryRuleCriteria

Criteri della regola che definisce le condizioni della regola di query pianificata.

ScheduledQueryRuleResource

Risorsa della regola di query pianificata.

ScheduledQueryRuleResourceCollection

Rappresenta una raccolta di risorse delle regole di query pianificate.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

timeAggregation

Tipo di aggregazione. Rilevante e obbligatorio solo per regole di tipo LogAlert.

Actions

Azioni da richiamare quando viene generato l'avviso.

Name Type Description
actionGroups
  • string[]

ID risorsa del gruppo di azioni da richiamare quando viene generato l'avviso.

customProperties
  • object

Proprietà di un payload di avviso.

AlertSeverity

Gravità dell'avviso Deve essere un numero intero compreso tra [0-4]. Il valore 0 è il più grave. Pertinente e obbligatorio solo per le regole di tipo LogAlert.

Name Type Description
0
  • string
1
  • string
2
  • string
3
  • string
4
  • string

Condition

Condizione della regola di query pianificata.

Name Type Description
dimensions

Elenco di condizioni di dimensioni

failingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso. Rilevante solo per le regole del tipo LogAlert.

metricMeasureColumn
  • string

Colonna contenente il numero di misura della metrica. Rilevante solo per le regole di tipo LogAlert.

metricName
  • string

Nome della metrica da inviare. Rilevante e obbligatorio solo per le regole del tipo LogToMetric.

operator

Operatore criteri. Rilevante e obbligatorio solo per regole di tipo LogAlert.

query
  • string

Avviso di query di log

resourceIdColumn
  • string

Colonna contenente l'ID risorsa. Il contenuto della colonna deve essere un URI formattato come ID risorsa. Rilevante solo per le regole di tipo LogAlert.

threshold
  • number

Valore soglia dei criteri che attiva l'avviso. Rilevante e obbligatorio solo per regole di tipo LogAlert.

timeAggregation

Tipo di aggregazione. Pertinente e obbligatorio solo per le regole di tipo LogAlert.

conditionOperator

Operatore di criteri. Rilevante e obbligatorio solo per regole di tipo LogAlert.

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

createdByType

Tipo di identità che ha creato la risorsa.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Dimension

Definizione di suddivisione e filtro delle dimensioni

Name Type Description
name
  • string

Nome della dimensione

operator

Operatore per i valori delle dimensioni

values
  • string[]

Elenco di valori di dimensione

dimensionOperator

Operatore per i valori delle dimensioni

Name Type Description
Exclude
  • string
Include
  • string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Name Type Description
info
  • object

Informazioni aggiuntive.

type
  • string

Tipo di informazioni aggiuntive.

ErrorContract

Descrive il formato della risposta di errore.

Name Type Description
error

Risposta di errore
Dettagli dell'errore.

ErrorResponse

Risposta di errore

Name Type Description
additionalInfo

Informazioni aggiuntive sull'errore.

code
  • string

Codice di errore.

details

Dettagli dell'errore.

message
  • string

Messaggio di errore.

target
  • string

Destinazione dell'errore.

FailingPeriods

Numero minimo di violazioni necessarie all'interno dell'intervallo di tempo di lookback selezionato necessario per generare un avviso. Rilevante solo per le regole del tipo LogAlert.

Name Type Description
minFailingPeriodsToAlert
  • integer

Numero di violazioni per attivare un avviso. Deve essere minore o uguale a numberOfEvaluationPeriods. Il valore predefinito è 1

numberOfEvaluationPeriods
  • integer

Numero di punti di lookback aggregati. L'intervallo di tempo di lookback viene calcolato in base alla granularità dell'aggregazione (windowSize) e al numero selezionato di punti aggregati. Il valore predefinito è 1

Kind

Indica il tipo di regola di query pianificata. Il valore predefinito è LogAlert.

Name Type Description
LogAlert
  • string
LogToMetric
  • string

ScheduledQueryRuleCriteria

Criteri della regola che definisce le condizioni della regola di query pianificata.

Name Type Description
allOf

Elenco di condizioni da valutare rispetto agli ambiti specificati

ScheduledQueryRuleResource

Risorsa della regola di query pianificata.

Name Type Description
etag
  • string

Il campo etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione in base alla normale convenzione etag. I tag di entità vengono usati per confrontare due o più entità della stessa risorsa richiesta. HTTP/1.1 usa i tag di entità nei campi di intestazione etag (sezione 14.19), If-Match (sezione 14.24), If-None-Match (sezione 14.26) e If-Range (sezione 14.27).

id
  • string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

kind

Indica il tipo di regola di query pianificata. Il valore predefinito è LogAlert.

location
  • string

Posizione geografica in cui si trova la risorsa

name
  • string

nome della risorsa.

properties.actions

Azioni da richiamare quando viene generato l'avviso.

properties.autoMitigate
  • boolean

Flag che indica se l'avviso deve essere risolto automaticamente o meno. Il valore predefinito è true. Rilevante solo per le regole di tipo LogAlert.

properties.checkWorkspaceAlertsStorageConfigured
  • boolean

Flag che indica se questa regola di query pianificata deve essere archiviata nell'archiviazione del cliente. Il valore predefinito è false. Rilevante solo per le regole di tipo LogAlert.

properties.createdWithApiVersion
  • string

Versione api usata durante la creazione di questa regola di avviso

properties.criteria

Criteri della regola che definisce le condizioni della regola di query pianificata.

properties.description
  • string

Descrizione della regola di query pianificata.

properties.displayName
  • string

Nome visualizzato della regola di avviso

properties.enabled
  • boolean

Flag che indica se questa regola di query pianificata è abilitata. Il valore deve essere true o false

properties.evaluationFrequency
  • string

Frequenza di valutazione della regola di query pianificata rappresentata nel formato di durata ISO 8601. Pertinente e obbligatorio solo per le regole di tipo LogAlert.

properties.isLegacyLogAnalyticsRule
  • boolean

True se la regola di avviso è una regola di analisi dei log legacy

properties.isWorkspaceAlertsStorageConfigured
  • boolean

Flag che indica se questa regola di query pianificata è stata configurata per essere archiviata nell'archiviazione del cliente. Il valore predefinito è false.

properties.muteActionsDuration
  • string

Disattivare le azioni per il periodo di tempo scelto (nel formato di durata ISO 8601) dopo l'attivazione dell'avviso. Rilevante solo per le regole di tipo LogAlert.

properties.overrideQueryTimeRange
  • string

Se specificato, esegue l'override dell'intervallo di tempo della query (il valore predefinito è WindowSize*NumberOfEvaluationPeriods). Rilevante solo per le regole di tipo LogAlert.

properties.scopes
  • string[]

Elenco di ID risorsa a cui è stato ambito questa regola di query pianificata.

properties.severity

Gravità dell'avviso Deve essere un numero intero compreso tra [0-4]. Il valore 0 è il più grave. Pertinente e obbligatorio solo per le regole di tipo LogAlert.

properties.skipQueryValidation
  • boolean

Flag che indica se la query specificata deve essere convalidata o meno. Il valore predefinito è false. Rilevante solo per le regole di tipo LogAlert.

properties.targetResourceTypes
  • string[]

Elenco di tipi di risorsa delle risorse di destinazione in cui viene creato/aggiornato l'avviso. Ad esempio, se l'ambito è un gruppo di risorse e targetResourceTypes è Microsoft.Compute/virtualMachines, verrà generato un avviso diverso per ogni macchina virtuale nel gruppo di risorse che soddisfa i criteri di avviso. Rilevante solo per le regole del tipo LogAlert

properties.windowSize
  • string

Periodo di tempo (nel formato di durata ISO 8601) in cui verrà eseguita la query Di avviso (dimensione bin). Pertinente e obbligatorio solo per le regole di tipo LogAlert.

systemData

SystemData di ScheduledQueryRule.

tags
  • object

Tag delle risorse.

type
  • string

Tipo di risorsa. ad esempio "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"

ScheduledQueryRuleResourceCollection

Rappresenta una raccolta di risorse delle regole di query pianificate.

Name Type Description
value

Valori per le risorse della regola di query pianificata.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Name Type Description
createdAt
  • string

Timestamp della creazione di risorse (UTC).

createdBy
  • string

Identità che ha creato la risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt
  • string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy
  • string

Identità dell'ultima modifica della risorsa.

lastModifiedByType

Tipo di identità che ha modificato la risorsa per l'ultima volta.

timeAggregation

Tipo di aggregazione. Rilevante e obbligatorio solo per regole di tipo LogAlert.

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