Alert Rules - Get

참조

Service:: Monitor

API Version:: 2016-03-01

클래식 메트릭 경고 규칙을 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}?api-version=2016-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
200 OK	AlertRuleResource	경고 규칙을 가져오기 위한 성공적인 요청
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Get an alert rule

Sample Request

GET https://management.azure.com/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourcegroups/Rac46PostSwapRG/providers/Microsoft.Insights/alertrules/chiricutin?api-version=2016-03-01


/**
 * Samples for AlertRules GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json
     */
    /**
     * Sample code: Get an alert rule.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAnAlertRule(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getAlertRules()
            .getByResourceGroupWithResponse("Rac46PostSwapRG", "chiricutin", com.azure.core.util.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/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/2016-03-01/examples/getAlertRule.json
func ExampleAlertRulesClient_Get() {
	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.NewAlertRulesClient().Get(ctx, "Rac46PostSwapRG", "chiricutin", 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.AlertRuleResource = armmonitor.AlertRuleResource{
	// 	Name: to.Ptr("chiricutin"),
	// 	Type: to.Ptr("Microsoft.Insights/alertRules"),
	// 	ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"$type": to.Ptr("Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage"),
	// 		"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": to.Ptr("Resource"),
	// 	},
	// 	Properties: &armmonitor.AlertRule{
	// 		Name: to.Ptr("chiricutin"),
	// 		Description: to.Ptr("Pura Vida"),
	// 		Actions: []armmonitor.RuleActionClassification{
	// 		},
	// 		Condition: &armmonitor.ThresholdRuleCondition{
	// 			DataSource: &armmonitor.RuleMetricDataSource{
	// 				ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource"),
	// 				ResourceURI: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest"),
	// 				MetricName: to.Ptr("Requests"),
	// 			},
	// 			ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition"),
	// 			Operator: to.Ptr(armmonitor.ConditionOperatorGreaterThan),
	// 			Threshold: to.Ptr[float64](3),
	// 			TimeAggregation: to.Ptr(armmonitor.TimeAggregationOperatorTotal),
	// 			WindowSize: to.Ptr("PT5M"),
	// 		},
	// 		IsEnabled: to.Ptr(true),
	// 		LastUpdatedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2016-11-23T21:23:52.022Z"); return t}()),
	// 	},
	// }
}

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 a classic metric alert rule
 *
 * @summary Gets a classic metric alert rule
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json
 */
async function getAnAlertRule() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const resourceGroupName = process.env["MONITOR_RESOURCE_GROUP"] || "Rac46PostSwapRG";
  const ruleName = "chiricutin";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const result = await client.alertRules.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

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

// Generated from example definition: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json
// this example is just showing the usage of "AlertRules_Get" 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 AlertRuleResource created on azure
// for more information of creating AlertRuleResource, please refer to the document of AlertRuleResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
string ruleName = "chiricutin";
ResourceIdentifier alertRuleResourceId = AlertRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, ruleName);
AlertRuleResource alertRule = client.GetAlertRuleResource(alertRuleResourceId);

// invoke the operation
AlertRuleResource result = await alertRule.GetAsync();

// 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
AlertRuleData 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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin",
  "name": "chiricutin",
  "type": "Microsoft.Insights/alertRules",
  "location": "West US",
  "tags": {
    "$type": "Microsoft.WindowsAzure.Management.Common.Storage.CasePreservedDictionary, Microsoft.WindowsAzure.Management.Common.Storage",
    "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
  },
  "properties": {
    "name": "chiricutin",
    "description": "Pura Vida",
    "isEnabled": true,
    "condition": {
      "odata.type": "Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition",
      "dataSource": {
        "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource",
        "resourceUri": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest",
        "metricName": "Requests"
      },
      "operator": "GreaterThan",
      "threshold": 3,
      "windowSize": "PT5M",
      "timeAggregation": "Total"
    },
    "lastUpdatedTime": "2016-11-23T21:23:52.0221265Z",
    "actions": []
  }
}

정의

Name	Description
AlertRuleResource	경고 규칙 리소스입니다.
ConditionOperator	규칙 조건에서 허용되는 연산자입니다.
ErrorResponse	오류 응답의 형식을 설명합니다.
LocationThresholdRuleCondition	실패하는 특정 수의 위치를 기반으로 하는 규칙 조건입니다.
ManagementEventAggregationCondition	데이터가 수집되는 방법은 시간이 지남에 따라 결합되어야 합니다.
ManagementEventRuleCondition	관리 이벤트 규칙 조건입니다.
RuleEmailAction	규칙 조건이 평가될 때 전자 메일을 보내는 작업을 지정합니다. 이 경우 판별자 는 항상 RuleEmailAction입니다.
RuleManagementEventClaimsDataSource	규칙 관리 이벤트 데이터 원본에 대한 클레임입니다.
RuleManagementEventDataSource	규칙 관리 이벤트 데이터 원본입니다. 이 경우 판별자 필드는 항상 RuleManagementEventDataSource입니다.
RuleMetricDataSource	규칙 메트릭 데이터 원본입니다. 이 경우 판별자 값은 항상 RuleMetricDataSource입니다.
RuleWebhookAction	규칙 조건이 평가될 때 서비스에 게시할 작업을 지정합니다. 이 경우 판별자 항상 RuleWebhookAction입니다.
ThresholdRuleCondition	임계값을 초과하는 메트릭을 기반으로 하는 규칙 조건입니다.
TimeAggregationOperator	규칙에서 허용되는 집계 연산자입니다.

