Scheduled Query Rules - Update

참조

서비스:: Monitor

API 버전:: 2018-04-16

로그 검색 규칙을 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
ruleName	path	True	string	규칙의 이름입니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.enabled	enabled	로그 검색 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다. 값은 true 또는 false여야 합니다.
tags	object	리소스 태그

응답

Name	형식	Description
200 OK	LogSearchRuleResource	로그 검색 규칙 업데이트 요청 성공
Other Status Codes	ErrorContract	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Patch Log Search Rule

샘플 요청

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

샘플 응답

상태 코드:: 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"
        }
      }
    }
  }
}

정의

Name	Description
AlertingAction	규칙 유형이 경고일 때 수행해야 하는 작업 지정
AlertSeverity	심각도 경고 수준
AzNsActionGroup	Azure 작업 그룹
ConditionalOperator	결과 조건 평가 조건입니다.
Criteria	로그를 메트릭으로 변환하기 위한 조건을 지정합니다.
Dimension	로그를 메트릭으로 변환하기 위한 조건을 지정합니다.
enabled	로그 검색 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다. 값은 true 또는 false여야 합니다.
ErrorContract	오류 응답의 형식을 설명합니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
LogMetricTrigger	로그 메트릭 트리거 설명자입니다.
LogSearchRuleResource	로그 검색 규칙 리소스입니다.
LogSearchRuleResourcePatch	패치 작업에 대한 로그 검색 규칙 리소스입니다.
LogToMetricAction	규칙 유형이 로그를 메트릭으로 변환할 때 수행해야 하는 작업 지정
metricTriggerType	메트릭 트리거 유형 - '연속' 또는 '합계'
operator	차원 값에 대한 연산자
provisioningState	예약된 쿼리 규칙의 프로비전 상태
QueryType	값을 'ResultAccount'로 설정
Schedule	검색 및 시간 간격을 실행하는 빈도를 정의합니다.
Source	로그 검색 쿼리를 지정합니다.
TriggerCondition	로그 검색 규칙을 생성하는 조건입니다.

AlertingAction

규칙 유형이 경고일 때 수행해야 하는 작업 지정

Name	형식	Description
aznsAction	AzNsActionGroup	Azure 작업 그룹 참조.
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction	작업을 지정합니다. 지원되는 값 - AlertingAction, LogToMetricAction
severity	AlertSeverity	경고의 심각도
throttlingInMin	integer	경고를 제한하거나 억제해야 하는 시간(분)입니다.
trigger	TriggerCondition	경고 규칙이 발생하는 트리거 조건입니다.

AlertSeverity

심각도 경고 수준

Name	형식	Description
0	string
1	string
2	string
3	string
4	string

AzNsActionGroup

Azure 작업 그룹

Name	형식	Description
actionGroup	string[]	Azure 작업 그룹 참조.
customWebhookPayload	string	Azure 작업 그룹의 모든 웹후크 URI에 대해 보낼 사용자 지정 페이로드
emailSubject	string	Azure 작업 그룹의 모든 전자 메일 ID에 대한 사용자 지정 제목 재정의

ConditionalOperator

결과 조건 평가 조건입니다.

Name	형식	Description
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

Criteria

로그를 메트릭으로 변환하기 위한 조건을 지정합니다.

Name	형식	Description
dimensions	Dimension[]	메트릭을 만들기 위한 차원 목록
metricName	string	메트릭의 이름

Dimension

로그를 메트릭으로 변환하기 위한 조건을 지정합니다.

Name	형식	Description
name	string	차원의 이름
operator	operator	차원 값에 대한 연산자
values	string[]	차원 값 목록

enabled

로그 검색 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다. 값은 true 또는 false여야 합니다.

Name	형식	Description
false	string
true	string

ErrorContract

오류 응답의 형식을 설명합니다.

Name	형식	Description
error	ErrorResponse	오류 세부 정보입니다.

ErrorResponse

오류 응답의 형식을 설명합니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

LogMetricTrigger

로그 메트릭 트리거 설명자입니다.

Name	형식	Default value	Description
metricColumn	string		특정 열에 대한 메트릭 평가
metricTriggerType	metricTriggerType	Consecutive	메트릭 트리거 유형 - '연속' 또는 '합계'
threshold	number		메트릭 트리거의 임계값입니다.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	메트릭 -'GreaterThan' 또는 'LessThan' 또는 'Equal'에 대한 평가 작업입니다.

LogSearchRuleResource

로그 검색 규칙 리소스입니다.

