Scheduled Query Rules - Update

Reference

Služba:: Monitor

Verze rozhraní API:: 2018-04-16

Aktualizovat pravidlo prohledávání protokolu.

PATCH 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 minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
ruleName	path	True	string	Název pravidla.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.enabled	enabled	Příznak, který označuje, jestli je povolené pravidlo prohledávání protokolu. Hodnota by měla být true nebo false
tags	object	Značky prostředků

Odpovědi

Name	Typ	Description
200 OK	LogSearchRuleResource	Úspěšná žádost o aktualizaci pravidla prohledávání protokolu
Other Status Codes	ErrorContract	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

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

Patch Log Search Rule

Ukázkový požadavek

PATCH https://management.azure.com/subscriptions/subid/resourcegroups/my-resource-group/providers/Microsoft.Insights/scheduledQueryRules/logalertfoo?api-version=2018-04-16

{
  "properties": {
    "enabled": "true"
  }
}

import com.azure.core.util.Context;
import com.azure.resourcemanager.monitor.models.Enabled;
import com.azure.resourcemanager.monitor.models.LogSearchRuleResourcePatch;

/** Samples for ScheduledQueryRules Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/patchScheduledQueryRules.json
     */
    /**
     * Sample code: Patch Log Search Rule.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void patchLogSearchRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .diagnosticSettings()
            .manager()
            .serviceClient()
            .getScheduledQueryRules()
            .updateWithResponse(
                "my-resource-group",
                "logalertfoo",
                new LogSearchRuleResourcePatch().withEnabled(Enabled.TRUE),
                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 patch_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="subid",
    )

    response = client.scheduled_query_rules.update(
        resource_group_name="my-resource-group",
        rule_name="logalertfoo",
        parameters={"properties": {"enabled": "true"}},
    )
    print(response)


# x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/patchScheduledQueryRules.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/azcore/to"
	"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/patchScheduledQueryRules.json
func ExampleScheduledQueryRulesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armmonitor.NewScheduledQueryRulesClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Update(ctx,
		"my-resource-group",
		"logalertfoo",
		armmonitor.LogSearchRuleResourcePatch{
			Properties: &armmonitor.LogSearchRulePatch{
				Enabled: to.Ptr(armmonitor.EnabledTrue),
			},
		},
		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 Update log search Rule.
 *
 * @summary Update log search Rule.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/patchScheduledQueryRules.json
 */
async function patchLogSearchRule() {
  const subscriptionId = process.env["MONITOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "my-resource-group";
  const ruleName = "logalertfoo";
  const parameters = { enabled: "true" };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.scheduledQueryRules.update(resourceGroupName, ruleName, parameters);
  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",
      "dataSourceId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/components/sampleAI",
      "queryType": "ResultCount"
    },
    "schedule": {
      "frequencyInMinutes": 15,
      "timeWindowInMinutes": 15
    },
    "action": {
      "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
      "severity": "1",
      "aznsAction": {
        "actionGroup": [],
        "emailSubject": "Email Header",
        "customWebhookPayload": "{}"
      },
      "trigger": {
        "thresholdOperator": "GreaterThan",
        "threshold": 3,
        "metricTrigger": {
          "thresholdOperator": "GreaterThan",
          "threshold": 5,
          "metricTriggerType": "Consecutive",
          "metricColumn": "ColumnName"
        }
      }
    }
  }
}

Definice

Name	Description
AlertingAction	Zadejte akci, která se musí 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 povolené pravidlo prohledávání protokolu. Hodnota by měla být true nebo false
ErrorContract	Popisuje formát odpovědi na chybu.
ErrorResponse	Popisuje formát odpovědi na chybu.
LogMetricTrigger	Popisovač triggeru metrik protokolu.
LogSearchRuleResource	Prostředek pravidla prohledávání protokolu.
LogSearchRuleResourcePatch	Prostředek pravidla prohledávání protokolu pro operace oprav.
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	Nastavení hodnoty na ResultAccount
Schedule	Definuje, jak často se má vyhledávání spouštět, a časový interval.
Source	Určuje vyhledávací dotaz protokolu.
TriggerCondition	Podmínka, která vede k pravidlu prohledávání protokolu.

AlertingAction

Objekt

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

Name	Typ	Description
aznsAction	AzNsActionGroup	Referenční informace ke skupině 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 (int32)	čas (v minutách), pro které mají být upozornění omezena nebo potlačena.
trigger	TriggerCondition	Podmínka triggeru, která má za následek, že pravidlo upozornění je.

