Scheduled Query Rules - Get

Referenz

Dienst:: Monitor

API-Version:: 2018-04-16

Ruft eine Protokollsuchregel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
ruleName	path	True	string	Der Name der Regel.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	LogSearchRuleResource	Erfolgreiche Anforderung zum Abrufen einer Protokollsuchregel
Other Status Codes	ErrorContract	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get rule

Beispielanforderung

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.monitor import MonitorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-monitor
# USAGE
    python get_scheduled_query_rules.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MonitorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="b67f7fec-69fc-4974-9099-a26bd6ffeda3",
    )

    response = client.scheduled_query_rules.get(
        resource_group_name="Rac46PostSwapRG",
        rule_name="logalertfoo",
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json
if __name__ == "__main__":
    main()

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

Beispiel für eine Antwort

Statuscode:: 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": "{}"
      }
    }
  }
}

Definitionen

Name	Beschreibung
AlertingAction	Angeben der Aktion, die ausgeführt werden muss, wenn der Regeltyp "Warnung" ist
AlertSeverity	Schweregrad der Warnung
AzNsActionGroup	Azure-Aktionsgruppe
ConditionalOperator	Kriterien für die Ergebnisbedingungsauswertung.
Criteria	Gibt die Kriterien für die Konvertierung des Protokolls in die Metrik an.
Dimension	Gibt die Kriterien für die Konvertierung des Protokolls in die Metrik an.
enabled	Das Kennzeichen, das angibt, ob die Protokollsuche-Regel aktiviert ist. Der Wert sollte wahr oder falsch sein.
ErrorContract	Beschreibt das Format der Fehlerantwort.
ErrorResponse	Beschreibt das Format der Fehlerantwort.
LogMetricTrigger	Eine Protokollmetrikentriggerdeskriptor.
LogSearchRuleResource	Die Ressource für die Protokollsuchregel.
LogToMetricAction	Angeben der Aktion, die ausgeführt werden muss, wenn der Regeltyp das Protokoll in eine Metrik konvertiert
metricTriggerType	Metrischer Triggertyp - "Aufeinanderfolgende" oder "Summe"
operator	Operator für Dimensionswerte
provisioningState	Bereitstellungsstatus der geplanten Abfrageregel
QueryType	Wert auf 'ResultAccount' festlegen
Schedule	Definiert, wie oft die Suche und das Zeitintervall ausgeführt werden.
Source	Gibt die Protokollsuchabfrage an.
TriggerCondition	Die Bedingung, die zu der Protokollsuche-Regel führt.

AlertingAction

Objekt

Angeben der Aktion, die ausgeführt werden muss, wenn der Regeltyp "Warnung" ist

Name	Typ	Beschreibung
aznsAction	AzNsActionGroup	Azure-Aktionsgruppenreferenz.
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	Gibt die Aktion an. Unterstützte Werte – AlertingAction, LogToMetricAction
severity	AlertSeverity	Schweregrad der Warnung
throttlingInMin	integer (int32)	Zeit (in Minuten), für die Warnungen gedrosselt oder unterdrückt werden sollen.
trigger	TriggerCondition	Die Triggerbedingung, die dazu führt, dass die Warnungsregel angezeigt wird.

AlertSeverity

Enumeration

Schweregrad der Warnung

Wert	Beschreibung
0
1
2
3
4

AzNsActionGroup

Objekt

Azure-Aktionsgruppe

Name	Typ	Beschreibung
actionGroup	string[]	Azure Action Group-Referenz.
customWebhookPayload	string	Benutzerdefinierte Nutzlast, die für alle Webhook-URI in der Azure-Aktionsgruppe gesendet werden soll
emailSubject	string	Außerkraftsetzung eines benutzerdefinierten Betreffs für alle E-Mail-IDs in der Azure-Aktionsgruppe

ConditionalOperator

Enumeration

Kriterien für die Ergebnisbedingungsauswertung.

Wert	Beschreibung
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

Criteria

Objekt

Gibt die Kriterien für die Konvertierung des Protokolls in die Metrik an.

Name	Typ	Beschreibung
dimensions	Dimension[]	Liste der Dimensionen zum Erstellen einer Metrik
metricName	string	Name der Metrik

Dimension

Objekt

Gibt die Kriterien für die Konvertierung des Protokolls in die Metrik an.

Name	Typ	Beschreibung
name	string	Name der Dimension
operator	operator	Operator für Dimensionswerte
values	string[]	Liste der Dimensionswerte

enabled

Enumeration

Das Kennzeichen, das angibt, ob die Protokollsuche-Regel aktiviert ist. Der Wert sollte wahr oder falsch sein.

Wert	Beschreibung
false
true

ErrorContract

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorResponse	Die Fehlerdetails.

ErrorResponse

Objekt

Beschreibt das Format der Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

LogMetricTrigger

Objekt

Eine Protokollmetrikentriggerdeskriptor.

Name	Typ	Standardwert	Beschreibung
metricColumn	string		Auswertung der Metrik für eine bestimmte Spalte
metricTriggerType	metricTriggerType	Consecutive	Metrischer Triggertyp - "Aufeinanderfolgende" oder "Summe"
threshold	number (double)		Der Schwellenwert des metrischen Triggers.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Auswertungsvorgang für Metrisch -'GreaterThan' oder 'LessThan' oder 'Equal'.