Name	형식	Default value	Description
etag	string		etag 필드는 필요하지 않습니다 . 응답 본문에 제공되는 경우 일반적인 etag 규칙에 따라 헤더로도 제공해야 합니다. 엔터티 태그는 동일한 요청된 리소스에서 둘 이상의 엔터티를 비교하는 데 사용됩니다. HTTP/1.1은 etag(섹션 14.19), If-Match(섹션 14.24), If-None-Match(섹션 14.26) 및 If-Range(섹션 14.27) 헤더 필드에 엔터티 태그를 사용합니다.
id	string		Azure 리소스 ID
kind	string		포털/도구/등에서 동일한 형식의 리소스에 대해 다른 UX 환경을 렌더링하는 데 사용하는 메타데이터 예를 들어 ApiApps는 일종의 Microsoft.Web/sites 유형입니다. 지원되는 경우 리소스 공급자는 이 값의 유효성을 검사하고 유지해야 합니다.
location	string		리소스 위치
name	string		Azure 리소스 이름
properties.action	Action: AlertingAction LogToMetricAction		규칙 실행에 대한 작업을 수행해야 합니다.
properties.autoMitigate	boolean	False	경고를 자동으로 해결해야 하는지 여부를 나타내는 플래그입니다. 기본값은 false입니다.
properties.createdWithApiVersion	string		이 경고 규칙을 만들 때 사용되는 api 버전
properties.description	string		로그 검색 규칙에 대한 설명입니다.
properties.displayName	string		경고 규칙의 표시 이름
properties.enabled	enabled		로그 검색 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다. 값은 true 또는 false여야 합니다.
properties.isLegacyLogAnalyticsRule	boolean		True이면 경고 규칙이 레거시 Log Analytic 규칙입니다.
properties.lastUpdatedTime	string		마지막으로 규칙이 IS08601 형식으로 업데이트되었습니다.
properties.provisioningState	provisioningState		예약된 쿼리 규칙의 프로비전 상태
properties.schedule	Schedule		규칙에 대한 일정(빈도, 기간)입니다. 작업 유형에 필요 - AlertingAction
properties.source	Source		데이터를 쿼리할 규칙에 대한 데이터 원본
tags	object		리소스 태그
type	string		Azure 리소스 종류

LogSearchRuleResourcePatch

패치 작업에 대한 로그 검색 규칙 리소스입니다.

Name	형식	Description
properties.enabled	enabled	로그 검색 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다. 값은 true 또는 false여야 합니다.
tags	object	리소스 태그

LogToMetricAction

규칙 유형이 로그를 메트릭으로 변환할 때 수행해야 하는 작업 지정

Name	형식	Description
criteria	Criteria[]	메트릭의 조건
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	작업을 지정합니다. 지원되는 값 - AlertingAction, LogToMetricAction

metricTriggerType

메트릭 트리거 유형 - '연속' 또는 '합계'

Name	형식	Description
Consecutive	string
Total	string

operator

차원 값에 대한 연산자

Name	형식	Description
Include	string

provisioningState

예약된 쿼리 규칙의 프로비전 상태

Name	형식	Description
Canceled	string
Deploying	string
Failed	string
Succeeded	string

QueryType

값을 'ResultAccount'로 설정

Name	형식	Description
ResultCount	string

Schedule

검색 및 시간 간격을 실행하는 빈도를 정의합니다.

Name	형식	Description
frequencyInMinutes	integer	규칙 조건을 평가해야 하는 빈도(분)입니다.
timeWindowInMinutes	integer	쿼리를 위해 데이터를 가져와야 하는 기간(frequencyInMinutes보다 크거나 같아야 합니다).

Source

로그 검색 쿼리를 지정합니다.

Name	형식	Description
authorizedResources	string[]	쿼리에 참조된 리소스 목록
dataSourceId	string	로그 검색 쿼리를 실행할 리소스 URI입니다.
query	string	로그 검색 쿼리. 작업 유형에 필요 - AlertingAction
queryType	QueryType	값을 'ResultCount'로 설정합니다.

TriggerCondition

로그 검색 규칙을 생성하는 조건입니다.

Name	형식	Default value	Description
metricTrigger	LogMetricTrigger		메트릭 쿼리 규칙에 대한 트리거 조건
threshold	number		트리거해야 하는 규칙에 따라 결과 또는 개수 임계값입니다.
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	규칙에 대한 평가 작업 - 'GreaterThan' 또는 'LessThan.

다음을 통해 공유

Scheduled Query Rules - Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Patch Log Search Rule

샘플 요청

샘플 응답

정의

AlertingAction

AlertSeverity

AzNsActionGroup

ConditionalOperator

Criteria

Dimension

enabled

ErrorContract

ErrorResponse

LogMetricTrigger

LogSearchRuleResource

LogSearchRuleResourcePatch

LogToMetricAction

metricTriggerType

operator

provisioningState

QueryType

Schedule

Source

TriggerCondition

추가 리소스