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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
ruleName	path	True	string	規則的名稱。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	類型	Description
properties.enabled	enabled	旗標，指出是否啟用記錄搜尋規則。值應為 true 或 false
tags	object	資源標籤

回應

名稱	類型	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

範圍

名稱	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

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"
        }
      }
    }
  }
}

定義

名稱	Description
AlertingAction	當規則類型為 Alert 時，必須採取指定動作
AlertSeverity	警示的嚴重性層級
AzNsActionGroup	Azure 動作群組
ConditionalOperator	結果條件評估準則。
Criteria	指定將記錄轉換成計量的準則。
Dimension	指定將記錄轉換成計量的準則。
enabled	旗標，指出是否啟用記錄搜尋規則。值應為 true 或 false
ErrorContract	描述錯誤回應的格式。
ErrorResponse	描述錯誤回應的格式。
LogMetricTrigger	記錄計量觸發描述項。
LogSearchRuleResource	記錄搜尋規則資源。
LogSearchRuleResourcePatch	修補作業的記錄搜尋規則資源。
LogToMetricAction	當規則類型將記錄轉換成計量時，必須採取指定動作
metricTriggerType	計量觸發程序類型 - 'Consecutive' 或 'Total'
operator	維度值的運算符
provisioningState	排程查詢規則的布建狀態
QueryType	將值設定為 'ResultAccount'
Schedule	定義執行搜尋的頻率和時間間隔。
Source	指定記錄搜尋查詢。
TriggerCondition	導致記錄搜尋規則的條件。

AlertingAction

當規則類型為 Alert 時，必須採取指定動作

名稱	類型	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

警示的嚴重性層級

名稱	類型	Description
0	string
1	string
2	string
3	string
4	string

AzNsActionGroup

Azure 動作群組

名稱	類型	Description
actionGroup	string[]	Azure 動作群組參考。
customWebhookPayload	string	要針對 Azure 動作群組中所有 Webhook URI 傳送的自定義承載
emailSubject	string	Azure 動作群組中所有電子郵件標識碼的自定義主旨覆寫

ConditionalOperator

結果條件評估準則。

名稱	類型	Description
Equal	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

Criteria

指定將記錄轉換成計量的準則。

名稱	類型	Description
dimensions	Dimension[]	用於建立計量的維度清單
metricName	string	計量的名稱

Dimension

指定將記錄轉換成計量的準則。

名稱	類型	Description
name	string	維度的名稱
operator	operator	維度值的運算符
values	string[]	維度值清單

enabled

旗標，指出是否啟用記錄搜尋規則。值應為 true 或 false

名稱	類型	Description
false	string
true	string

ErrorContract

描述錯誤回應的格式。

名稱	類型	Description
error	ErrorResponse	錯誤詳細資料。

ErrorResponse

描述錯誤回應的格式。

名稱	類型	Description
code	string	錯誤碼
message	string	錯誤訊息，指出作業失敗的原因。

LogMetricTrigger

記錄計量觸發描述項。

名稱	類型	預設值	Description
metricColumn	string		評估特定數據行的計量
metricTriggerType	metricTriggerType	Consecutive	計量觸發程序類型 - 'Consecutive' 或 'Total'
threshold	number		計量觸發程式的臨界值。
thresholdOperator	ConditionalOperator	GreaterThanOrEqual	計量 -'GreaterThan' 或 'LessThan' 或 'Equal' 的評估作業。

LogSearchRuleResource

記錄搜尋規則資源。

名稱	類型	預設值	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 資源標識碼
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

修補作業的記錄搜尋規則資源。

名稱	類型	Description
properties.enabled	enabled	旗標，指出是否啟用記錄搜尋規則。值應為 true 或 false
tags	object	資源標籤

LogToMetricAction

當規則類型將記錄轉換成計量時，必須採取指定動作

名稱	類型	Description
criteria	Criteria[]	計量準則
odata.type	string: Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction	指定動作。支援的值 - AlertingAction、LogToMetricAction

metricTriggerType

計量觸發程序類型 - 'Consecutive' 或 'Total'

名稱	類型	Description
Consecutive	string
Total	string

operator

維度值的運算符

名稱	類型	Description
Include	string

provisioningState

排程查詢規則的布建狀態

名稱	類型	Description
Canceled	string
Deploying	string
Failed	string
Succeeded	string

QueryType

將值設定為 'ResultAccount'

名稱	類型	Description
ResultCount	string

Schedule

定義執行搜尋的頻率和時間間隔。

名稱	類型	Description
frequencyInMinutes	integer	frequency (以分鐘為單位，) 應評估規則條件。
timeWindowInMinutes	integer	需要擷取查詢 (數據的時間範圍應該大於或等於 frequencyInMinutes) 。

Source

指定記錄搜尋查詢。

名稱	類型	Description
authorizedResources	string[]	查詢中參考的資源清單
dataSourceId	string	要在其中執行記錄搜尋查詢的資源 URI。
query	string	記錄搜尋查詢。動作類型的必要專案 - AlertingAction
queryType	QueryType	將值設定為 'ResultCount' 。

TriggerCondition

導致記錄搜尋規則的條件。

名稱	類型	預設值	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

其他資源