Scheduled Query Rules - Get

Riferimento

Servizio:: Monitor

Versione API:: 2018-04-16

Ottiene una regola di ricerca log

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2018-04-16

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	LogSearchRuleResource	Richiesta riuscita per ottenere una regola di ricerca log
Other Status Codes	ErrorContract	Risposta di errore che descrive perché l'operazione non è riuscita.

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 rule

Esempio di richiesta

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

import com.azure.core.util.Context;

/** Samples for ScheduledQueryRules GetByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
     */
    /**
     * Sample code: Get rule.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .diagnosticSettings()
            .manager()
            .serviceClient()
            .getScheduledQueryRules()
            .getByResourceGroupWithResponse("Rac46PostSwapRG", "logalertfoo", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armmonitor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
func ExampleScheduledQueryRulesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewScheduledQueryRulesClient("b67f7fec-69fc-4974-9099-a26bd6ffeda3", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"Rac46PostSwapRG",
		"logalertfoo",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { MonitorClient } = require("@azure/arm-monitor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets an Log Search rule
 *
 * @summary Gets an Log Search rule
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
 */
async function getRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
  const ruleName = "logalertfoo";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.scheduledQueryRules.get(resourceGroupName, ruleName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/scheduledQueryRules/logalertfoo",
  "name": "logalertfoo",
  "type": "Microsoft.Insights/scheduledQueryRules",
  "location": "West US",
  "tags": {},
  "properties": {
    "description": "log alert description",
    "enabled": "true",
    "lastUpdatedTime": "2017-06-23T21:23:52.0221265Z",
    "provisioningState": "Succeeded",
    "source": {
      "query": "requests",
      "queryType": "ResultCount",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3
      },
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      }
    }
  }
}

Definizioni

Nome	Descrizione
AlertingAction	Specificare l'azione da eseguire quando il tipo di regola è Avviso
AlertSeverity	Livello di gravità dell'avviso
AzNsActionGroup	Gruppo di azioni di Azure
ConditionalOperator	Criteri di valutazione delle condizioni dei risultati.
Criteria	Specifica i criteri per la conversione del log in metrica.
Dimension	Specifica i criteri per la conversione del log in metrica.
enabled	Flag che indica se la regola ricerca log è abilitata. Il valore deve essere true o false
ErrorContract	Descrive il formato della risposta all'errore.
ErrorResponse	Descrive il formato della risposta all'errore.
LogMetricTrigger	Descrittore del trigger delle metriche di log.
LogSearchRuleResource	Risorsa Regola di ricerca log.
LogToMetricAction	Specificare l'azione da eseguire quando il tipo di regola converte il log in metrica
metricTriggerType	Tipo di trigger delle metriche - 'Consecutive' o 'Total'
operator	Operatore per i valori della dimensione
provisioningState	Stato di provisioning della regola di query pianificata
QueryType	Impostare il valore su 'ResultAccount'
Schedule	Definisce la frequenza con cui eseguire la ricerca e l'intervallo di tempo.
Source	Specifica la query di ricerca log.
TriggerCondition	Condizione che genera la regola Ricerca log.

AlertingAction

Specificare l'azione da eseguire quando il tipo di regola è Avviso

Nome	Tipo	Descrizione
aznsAction	AzNsActionGroup	Informazioni di riferimento sul gruppo di azioni di Azure.
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	Specifica l'azione. Valori supportati - AlertingAction, LogToMetricAction
severity	AlertSeverity	Gravità dell'avviso
throttlingInMin	integer	tempo (in minuti) per il quale gli avvisi devono essere limitati o eliminati.
trigger	TriggerCondition	Condizione di trigger che comporta la regola di avviso.

AlertSeverity

Livello di gravità dell'avviso

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

AzNsActionGroup

Gruppo di azioni di Azure

Nome	Tipo	Descrizione
actionGroup	string[]	Informazioni di riferimento sul gruppo di azioni di Azure.
customWebhookPayload	string	Payload personalizzato da inviare per tutti gli URI webhook nel gruppo di azioni di Azure
emailSubject	string	Override dell'oggetto personalizzato per tutti gli ID di posta elettronica nel gruppo di azioni di Azure

ConditionalOperator

Criteri di valutazione delle condizioni dei risultati.

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

Criteria

Specifica i criteri per la conversione del log in metrica.

Nome	Tipo	Descrizione
dimensions	Dimension[]	Elenco delle dimensioni per la creazione di metriche
metricName	string	Nome della metrica

Dimension

Specifica i criteri per la conversione del log in metrica.

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

enabled

Flag che indica se la regola ricerca log è abilitata. Il valore deve essere true o false

Nome	Tipo	Descrizione
false	string
true	string

ErrorContract

Descrive il formato della risposta all'errore.

Nome	Tipo	Descrizione
error	ErrorResponse	Dettagli dell'errore.

ErrorResponse