AlertRuleResource

경고 규칙 리소스입니다.

Name	형식	Description
id	string	Azure 리소스 ID
location	string	리소스 위치
name	string	Azure 리소스 이름
properties.action	RuleAction: RuleEmailAction RuleWebhookAction	경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업입니다.
properties.actions	RuleAction[]: RuleEmailAction[] RuleWebhookAction[]	경고 규칙이 활성화되고 경고 조건이 해결될 때 수행되는 작업의 배열입니다.
properties.condition	RuleCondition: LocationThresholdRuleCondition ManagementEventRuleCondition ThresholdRuleCondition	경고 규칙이 활성화되는 조건입니다.
properties.description	string	경고 이메일에 포함될 경고 규칙에 대한 설명입니다.
properties.isEnabled	boolean	경고 규칙을 사용할 수 있는지 여부를 나타내는 플래그입니다.
properties.lastUpdatedTime	string	마지막으로 규칙이 ISO8601 형식으로 업데이트되었습니다.
properties.name	string	경고 규칙의 이름입니다.
properties.provisioningState	string	프로비저닝 상태입니다.
tags	object	리소스 태그
type	string	Azure 리소스 종류

ConditionOperator

규칙 조건에서 허용되는 연산자입니다.

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

ErrorResponse

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

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

LocationThresholdRuleCondition

실패하는 특정 수의 위치를 기반으로 하는 규칙 조건입니다.

Name	형식	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	규칙이 해당 데이터를 수집하는 리소스입니다. 이 형식의 경우 dataSource는 항상 RuleMetricDataSource 형식입니다.
failedLocationCount	integer	경고를 활성화하지 않아야 하는 위치 수입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	는 조건 유형을 지정합니다. ManagementEventRuleCondition(관리 이벤트 발생), LocationThresholdRuleCondition(웹 테스트 실패 횟수 기준) 및 ThresholdRuleCondition(메트릭 임계값 기준)의 세 가지 유형 중 하나일 수 있습니다.
windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다. 지정된 경우 5분에서 1일 사이여야 합니다.

ManagementEventAggregationCondition

데이터가 수집되는 방법은 시간이 지남에 따라 결합되어야 합니다.

Name	형식	Description
operator	ConditionOperator	조건 연산자입니다.
threshold	number	경고를 활성화하는 임계값입니다.
windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다. 지정된 경우 5분에서 1일 사이여야 합니다.

ManagementEventRuleCondition

관리 이벤트 규칙 조건입니다.

Name	형식	Description
aggregation	ManagementEventAggregationCondition	시간이 지남에 따라 수집되는 데이터를 결합하는 방법과 경고가 활성화되는 시기. 관리 이벤트 경고 집계는 선택 사항이며 제공하지 않는 경우에는 이벤트가 발생할 때마다 경고가 활성화됩니다.
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	규칙이 해당 데이터를 수집하는 리소스입니다. 이 형식의 경우 dataSource는 항상 RuleMetricDataSource 형식입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	는 조건 유형을 지정합니다. ManagementEventRuleCondition(관리 이벤트 발생), LocationThresholdRuleCondition(웹 테스트 실패 횟수 기준) 및 ThresholdRuleCondition(메트릭 임계값 기준)의 세 가지 유형 중 하나일 수 있습니다.

RuleEmailAction

규칙 조건이 평가될 때 전자 메일을 보내는 작업을 지정합니다. 이 경우 판별자 는 항상 RuleEmailAction입니다.

Name	형식	Description
customEmails	string[]	경고 활성화를 알리는 관리자의 사용자 지정 이메일 주소 목록입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	는 작업의 형식을 지정합니다. RuleEmailAction 및 RuleWebhookAction의 두 가지 작업 유형이 있습니다.
sendToServiceOwners	boolean	경고 활성화 시 서비스의 관리자, 즉 서비스 관리자와 공동 관리자에게 알림을 보낼지 여부입니다.

RuleManagementEventClaimsDataSource

규칙 관리 이벤트 데이터 원본에 대한 클레임입니다.

Name	형식	Description
emailAddress	string	전자 메일 주소입니다.

RuleManagementEventDataSource

