Scheduled Query Rules - Get

Reference

Služba:: Monitor

Verze rozhraní API:: 2018-04-16

Získá pravidlo prohledávání protokolu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
ruleName	path	True	string	Název pravidla.
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	LogSearchRuleResource	Úspěšný požadavek na získání pravidla prohledávání protokolu
Other Status Codes	ErrorContract	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Get rule

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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": "{}"
      }
    }
  }
}

Definice

Name	Description
AlertingAction	Zadejte akci, která se má provést, když je typ pravidla Výstraha.
AlertSeverity	Úroveň závažnosti výstrahy
AzNsActionGroup	Skupina akcí Azure
ConditionalOperator	Kritéria vyhodnocení podmínky výsledku
Criteria	Určuje kritéria pro převod protokolu na metriku.
Dimension	Určuje kritéria pro převod protokolu na metriku.
enabled	Příznak, který označuje, jestli je pravidlo prohledávání protokolu povolené. Hodnota by měla být true nebo false.
ErrorContract	Popisuje formát chybové odpovědi.
ErrorResponse	Popisuje formát chybové odpovědi.
LogMetricTrigger	Popisovač triggeru metrik protokolu
LogSearchRuleResource	Prostředek pravidla prohledávání protokolu.
LogToMetricAction	Zadejte akci, která se musí provést, když typ pravidla převádí protokol na metriku.
metricTriggerType	Typ triggeru metriky – po sobě jdoucí nebo celkem
operator	Operátor pro hodnoty dimenzí
provisioningState	Stav zřizování pravidla naplánovaného dotazu
QueryType	Nastavte hodnotu na ResultAccount.
Schedule	Definuje, jak často se má vyhledávání spouštět a časový interval.
Source	Určuje dotaz prohledávání protokolu.
TriggerCondition	Podmínka, která má za následek pravidlo prohledávání protokolu.

AlertingAction

Zadejte akci, která se má provést, když je typ pravidla Výstraha.

Name	Typ	Description
aznsAction	AzNsActionGroup	Referenční informace ke skupinám akcí Azure
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	Určuje akci. Podporované hodnoty – AlertingAction, LogToMetricAction
severity	AlertSeverity	Závažnost výstrahy
throttlingInMin	integer	čas (v minutách), po který by měla být upozornění omezována nebo potlačena.
trigger	TriggerCondition	Aktivační podmínka, která má za následek, že pravidlo upozornění je.

AlertSeverity

Úroveň závažnosti výstrahy

Name	Typ	Description
0	string
1	string
2	string
3	string
4	string

AzNsActionGroup

Skupina akcí Azure

Name	Typ	Description
actionGroup	string[]	Referenční informace ke skupinám akcí Azure
customWebhookPayload	string	Vlastní datová část, která se má odeslat pro všechny identifikátory URI webhooku ve skupině akcí Azure
emailSubject	string	Přepsání vlastního předmětu pro všechna ID e-mailu ve skupině akcí Azure

ConditionalOperator

Kritéria vyhodnocení podmínky výsledku

Name	Typ	Description
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

Criteria

Určuje kritéria pro převod protokolu na metriku.

Name	Typ	Description
dimensions	Dimension[]	Seznam dimenzí pro vytvoření metriky
metricName	string	Název metriky

Dimension

Určuje kritéria pro převod protokolu na metriku.

Name	Typ	Description
name	string	Název dimenze
operator	operator	Operátor pro hodnoty dimenzí
values	string[]	Seznam hodnot dimenzí

enabled

Příznak, který označuje, jestli je pravidlo prohledávání protokolu povolené. Hodnota by měla být true nebo false.

Name	Typ	Description
false	string
true	string

ErrorContract

Popisuje formát chybové odpovědi.

Name	Typ	Description
error	ErrorResponse	Podrobnosti o chybě.

ErrorResponse

Popisuje formát chybové odpovědi.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva s informacemi o tom, proč operace selhala.

LogMetricTrigger

Popisovač triggeru metrik protokolu

Name	Typ	Default value	Description
metricColumn	string		Vyhodnocení metriky pro konkrétní sloupec
metricTriggerType	metricTriggerType	Consecutive	Typ triggeru metriky – po sobě jdoucí nebo celkem
threshold	number		Prahová hodnota triggeru metriky
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operace vyhodnocení pro metriku -'GreaterThan' nebo 'LessThan' nebo 'Equal'.

LogSearchRuleResource