LogSearchRuleResource

Objekt

Die Ressource für die Protokollsuchregel.

Name	Typ	Standardwert	Beschreibung
etag	string		Das Etag-Feld ist nicht erforderlich. Wenn sie im Antworttext angegeben wird, muss sie auch als Kopfzeile gemäß der normalen etag-Konvention bereitgestellt werden. Entitätstags werden zum Vergleichen von zwei oder mehr Entitäten aus derselben angeforderten Ressource verwendet. HTTP/1.1 verwendet Entitätstags im etag (Abschnitt 14.19), If-Match (Abschnitt 14.24), If-None-Match (Abschnitt 14.26) und If-Range (Abschnitt 14.27)-Kopfzeilenfelder.
id	string		Azure-Ressourcen-ID
kind	string		Metadaten, die von Portal/Tooling/etc. verwendet werden, um unterschiedliche UX-Oberflächen für Ressourcen desselben Typs zu rendern; z. B. ApiApps sind eine Art von Microsoft.Web/Sites-Typ. Wenn diese Unterstützung unterstützt wird, muss der Ressourcenanbieter diesen Wert überprüfen und beibehalten.
location	string		Ressourcenspeicherort
name	string		Name der Azure-Ressource
properties.action	Action: AlertingAction LogToMetricAction		Die Aktion muss bei der Regelausführung ausgeführt werden.
properties.autoMitigate	boolean	False	Das Kennzeichen, das angibt, ob die Warnung automatisch aufgelöst werden soll oder nicht. Der Standardwert ist "false".
properties.createdWithApiVersion	string		Die api-Version, die beim Erstellen dieser Warnungsregel verwendet wird
properties.description	string		Die Beschreibung der Protokollsuchregel.
properties.displayName	string		Der Anzeigename der Warnungsregel
properties.enabled	enabled		Das Kennzeichen, das angibt, ob die Protokollsuche-Regel aktiviert ist. Der Wert sollte wahr oder falsch sein.
properties.isLegacyLogAnalyticsRule	boolean		True, wenn warnungsregel legacy Log Analytic rule ist
properties.lastUpdatedTime	string (date-time)		Zeitpunkt der letzten Aktualisierung der Regel im IS08601 Format.
properties.provisioningState	provisioningState		Bereitstellungsstatus der geplanten Abfrageregel
properties.schedule	Schedule		Zeitplan (Häufigkeit, Zeitfenster) für regel. Erforderlich für den Aktionstyp – AlertingAction
properties.source	Source		Datenquelle, anhand derer die Regel Daten abfragt
tags	object		Ressourcentags
type	string		Azure-Ressourcentyp

LogToMetricAction

Objekt

Angeben der Aktion, die ausgeführt werden muss, wenn der Regeltyp das Protokoll in eine Metrik konvertiert

Name	Typ	Beschreibung
criteria	Criteria[]	Kriterien der Metrik
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	Gibt die Aktion an. Unterstützte Werte – AlertingAction, LogToMetricAction

metricTriggerType

Enumeration

Metrischer Triggertyp - "Aufeinanderfolgende" oder "Summe"

Wert	Beschreibung
Consecutive
Total

operator

Enumeration

Operator für Dimensionswerte

Wert	Beschreibung
Include

provisioningState

Enumeration

Bereitstellungsstatus der geplanten Abfrageregel

Wert	Beschreibung
Canceled
Deploying
Failed
Succeeded

QueryType

Enumeration

Wert auf 'ResultAccount' festlegen

Wert	Beschreibung
ResultCount

Schedule

Objekt

Definiert, wie oft die Suche und das Zeitintervall ausgeführt werden.

Name	Typ	Beschreibung
frequencyInMinutes	integer (int32)	Häufigkeit (in Minuten), mit der die Regelbedingung ausgewertet werden soll.
timeWindowInMinutes	integer (int32)	Zeitfenster, für das Daten für die Abfrage abgerufen werden müssen (sollte größer oder gleich frequencyInMinutes sein).

Source

Objekt

Gibt die Protokollsuchabfrage an.

Name	Typ	Beschreibung
authorizedResources	string[]	Liste der ressourcenverwiesenen Abfrage
dataSourceId	string	Der Ressourcen-URI, über den die Protokollsuchabfrage ausgeführt werden soll.
query	string	Protokollsuchabfrage. Erforderlich für den Aktionstyp – AlertingAction
queryType	QueryType	Legen Sie den Wert auf 'ResultCount' fest.

TriggerCondition

Objekt

Die Bedingung, die zu der Protokollsuche-Regel führt.

Name	Typ	Standardwert	Beschreibung
metricTrigger	LogMetricTrigger		Triggerbedingung für Metrikabfrageregel
threshold	number (double)		Ergebnis- oder Zählungsschwellenwert basierend darauf, welche Regel ausgelöst werden soll.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Auswertungsvorgang für Regel - "GreaterThan" oder "LessThan".

Freigeben über

Scheduled Query Rules - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get rule

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

Zusätzliche Ressourcen