규칙 관리 이벤트 데이터 원본입니다. 이 경우 판별자 필드는 항상 RuleManagementEventDataSource입니다.

Name	형식	Description
claims	RuleManagementEventClaimsDataSource	클레임입니다.
eventName	string	이벤트 이름입니다.
eventSource	string	이벤트 원본입니다.
legacyResourceId	string	규칙이 모니터링하는 리소스의 레거시 리소스 식별자입니다. 참고: 이 속성은 기존 규칙에 대해 업데이트할 수 없습니다.
level	string	수준입니다.
metricNamespace	string	메트릭의 네임스페이스입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	는 데이터 원본의 형식을 지정합니다. 규칙 데이터 원본에는 RuleMetricDataSource 및 RuleManagementEventDataSource의 두 가지 유형이 있습니다.
operationName	string	확인할 작업의 이름입니다. 이름을 제공하지 않으면 모든 작업이 일치하게 됩니다.
resourceGroupName	string	리소스 그룹 이름입니다.
resourceLocation	string	리소스의 위치입니다.
resourceProviderName	string	리소스 공급자 이름입니다.
resourceUri	string	규칙이 모니터링하는 리소스의 리소스 식별자입니다. 참고: 이 속성은 기존 규칙에 대해 업데이트할 수 없습니다.
status	string	확인할 작업의 상태입니다. 상태를 제공하지 않으면 모든 상태가 일치하게 됩니다.
subStatus	string	하위 상태입니다.

RuleMetricDataSource

규칙 메트릭 데이터 원본입니다. 이 경우 판별자 값은 항상 RuleMetricDataSource입니다.

Name	형식	Description
legacyResourceId	string	규칙이 모니터링하는 리소스의 레거시 리소스 식별자입니다. 참고: 이 속성은 기존 규칙에 대해 업데이트할 수 없습니다.
metricName	string	규칙이 모니터링하는 항목을 정의하는 메트릭의 이름입니다.
metricNamespace	string	메트릭의 네임스페이스입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	는 데이터 원본의 형식을 지정합니다. 규칙 데이터 원본에는 RuleMetricDataSource 및 RuleManagementEventDataSource의 두 가지 유형이 있습니다.
resourceLocation	string	리소스의 위치입니다.
resourceUri	string	규칙이 모니터링하는 리소스의 리소스 식별자입니다. 참고: 이 속성은 기존 규칙에 대해 업데이트할 수 없습니다.

RuleWebhookAction

규칙 조건이 평가될 때 서비스에 게시할 작업을 지정합니다. 이 경우 판별자 항상 RuleWebhookAction입니다.

Name	형식	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	는 작업의 형식을 지정합니다. RuleEmailAction 및 RuleWebhookAction의 두 가지 작업 유형이 있습니다.
properties	object	게시 작업에 포함할 사용자 지정 속성의 사전입니다. 이러한 데이터는 웹후크 페이로드에 추가됩니다.
serviceUri	string	경고가 활성화되거나 해결될 때 알림 게시에 대한 서비스 URI입니다.

ThresholdRuleCondition

임계값을 초과하는 메트릭을 기반으로 하는 규칙 조건입니다.

Name	형식	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	규칙이 해당 데이터를 수집하는 리소스입니다. 이 형식의 경우 dataSource는 항상 RuleMetricDataSource 형식입니다.
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	는 조건 유형을 지정합니다. ManagementEventRuleCondition(관리 이벤트 발생), LocationThresholdRuleCondition(웹 테스트 실패 횟수 기준) 및 ThresholdRuleCondition(메트릭 임계값 기준)의 세 가지 유형 중 하나일 수 있습니다.
operator	ConditionOperator	데이터와 임계값을 비교하는 데 사용되는 연산자입니다.
threshold	number	경고를 활성화하는 임계값입니다.
timeAggregation	TimeAggregationOperator	시간 집계 연산자입니다. 시간이 지남에 따라 수집되는 데이터를 결합하는 방법입니다. 기본값은 메트릭의 PrimaryAggregationType입니다.
windowSize	string	임계값에 따라 경고 활동을 모니터링하는 데 사용되는 기간(ISO 8601 기간 형식)입니다. 지정된 경우 5분에서 1일 사이여야 합니다.

TimeAggregationOperator

규칙에서 허용되는 집계 연산자입니다.

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

Alert Rules - Get

URI 매개 변수

응답

보안

azure_auth

Scopes

예제

Get an alert rule

Sample Request

Sample Response

정의

AlertRuleResource

ConditionOperator

ErrorResponse

LocationThresholdRuleCondition

ManagementEventAggregationCondition

ManagementEventRuleCondition

RuleEmailAction

RuleManagementEventClaimsDataSource

RuleManagementEventDataSource

RuleMetricDataSource

RuleWebhookAction

ThresholdRuleCondition

TimeAggregationOperator

추가 리소스