Metric Alerts - Update

참조

서비스:: Monitor

API 버전:: 2018-03-01

메트릭 경고 정의를 업데이트합니다.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01

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.actions	MetricAlertAction[]	경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업의 배열입니다.
properties.autoMitigate	boolean	경고를 자동으로 해결해야 하는지 여부를 나타내는 플래그입니다. 기본값은 true입니다.
properties.criteria	MetricAlertCriteria: MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria MetricAlertMultipleResourceMultipleMetricCriteria	는 특정 경고 조건 정보를 정의합니다.
properties.description	string	경고 이메일에 포함될 메트릭 경고에 대한 설명입니다.
properties.enabled	boolean	메트릭 경고가 사용되는지 여부를 나타내는 플래그입니다.
properties.evaluationFrequency	string	메트릭 경고가 ISO 8601 기간 형식으로 표시되는 빈도입니다.
properties.scopes	string[]	이 메트릭 경고의 범위가 지정된 리소스 ID 목록입니다.
properties.severity	integer	경고 심각도 {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	경고가 생성/업데이트되는 대상 리소스의 지역입니다. MultipleResourceMultipleMetricCriteria에 대한 필수입니다.
properties.targetResourceType	string	경고가 생성/업데이트되는 대상 리소스의 리소스 종류입니다. MultipleResourceMultipleMetricCriteria에 대한 필수입니다.
properties.windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다.
tags	object	리소스 태그

응답

Name	형식	Description
200 OK	MetricAlertResource	그래
Other Status Codes	ErrorResponse	BadRequest

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Create or update an alert rule

샘플 요청

PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01

{
  "tags": {},
  "properties": {
    "description": "This is the description of the rule1",
    "severity": 3,
    "enabled": true,
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}


import com.azure.resourcemanager.monitor.models.AggregationTypeEnum;
import com.azure.resourcemanager.monitor.models.MetricAlertAction;
import com.azure.resourcemanager.monitor.models.MetricAlertResourcePatch;
import com.azure.resourcemanager.monitor.models.MetricAlertSingleResourceMultipleMetricCriteria;
import com.azure.resourcemanager.monitor.models.MetricCriteria;
import com.azure.resourcemanager.monitor.models.Operator;
import java.time.Duration;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for MetricAlerts Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
     */
    /**
     * Sample code: Create or update an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts()
            .updateWithResponse("gigtest", "chiricutin", new MetricAlertResourcePatch().withTags(mapOf())
                .withDescription("This is the description of the rule1").withSeverity(3).withEnabled(true)
                .withScopes(Arrays.asList(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"))
                .withEvaluationFrequency(Duration.parse("Pt1m")).withWindowSize(Duration.parse("Pt15m"))
                .withCriteria(new MetricAlertSingleResourceMultipleMetricCriteria().withAllOf(Arrays.asList(
                    new MetricCriteria().withName("High_CPU_80").withMetricName("\\Processor(_Total)\\% Processor Time")
                        .withTimeAggregation(AggregationTypeEnum.AVERAGE).withDimensions(Arrays.asList())
                        .withOperator(Operator.GREATER_THAN).withThreshold(80.5))))
                .withAutoMitigate(true)
                .withActions(Arrays.asList(new MetricAlertAction().withActionGroupId(
                    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2")
                    .withWebhookProperties(mapOf("key11", "fakeTokenPlaceholder", "key12", "fakeTokenPlaceholder")))),
                com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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/blob/969fd0c2634fbcc1975d7abe3749330a5145a97c/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
func ExampleMetricAlertsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmonitor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewMetricAlertsClient().Update(ctx, "gigtest", "chiricutin", armmonitor.MetricAlertResourcePatch{
		Properties: &armmonitor.MetricAlertPropertiesPatch{
			Description: to.Ptr("This is the description of the rule1"),
			Actions: []*armmonitor.MetricAlertAction{
				{
					ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
					WebHookProperties: map[string]*string{
						"key11": to.Ptr("value11"),
						"key12": to.Ptr("value12"),
					},
				}},
			AutoMitigate: to.Ptr(true),
			Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
				ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
				AllOf: []*armmonitor.MetricCriteria{
					{
						Name:            to.Ptr("High_CPU_80"),
						CriterionType:   to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
						Dimensions:      []*armmonitor.MetricDimension{},
						MetricName:      to.Ptr("\\Processor(_Total)\\% Processor Time"),
						TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
						Operator:        to.Ptr(armmonitor.OperatorGreaterThan),
						Threshold:       to.Ptr[float64](80.5),
					}},
			},
			Enabled:             to.Ptr(true),
			EvaluationFrequency: to.Ptr("Pt1m"),
			Scopes: []*string{
				to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
			Severity:   to.Ptr[int32](3),
			WindowSize: to.Ptr("Pt15m"),
		},
		Tags: map[string]*string{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.MetricAlertResource = armmonitor.MetricAlertResource{
	// 	Type: to.Ptr("Microsoft.Insights/metricAlerts"),
	// 	ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin"),
	// 	Location: to.Ptr("global"),
	// 	Tags: map[string]*string{
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.MetricAlertProperties{
	// 		Description: to.Ptr("This is the description of the rule1"),
	// 		Actions: []*armmonitor.MetricAlertAction{
	// 			{
	// 				ActionGroupID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
	// 				WebHookProperties: map[string]*string{
	// 					"key11": to.Ptr("value11"),
	// 					"key12": to.Ptr("value12"),
	// 				},
	// 		}},
	// 		AutoMitigate: to.Ptr(true),
	// 		Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
	// 			ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
	// 			AllOf: []*armmonitor.MetricCriteria{
	// 				{
	// 					Name: to.Ptr("High_CPU_80"),
	// 					CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
	// 					Dimensions: []*armmonitor.MetricDimension{
	// 					},
	// 					MetricName: to.Ptr("\\Processor(_Total)\\% Processor Time"),
	// 					TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
	// 					Operator: to.Ptr(armmonitor.OperatorGreaterThan),
	// 					Threshold: to.Ptr[float64](80.5),
	// 			}},
	// 		},
	// 		Enabled: to.Ptr(true),
	// 		EvaluationFrequency: to.Ptr("Pt1m"),
	// 		Scopes: []*string{
	// 			to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme")},
	// 			Severity: to.Ptr[int32](3),
	// 			WindowSize: to.Ptr("Pt15m"),
	// 		},
	// 	}
}

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 an metric alert definition.
 *
 * @summary Update an metric alert definition.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
 */
async function createOrUpdateAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "gigtest";
  const ruleName = "chiricutin";
  const parameters = {
    description: "This is the description of the rule1",
    actions: [
      {
        actionGroupId:
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        webHookProperties: { key11: "value11", key12: "value12" },
      },
    ],
    autoMitigate: true,
    criteria: {
      allOf: [
        {
          name: "High_CPU_80",
          criterionType: "StaticThresholdCriterion",
          dimensions: [],
          metricName: "\\Processor(_Total)\\% Processor Time",
          operator: "GreaterThan",
          threshold: 80.5,
          timeAggregation: "Average",
        },
      ],
      odataType: "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
    },
    enabled: true,
    evaluationFrequency: "Pt1m",
    scopes: [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme",
    ],
    severity: 3,
    tags: {},
    windowSize: "Pt15m",
  };
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.metricAlerts.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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Monitor.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Monitor;

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json
// this example is just showing the usage of "MetricAlerts_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MetricAlertResource created on azure
// for more information of creating MetricAlertResource, please refer to the document of MetricAlertResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
string resourceGroupName = "gigtest";
string ruleName = "chiricutin";
ResourceIdentifier metricAlertResourceId = MetricAlertResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
MetricAlertResource metricAlert = client.GetMetricAlertResource(metricAlertResourceId);

// invoke the operation
MetricAlertPatch patch = new MetricAlertPatch()
{
    Tags =
    {
    },
    Description = "This is the description of the rule1",
    Severity = 3,
    IsEnabled = true,
    Scopes =
    {
    "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    },
    EvaluationFrequency = XmlConvert.ToTimeSpan("Pt1m"),
    WindowSize = XmlConvert.ToTimeSpan("Pt15m"),
    Criteria = new MetricAlertSingleResourceMultipleMetricCriteria()
    {
        AllOf =
        {
        new MetricCriteria("High_CPU_80","\\Processor(_Total)\\% Processor Time",MetricCriteriaTimeAggregationType.Average,MetricCriteriaOperator.GreaterThan,80.5)
        {
        Dimensions =
        {
        },
        }
        },
    },
    IsAutoMitigateEnabled = true,
    Actions =
    {
    new MetricAlertAction()
    {
    ActionGroupId = new ResourceIdentifier("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2"),
    WebHookProperties =
    {
    ["key11"] = "value11",
    ["key12"] = "value12",
    },
    }
    },
};
MetricAlertResource result = await metricAlert.UpdateAsync(patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MetricAlertData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
  "type": "Microsoft.Insights/metricAlerts",
  "location": "global",
  "tags": {
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "description": "This is the description of the rule1",
    "severity": 3,
    "enabled": true,
    "scopes": [
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "\\Processor(_Total)\\% Processor Time",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": true,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

정의

Name	Description
AdditionalInfo	'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다.
AggregationTypeEnum	조건 시간 집계 형식입니다.
DynamicMetricCriteria	동적 임계값에 대한 기준입니다.
DynamicThresholdFailingPeriods	경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다.
DynamicThresholdOperator	메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다.
DynamicThresholdSensitivity	경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다.
Error
ErrorDetail	오류 응답의 세부 정보를 설명합니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
MetricAlertAction	경고 작업입니다.
MetricAlertMultipleResourceMultipleMetricCriteria	여러 메트릭 조건이 있는 여러 리소스에 대한 메트릭 경고 조건을 지정합니다.
MetricAlertResource	메트릭 경고 리소스입니다.
MetricAlertResourcePatch	패치 작업에 대한 메트릭 경고 리소스입니다.
MetricAlertSingleResourceMultipleMetricCriteria	여러 메트릭 조건이 있는 단일 리소스에 대한 메트릭 경고 조건을 지정합니다.
MetricCriteria	메트릭을 필터링하는 기준입니다.
MetricDimension	메트릭 차원을 지정합니다.
Operator	조건 연산자입니다.
WebtestLocationAvailabilityCriteria	웹 테스트 리소스에 대한 메트릭 경고 규칙 조건을 지정합니다.

AdditionalInfo

'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다.

Name	형식	Description
info	object	형식과 관련된 추가 정보입니다.
type	string	추가 정보의 유형입니다.

AggregationTypeEnum

조건 시간 집계 형식입니다.

Name	형식	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

동적 임계값에 대한 기준입니다.

Name	형식	Description
alertSensitivity	DynamicThresholdSensitivity	경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다.
criterionType	string: DynamicThresholdCriterion	임계값 조건의 유형을 지정합니다.
dimensions	MetricDimension[]	차원 조건 목록입니다.
failingPeriods	DynamicThresholdFailingPeriods	경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다.
ignoreDataBefore	string	이 옵션을 사용하여 메트릭 기록 데이터 학습을 시작하고 동적 임계값(ISO8601 형식)을 계산할 날짜를 설정합니다.
metricName	string	메트릭의 이름입니다.
metricNamespace	string	메트릭의 네임스페이스입니다.
name	string	조건의 이름입니다.
operator	DynamicThresholdOperator	메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다.
skipMetricValidation	boolean	메트릭 유효성 검사를 건너뛰게 하여 아직 내보내지 않은 사용자 지정 메트릭에 대한 경고 규칙을 만들 수 있습니다.
timeAggregation	AggregationTypeEnum	조건 시간 집계 형식입니다.

DynamicThresholdFailingPeriods

경고를 발생 하는 데 필요한 선택한 조회 시간 범위 내에서 필요한 위반의 최소 수입니다.

Name	형식	Description
minFailingPeriodsToAlert	number	경고를 트리거하는 위반 횟수입니다. numberOfEvaluationPeriods와 작거나 같아야 합니다.
numberOfEvaluationPeriods	number	집계된 조회 지점의 수입니다. 조회 기간은 집계 세분성(windowSize) 및 선택한 집계 지점 수를 기준으로 계산됩니다.

DynamicThresholdOperator

메트릭 값을 임계값과 비교하는 데 사용되는 연산자입니다.

Name	형식	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

경고를 트리거하는 데 필요한 편차 범위입니다. 이는 임계값이 메트릭 계열 패턴에 얼마나 촉박한지에 영향을 줍니다.

Name	형식	Description
High	string
Low	string
Medium	string

Error

Name	형식	Description
additionalInfo	AdditionalInfo[]	'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다.
code	string	오류를 프로그래밍 방식으로 식별하는 데 사용할 수 있는 지역화되지 않은 문자열입니다.
details	ErrorDetail[]	이 계약에 설명된 대로 중첩된 추가 오류 응답 정보 개체의 배열입니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공합니다. 요청에 Accept-Language 설정된 경우 해당 언어로 지역화되어야 합니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

ErrorDetail

오류 응답의 세부 정보를 설명합니다.

Name	형식	Description
additionalInfo	AdditionalInfo[]	'type' 및 'info' 속성이 있는 개체의 배열입니다. 'info'의 스키마는 서비스별 스키마이며 'type' 문자열에 따라 달라집니다.
code	string	오류를 프로그래밍 방식으로 식별하는 데 사용할 수 있는 지역화되지 않은 문자열입니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공합니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

ErrorResponse

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

Name	형식	Description
error	Error

MetricAlertAction

경고 작업입니다.

Name	형식	Description
actionGroupId	string	사용할 작업 그룹의 ID입니다.
webHookProperties	object	이 필드를 사용하면 웹후크에 대한 입력으로 전송되는 경고 페이로드에 추가되는 사용자 지정 속성을 지정할 수 있습니다.

MetricAlertMultipleResourceMultipleMetricCriteria

여러 메트릭 조건이 있는 여러 리소스에 대한 메트릭 경고 조건을 지정합니다.

Name	형식	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	이 'all of' 작업에 대한 여러 메트릭 조건 목록입니다.
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	는 경고 조건의 유형을 지정합니다.

MetricAlertResource

메트릭 경고 리소스입니다.

Name	형식	Description
id	string	Azure 리소스 ID
location	string	리소스 위치
name	string	Azure 리소스 이름
properties.actions	MetricAlertAction[]	경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업의 배열입니다.
properties.autoMitigate	boolean	경고를 자동으로 해결해야 하는지 여부를 나타내는 플래그입니다. 기본값은 true입니다.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	는 특정 경고 조건 정보를 정의합니다.
properties.description	string	경고 이메일에 포함될 메트릭 경고에 대한 설명입니다.
properties.enabled	boolean	메트릭 경고가 사용되는지 여부를 나타내는 플래그입니다.
properties.evaluationFrequency	string	메트릭 경고가 ISO 8601 기간 형식으로 표시되는 빈도입니다.
properties.isMigrated	boolean	이 경고 규칙이 마이그레이션되는지 여부를 나타내는 값입니다.
properties.lastUpdatedTime	string	마지막으로 규칙이 ISO8601 형식으로 업데이트되었습니다.
properties.scopes	string[]	이 메트릭 경고의 범위가 지정된 리소스 ID 목록입니다.
properties.severity	integer	경고 심각도 {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	경고가 생성/업데이트되는 대상 리소스의 지역입니다. 범위에 구독, 리소스 그룹 또는 둘 이상의 리소스가 포함된 경우 필수입니다.
properties.targetResourceType	string	경고가 생성/업데이트되는 대상 리소스의 리소스 종류입니다. 범위에 구독, 리소스 그룹 또는 둘 이상의 리소스가 포함된 경우 필수입니다.
properties.windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다.
tags	object	리소스 태그
type	string	Azure 리소스 종류

MetricAlertResourcePatch

패치 작업에 대한 메트릭 경고 리소스입니다.

Name	형식	Description
properties.actions	MetricAlertAction[]	경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업의 배열입니다.
properties.autoMitigate	boolean	경고를 자동으로 해결해야 하는지 여부를 나타내는 플래그입니다. 기본값은 true입니다.
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria WebtestLocationAvailabilityCriteria	는 특정 경고 조건 정보를 정의합니다.
properties.description	string	경고 이메일에 포함될 메트릭 경고에 대한 설명입니다.
properties.enabled	boolean	메트릭 경고가 사용되는지 여부를 나타내는 플래그입니다.
properties.evaluationFrequency	string	메트릭 경고가 ISO 8601 기간 형식으로 표시되는 빈도입니다.
properties.isMigrated	boolean	이 경고 규칙이 마이그레이션되는지 여부를 나타내는 값입니다.
properties.lastUpdatedTime	string	마지막으로 규칙이 ISO8601 형식으로 업데이트되었습니다.
properties.scopes	string[]	이 메트릭 경고의 범위가 지정된 리소스 ID 목록입니다.
properties.severity	integer	경고 심각도 {0, 1, 2, 3, 4}
properties.targetResourceRegion	string	경고가 생성/업데이트되는 대상 리소스의 지역입니다. MultipleResourceMultipleMetricCriteria에 대한 필수입니다.
properties.targetResourceType	string	경고가 생성/업데이트되는 대상 리소스의 리소스 종류입니다. MultipleResourceMultipleMetricCriteria에 대한 필수입니다.
properties.windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다.
tags	object	리소스 태그

MetricAlertSingleResourceMultipleMetricCriteria

여러 메트릭 조건이 있는 단일 리소스에 대한 메트릭 경고 조건을 지정합니다.

Name	형식	Description
allOf	MetricCriteria[]	이 '모두' 작업에 대한 메트릭 조건 목록입니다.
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	는 경고 조건의 유형을 지정합니다.

MetricCriteria

메트릭을 필터링하는 기준입니다.

Name	형식	Description
criterionType	string: StaticThresholdCriterion	임계값 조건의 유형을 지정합니다.
dimensions	MetricDimension[]	차원 조건 목록입니다.
metricName	string	메트릭의 이름입니다.
metricNamespace	string	메트릭의 네임스페이스입니다.
name	string	조건의 이름입니다.
operator	Operator	조건 연산자입니다.
skipMetricValidation	boolean	메트릭 유효성 검사를 건너뛰게 하여 아직 내보내지 않은 사용자 지정 메트릭에 대한 경고 규칙을 만들 수 있습니다.
threshold	number	경고를 활성화하는 조건 임계값입니다.
timeAggregation	AggregationTypeEnum	조건 시간 집계 형식입니다.

MetricDimension

메트릭 차원을 지정합니다.

Name	형식	Description
name	string	차원의 이름입니다.
operator	string	차원 연산자입니다. 'Include' 및 'Exclude'만 지원됩니다.
values	string[]	차원 값 목록입니다.

Operator

조건 연산자입니다.

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

WebtestLocationAvailabilityCriteria

웹 테스트 리소스에 대한 메트릭 경고 규칙 조건을 지정합니다.

Name	형식	Description
componentId	string	Application Insights 리소스 ID입니다.
failedLocationCount	number	실패한 위치의 수입니다.
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	는 경고 조건의 유형을 지정합니다.
webTestId	string	Application Insights 웹 테스트 ID입니다.

다음을 통해 공유

Metric Alerts - Update

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

Create or update an alert rule

샘플 요청

샘플 응답

정의

AdditionalInfo

AggregationTypeEnum

DynamicMetricCriteria

DynamicThresholdFailingPeriods

DynamicThresholdOperator

DynamicThresholdSensitivity

Error

ErrorDetail

ErrorResponse

MetricAlertAction

MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertResource

MetricAlertResourcePatch

MetricAlertSingleResourceMultipleMetricCriteria

MetricCriteria

MetricDimension

Operator

WebtestLocationAvailabilityCriteria

추가 리소스