AlertSeverity

Výčet

Úroveň závažnosti výstrahy

Hodnota	Description
0
1
2
3
4

AzNsActionGroup

Objekt

Skupina akcí Azure

Name	Typ	Description
actionGroup	string[]	Referenční informace ke skupině 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

Výčet

Kritéria vyhodnocení podmínky výsledku

Hodnota	Description
Equal
GreaterThan
GreaterThanOrEqual
LessThan
LessThanOrEqual

Criteria

Objekt

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

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

Dimension

Objekt

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

Výčet

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

Hodnota	Description
false
true

ErrorContract

Objekt

Popisuje formát odpovědi na chybu.

Name	Typ	Description
error	ErrorResponse	Podrobnosti o chybě.

ErrorResponse

Objekt

Popisuje formát odpovědi na chybu.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

LogMetricTrigger

Objekt

Popisovač triggeru metrik protokolu.

Name	Typ	Default value	Description
metricColumn	string		Vyhodnocení metriky u konkrétního sloupce
metricTriggerType	metricTriggerType	Consecutive	Typ triggeru metriky – "Po sobě jdoucí" nebo "Celkem"
threshold	number (double)		Prahová hodnota triggeru metriky.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operace vyhodnocení pro metriku -"GreaterThan" nebo "LessThan" nebo "Equal".

LogSearchRuleResource

Objekt

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

Name	Typ	Default value	Description
etag	string		Pole etag je není povinné. Pokud je uvedený v textu odpovědi, musí být také uveden jako hlavička podle normální konvence značky 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 etagu (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. V případě podpory musí poskytovatel prostředků 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		Je potřeba provést akci při provádění pravidla.
properties.autoMitigate	boolean	False	Příznak, který označuje, jestli se má výstraha automaticky vyřešit, nebo ne. Výchozí hodnota je false.
properties.createdWithApiVersion	string		Verze 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 povolené pravidlo prohledávání protokolu. Hodnota by měla být true nebo false
properties.isLegacyLogAnalyticsRule	boolean		True if alert rule is legacy Log Analytic rule
properties.lastUpdatedTime	string (date-time)		Č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é období) pro pravidlo Požadováno pro typ akce – AlertingAction
properties.source	Source		Zdroj dat, proti kterému pravidlo bude dotazovat data
tags	object		Značky prostředků
type	string		Typ prostředku Azure

LogSearchRuleResourcePatch

Objekt

Prostředek pravidla prohledávání protokolu pro operace oprav.

Name	Typ	Description
properties.enabled	enabled	Příznak, který označuje, jestli je povolené pravidlo prohledávání protokolu. Hodnota by měla být true nebo false
tags	object	Značky prostředků

LogToMetricAction

Objekt

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

Výčet

Typ triggeru metriky – "Po sobě jdoucí" nebo "Celkem"

Hodnota	Description
Consecutive
Total

operator

Výčet

Operátor pro hodnoty dimenzí

Hodnota	Description
Include

provisioningState

Výčet

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

Hodnota	Description
Canceled
Deploying
Failed
Succeeded

QueryType

Výčet

Nastavení hodnoty na ResultAccount

Hodnota	Description
ResultCount

Schedule

Objekt

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

Name	Typ	Description
frequencyInMinutes	integer (int32)	frekvence (v minutách), při které je třeba vyhodnotit podmínku pravidla.
timeWindowInMinutes	integer (int32)	Časové intervaly, pro které je potřeba načíst data pro dotaz (musí být větší nebo roven frekvenciInMinutes).

Source

Objekt

Určuje vyhledávací dotaz 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á spustit vyhledávací dotaz protokolu.
query	string	Dotaz prohledávání protokolu Požadováno pro typ akce – AlertingAction
queryType	QueryType	Nastavte hodnotu na ResultCount .

TriggerCondition

Objekt

Podmínka, která vede k pravidlu prohledávání protokolu.

Name	Typ	Default value	Description
metricTrigger	LogMetricTrigger		Podmínka triggeru pro pravidlo dotazu na metriku
threshold	number (double)		Výsledek nebo prahová hodnota počtu na základě toho, které pravidlo se má aktivovat.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	Operace vyhodnocení pravidla - GreaterThan nebo LessThan.

Sdílet prostřednictvím

Scheduled Query Rules - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Patch Log Search Rule

Ukázkový požadavek

Ukázková odpověď

Definice

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogSearchRuleResourcePatch

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

Další materiály