Descrive il formato della risposta all'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

LogMetricTrigger

Descrittore del trigger delle metriche di log.

Nome	Tipo	Valore predefinito	Descrizione
metricColumn	string		Valutazione della metrica in una determinata colonna
metricTriggerType	metricTriggerType	Consecutive	Tipo di trigger delle metriche - 'Consecutive' o 'Total'
threshold	number		Soglia del trigger della metrica.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operazione di valutazione per metrica -'GreaterThan' o 'LessThan' o 'Equal'.

LogSearchRuleResource

Risorsa Regola di ricerca log.

Nome	Tipo	Valore predefinito	Descrizione
etag	string		Il campo etag non è obbligatorio. Se viene fornito nel corpo della risposta, deve essere fornito anche come intestazione per la normale convenzione etag. I tag di entità vengono usati per confrontare due o più entità dalla stessa risorsa richiesta. HTTP/1.1 usa i tag di entità nell'etag (sezione 14.19), If-Match (sezione 14.24), If-None-Match (sezione 14.26) e If-Range (sezione 14.27).
id	string		ID risorsa di Azure
kind	string		Metadati usati dal portale/strumenti/ecc per eseguire il rendering di esperienze utente diverse per le risorse dello stesso tipo; Ad esempio, ApiApps è un tipo di tipo Microsoft.Web/sites. Se supportato, il provider di risorse deve convalidare e rendere persistente questo valore.
location	string		Posizione risorsa
name	string		Nome risorsa di Azure
properties.action	Action: AlertingAction LogToMetricAction		L'azione deve essere eseguita sull'esecuzione della regola.
properties.autoMitigate	boolean	False	Flag che indica se l'avviso deve essere risolto automaticamente o meno. Il valore predefinito è false.
properties.createdWithApiVersion	string		Versione api usata durante la creazione di questa regola di avviso
properties.description	string		Descrizione della regola Ricerca log.
properties.displayName	string		Nome visualizzato della regola di avviso
properties.enabled	enabled		Flag che indica se la regola ricerca log è abilitata. Il valore deve essere true o false
properties.isLegacyLogAnalyticsRule	boolean		True se la regola di avviso è una regola di log analitica legacy
properties.lastUpdatedTime	string		Ultima volta che la regola è stata aggiornata in formato IS08601.
properties.provisioningState	provisioningState		Stato di provisioning della regola di query pianificata
properties.schedule	Schedule		Pianificazione (frequenza, intervallo di tempo) per la regola. Obbligatorio per il tipo di azione - AlertingAction
properties.source	Source		Origine dati in base alla quale regola eseguirà query sui dati
tags	object		Tag delle risorse
type	string		Tipo di risorsa di Azure

LogToMetricAction

Specificare l'azione da eseguire quando il tipo di regola converte il log in metrica

Nome	Tipo	Descrizione
criteria	Criteria[]	Criteri di metrica
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	Specifica l'azione. Valori supportati - AlertingAction, LogToMetricAction

metricTriggerType

Tipo di trigger delle metriche - 'Consecutive' o 'Total'

Nome	Tipo	Descrizione
Consecutive	string
Total	string

operator

Operatore per i valori della dimensione

Nome	Tipo	Descrizione
Include	string

provisioningState

Stato di provisioning della regola di query pianificata

Nome	Tipo	Descrizione
Canceled	string
Deploying	string
Failed	string
Succeeded	string

QueryType

Impostare il valore su 'ResultAccount'

Nome	Tipo	Descrizione
ResultCount	string

Schedule

Definisce la frequenza con cui eseguire la ricerca e l'intervallo di tempo.

Nome	Tipo	Descrizione
frequencyInMinutes	integer	frequenza (in minuti) in corrispondenza della quale deve essere valutata la condizione della regola.
timeWindowInMinutes	integer	Intervallo di tempo per il quale i dati devono essere recuperati per la query (devono essere maggiori o uguali a frequencyInMinutes).

Source

Specifica la query di ricerca log.

Nome	Tipo	Descrizione
authorizedResources	string[]	Elenco di risorse a cui fa riferimento la query
dataSourceId	string	URI della risorsa su cui eseguire la query di ricerca log.
query	string	Query di ricerca log. Obbligatorio per il tipo di azione - AlertingAction
queryType	QueryType	Impostare il valore su 'ResultCount' .

TriggerCondition

Condizione che genera la regola Ricerca log.

Nome	Tipo	Valore predefinito	Descrizione
metricTrigger	LogMetricTrigger		Condizione di trigger per la regola di query delle metriche
threshold	number		Soglia di risultato o conteggio in base alla regola da attivare.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operazione di valutazione per la regola : 'GreaterThan' o 'LessThan'.

Condividi tramite

Scheduled Query Rules - Get

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Get rule

Esempio di richiesta

Risposta di esempio

Definizioni

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

Risorse aggiuntive