Scheduled Query Rules - Get

Riferimento

Servizio:: Monitor

Versione API:: 2021-08-01

Recuperare una definizione di regola di query pianificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
ruleName	path	True	string	Nome della regola.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	ScheduledQueryRuleResource	Richiesta riuscita per ottenere una regola di query pianificata
Other Status Codes	ErrorContract	BadRequest

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Get a scheduled query rule for single resource

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
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 è più grave. Rilevante e obbligatorio solo per le regole del tipo LogAlert.
Condition	Condizione della regola di query pianificata.
conditionOperator	Operatore criteri. Pertinente e obbligatorio solo per le regole del tipo LogAlert.
createdByType	Tipo di identità che ha creato la risorsa.
Dimension	Definizione di suddivisione e filtro delle dimensioni
dimensionOperator	Operatore per i valori della dimensione
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. Pertinente solo per le regole del tipo LogAlert.
Kind	Indica il tipo di regola di query pianificata. Il valore predefinito è LogAlert.
ScheduledQueryRuleCriteria	Criteri delle regole che definiscono le condizioni della regola di query pianificata.
ScheduledQueryRuleResource	Risorsa della regola di query pianificata.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
timeAggregation	Tipo di aggregazione. Rilevante e obbligatorio solo per le regole del tipo LogAlert.

Actions

Azioni da richiamare quando viene generato l'avviso.

Nome	Tipo	Descrizione
actionGroups	string[]	ID risorsa 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 è più grave. Rilevante e obbligatorio solo per le regole del tipo LogAlert.

Nome	Tipo	Descrizione
0	Integer
1	Integer
2	Integer
3	Integer
4	Integer

Condition

Condizione della regola di query pianificata.

Nome	Tipo	Descrizione
dimensions	Dimension[]	Elenco delle condizioni delle dimensioni
failingPeriods	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 del tipo LogAlert.
metricName	string	Nome della metrica da inviare. Rilevante e obbligatorio solo per le regole del tipo LogToMetric.
operator	conditionOperator	Operatore criteria. Rilevante e obbligatorio solo per le regole del 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 del tipo LogAlert.
threshold	number	valore soglia criteri che attiva l'avviso. Rilevante e obbligatorio solo per le regole del tipo LogAlert.
timeAggregation	timeAggregation	Tipo di aggregazione. Rilevante e obbligatorio solo per le regole del tipo LogAlert.

conditionOperator

Operatore criteri. Pertinente e obbligatorio solo per le regole del tipo LogAlert.

Nome	Tipo	Descrizione
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

Dimension

Definizione di suddivisione e filtro delle dimensioni

Nome	Tipo	Descrizione
name	string	Nome della dimensione
operator	dimensionOperator	Operatore per i valori della dimensione
values	string[]	Elenco dei valori delle dimensioni

dimensionOperator

Operatore per i valori della dimensione

Nome	Tipo	Descrizione
Exclude	string
Include	string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorContract

Descrive il formato della risposta di errore.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta di errore Dettagli dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorResponse[]	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. Pertinente solo per le regole del tipo LogAlert.

Nome	Tipo	Valore predefinito	Descrizione
minFailingPeriodsToAlert	integer	1	Numero di violazioni per attivare un avviso. Deve essere minore o uguale al numeroOfEvaluationPeriods. Il valore predefinito è 1
numberOfEvaluationPeriods	integer	1	Numero di punti di lookback aggregati. La finestra temporale di lookback viene calcolata 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.

Nome	Tipo	Descrizione
LogAlert	string
LogToMetric	string

ScheduledQueryRuleCriteria

Criteri delle regole che definiscono le condizioni della regola di query pianificata.

Nome	Tipo	Descrizione
allOf	Condition[]	Elenco di condizioni da valutare rispetto agli ambiti specificati

ScheduledQueryRuleResource

Risorsa della regola di query pianificata.

Nome	Tipo	Descrizione
etag	string	Il campo etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve anche essere fornito come intestazione in base alla convenzione etag normale. I tag di entità vengono usati per confrontare due o più entità dalla 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	Kind	Indica il tipo di regola di query pianificata. Il valore predefinito è LogAlert.
location	string	Posizione geografica in cui risiede la risorsa
name	string	nome della risorsa.
properties.actions	Actions	Azioni da richiamare quando viene generato l'avviso.
properties.autoMitigate	boolean	Flag che indica se l'avviso deve essere risolto o meno automaticamente. Il valore predefinito è true. Rilevante solo per le regole del tipo LogAlert.
properties.checkWorkspaceAlertsStorageConfigured	boolean	Flag che indica se questa regola di query pianificata deve essere archiviata nella risorsa di archiviazione del cliente. Il valore predefinito è false. Rilevante solo per le regole del tipo LogAlert.
properties.createdWithApiVersion	string	Versione api usata durante la creazione di questa regola di avviso
properties.criteria	ScheduledQueryRuleCriteria	Criteri delle regole che definiscono 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 con cui la regola di query pianificata viene valutata rappresentata nel formato di durata ISO 8601. Rilevante e obbligatorio solo per le regole del tipo LogAlert.
properties.isLegacyLogAnalyticsRule	boolean	True se la regola di avviso è una regola legacy di Log Analytics
properties.isWorkspaceAlertsStorageConfigured	boolean	Flag che indica se questa regola di query pianificata è stata configurata per essere archiviata nella risorsa di archiviazione del cliente. Il valore predefinito è false.
properties.muteActionsDuration	string	Disattivare le azioni per il periodo di tempo scelto (in formato di durata ISO 8601) dopo l'invio dell'avviso. Rilevante solo per le regole del 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 del tipo LogAlert.
properties.scopes	string[]	Elenco di ID risorsa a cui questa regola di query pianificata ha come ambito.
properties.severity	AlertSeverity	Gravità dell'avviso Deve essere un numero intero compreso tra [0-4]. Il valore 0 è più grave. Rilevante e obbligatorio solo per le regole del 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 del tipo LogAlert.
properties.targetResourceTypes	string[]	Elenco del tipo 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 (in formato di durata ISO 8601) in cui verrà eseguita la query di avviso (dimensioni bin). Rilevante e obbligatorio solo per le regole del tipo LogAlert.
systemData	systemData	SystemData di ScheduledQueryRule.
tags	object	Tag delle risorse.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

systemData

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

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

timeAggregation

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

Nome	Tipo	Descrizione
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

Condividi tramite