Prostředek pravidla prohledávání protokolu.

Name	Typ	Default value	Description
etag	string		Pole etag není povinné. Pokud je uvedený v textu odpovědi, musí být také uvedený jako hlavička podle normální konvence etag. Značky entit se používají k porovnání dvou nebo více entit ze stejného požadovaného prostředku. HTTP/1.1 používá značky entit v polích hlaviček etag (oddíl 14.19), If-Match (oddíl 14.24), If-None-Match (oddíl 14.26) a If-Range (oddíl 14.27).
id	string		ID prostředku Azure
kind	string		Metadata používaná portálem, nástroji atd. k vykreslení různých prostředí uživatelského prostředí pro prostředky stejného typu; Například ApiApps jsou druhem typu Microsoft.Web/sites. Pokud je tato možnost podporovaná, poskytovatel prostředků musí tuto hodnotu ověřit a zachovat.
location	string		Umístění prostředku
name	string		Název prostředku Azure
properties.action	Action: AlertingAction LogToMetricAction		Při provádění pravidla je potřeba provést akci.
properties.autoMitigate	boolean	False	Příznak, který označuje, jestli se má upozornění automaticky vyřešit, nebo ne. Výchozí hodnotou je hodnota false.
properties.createdWithApiVersion	string		Verze rozhraní API použitá při vytváření tohoto pravidla upozornění
properties.description	string		Popis pravidla prohledávání protokolu.
properties.displayName	string		Zobrazovaný název pravidla upozornění
properties.enabled	enabled		Příznak, který označuje, jestli je pravidlo prohledávání protokolu povolené. Hodnota by měla být true nebo false.
properties.isLegacyLogAnalyticsRule	boolean		Hodnota True, pokud je pravidlo upozornění starším pravidlem analýzy protokolů
properties.lastUpdatedTime	string		Čas poslední aktualizace pravidla ve formátu IS08601.
properties.provisioningState	provisioningState		Stav zřizování pravidla naplánovaného dotazu
properties.schedule	Schedule		Plán (frekvence, časový interval) pro pravidlo. Požadováno pro typ akce – AlertingAction
properties.source	Source		Zdroj dat, podle kterého pravidla se bude dotazovat na data
tags	object		Značky prostředků
type	string		Typ prostředku Azure

LogToMetricAction

Zadejte akci, která se musí provést, když typ pravidla převádí protokol na metriku.

Name	Typ	Description
criteria	Criteria[]	Kritéria metriky
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	Určuje akci. Podporované hodnoty – AlertingAction, LogToMetricAction

metricTriggerType

Typ triggeru metriky – po sobě jdoucí nebo celkem

Name	Typ	Description
Consecutive	string
Total	string

operator

Operátor pro hodnoty dimenzí

Name	Typ	Description
Include	string

provisioningState

Stav zřizování pravidla naplánovaného dotazu

Name	Typ	Description
Canceled	string
Deploying	string
Failed	string
Succeeded	string

QueryType

Nastavte hodnotu na ResultAccount.

Name	Typ	Description
ResultCount	string

Schedule

Definuje, jak často se má vyhledávání spouštět a časový interval.

Name	Typ	Description
frequencyInMinutes	integer	frekvence (v minutách), při které by se měla vyhodnocovat podmínka pravidla.
timeWindowInMinutes	integer	Časový interval, pro který je potřeba načíst data pro dotaz (měl by být větší než nebo roven hodnotě frequencyInMinutes).

Source

Určuje dotaz prohledávání protokolu.

Name	Typ	Description
authorizedResources	string[]	Seznam prostředků odkazovaných na dotaz
dataSourceId	string	Identifikátor URI prostředku, přes který se má dotaz prohledávání protokolu spustit.
query	string	Dotaz prohledávání protokolu. Požadováno pro typ akce – AlertingAction
queryType	QueryType	Nastavte hodnotu na ResultCount.

TriggerCondition

Podmínka, která má za následek pravidlo prohledávání protokolu.

Name	Typ	Default value	Description
metricTrigger	LogMetricTrigger		Aktivační podmínka pro pravidlo dotazu na metriku
threshold	number		Prahová hodnota výsledku nebo počtu na základě toho, které pravidlo se má aktivovat.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operace vyhodnocení pro pravidlo – GreaterThan nebo LessThan.

Sdílet prostřednictvím

Scheduled Query Rules - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Get rule

Ukázkový požadavek

Ukázková odpověď

Definice

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

Další materiály