Metric Alerts - List By Resource Group

リファレンス

サービス:: Monitor

API バージョン:: 2018-03-01

リソースグループ内のアラートルール定義を取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	MetricAlertResourceCollection	メトリックアラートの一覧に対する要求が成功しました
Other Status Codes	ErrorResponse	BadRequest

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

List metric alert rules

要求のサンプル

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


/**
 * Samples for MetricAlerts ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
     */
    /**
     * Sample code: List metric alert rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listMetricAlertRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getMetricAlerts().listByResourceGroup("gigtest",
            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/2018-03-01/examples/listMetricAlert.json
func ExampleMetricAlertsClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewMetricAlertsClient().NewListBySubscriptionPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MetricAlertResourceCollection = armmonitor.MetricAlertResourceCollection{
		// 	Value: []*armmonitor.MetricAlertResource{
		// 		{
		// 			Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 			ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu"),
		// 			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"),
		// 						},
		// 				}},
		// 				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("CustomMetric_\\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"),
		// 				},
		// 			},
		// 			{
		// 				Type: to.Ptr("Microsoft.Insights/metricAlerts"),
		// 				ID: to.Ptr("/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu"),
		// 				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("Med cpu alert"),
		// 					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"),
		// 							},
		// 					}},
		// 					Criteria: &armmonitor.MetricAlertSingleResourceMultipleMetricCriteria{
		// 						ODataType: to.Ptr(armmonitor.OdatatypeMicrosoftAzureMonitorSingleResourceMultipleMetricCriteria),
		// 						AllOf: []*armmonitor.MetricCriteria{
		// 							{
		// 								Name: to.Ptr("Medium_CPU_50"),
		// 								CriterionType: to.Ptr(armmonitor.CriterionTypeStaticThresholdCriterion),
		// 								Dimensions: []*armmonitor.MetricDimension{
		// 								},
		// 								MetricName: to.Ptr("CustomMetric_\\Processor(_Total)\\% Processor Time"),
		// 								TimeAggregation: to.Ptr(armmonitor.AggregationTypeEnumAverage),
		// 								Operator: to.Ptr(armmonitor.OperatorGreaterThan),
		// 								Threshold: to.Ptr[float64](50.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](4),
		// 						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 Retrieve alert rule definitions in a subscription.
 *
 * @summary Retrieve alert rule definitions in a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json
 */
async function listMetricAlertRules() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.metricAlerts.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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/listMetricAlert.json
// this example is just showing the usage of "MetricAlerts_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (MetricAlertResource item in subscriptionResource.GetMetricAlertsAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "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": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "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": "Med cpu alert",
        "severity": 4,
        "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": "Medium_CPU_50",
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "dimensions": [],
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ]
        },
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ]
      }
    }
  ]
}

定義

名前	説明
AggregationTypeEnum	条件の時間集計の種類。
DynamicMetricCriteria	動的しきい値の条件。
DynamicThresholdFailingPeriods	アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。
DynamicThresholdOperator	メトリック値をしきい値と比較するために使用される演算子。
DynamicThresholdSensitivity	アラートをトリガーするために必要な偏差の範囲。これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。
ErrorResponse	エラー応答の形式について説明します。
MetricAlertAction	アラートアクション。
MetricAlertMultipleResourceMultipleMetricCriteria	複数のメトリック条件を持つ複数のリソースのメトリックアラート条件を指定します。
MetricAlertResource	メトリックアラートリソース。
MetricAlertResourceCollection	アラートルールリソースのコレクションを表します。
MetricAlertSingleResourceMultipleMetricCriteria	複数のメトリック条件を持つ 1 つのリソースのメトリックアラート条件を指定します。
MetricCriteria	メトリックをフィルター処理する条件。
MetricDimension	メトリックディメンションを指定します。
Operator	criteria 演算子。
WebtestLocationAvailabilityCriteria	Web テストリソースのメトリックアラートルールの条件を指定します。

AggregationTypeEnum

条件の時間集計の種類。

名前	型	説明
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

動的しきい値の条件。

名前	型	説明
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

アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。

名前	型	説明
minFailingPeriodsToAlert	number	アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。
numberOfEvaluationPeriods	number	集計されたルックバックポイントの数。ルックバック時間枠は、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。

DynamicThresholdOperator

メトリック値をしきい値と比較するために使用される演算子。

名前	型	説明
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

アラートをトリガーするために必要な偏差の範囲。これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。

名前	型	説明
High	string
Low	string
Medium	string

ErrorResponse

エラー応答の形式について説明します。

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

MetricAlertAction

アラートアクション。

名前	型	説明
actionGroupId	string	使用するアクショングループの ID。
webHookProperties	object	このフィールドでは、Webhook への入力として送信されるアラートペイロードに追加されるカスタムプロパティを指定できます。

MetricAlertMultipleResourceMultipleMetricCriteria

複数のメトリック条件を持つ複数のリソースのメトリックアラート条件を指定します。

名前	型	説明
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	この 'all of' 操作の複数のメトリック条件の一覧。
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	は、アラート条件の種類を指定します。

MetricAlertResource

メトリックアラートリソース。

名前	型	説明
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 リソースタイプ

MetricAlertResourceCollection

アラートルールリソースのコレクションを表します。

名前	型	説明
value	MetricAlertResource[]	アラートルールリソースの値。

MetricAlertSingleResourceMultipleMetricCriteria

複数のメトリック条件を持つ 1 つのリソースのメトリックアラート条件を指定します。

名前	型	説明
allOf	MetricCriteria[]	この "all of" 操作のメトリック条件の一覧。
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	は、アラート条件の種類を指定します。

MetricCriteria

メトリックをフィルター処理する条件。

名前	型	説明
criterionType	string: StaticThresholdCriterion	しきい値条件の種類を指定します
dimensions	MetricDimension[]	ディメンション条件の一覧。
metricName	string	メトリックの名前。
metricNamespace	string	メトリックの名前空間。
name	string	条件の名前。
operator	Operator	criteria 演算子。
skipMetricValidation	boolean	メトリック検証をスキップすることによって、まだ出力されていないカスタムメトリックに対するアラートルールの作成を許可します。
threshold	number	アラートをアクティブにする条件しきい値。
timeAggregation	AggregationTypeEnum	条件の時間集計の種類。

MetricDimension

メトリックディメンションを指定します。

名前	型	説明
name	string	ディメンションの名前。
operator	string	ディメンション演算子。 'Include' と 'Exclude' のみがサポートされています
values	string[]	ディメンション値の一覧。

Operator

criteria 演算子。

名前	型	説明
Equals	string
GreaterThan	string
GreaterThanOrEqual	string
LessThan	string
LessThanOrEqual	string

WebtestLocationAvailabilityCriteria

Web テストリソースのメトリックアラートルールの条件を指定します。

名前	型	説明
componentId	string	Application Insights リソース ID。
failedLocationCount	number	失敗した場所の数。
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	は、アラート条件の種類を指定します。
webTestId	string	Application Insights Web テスト ID。

次の方法で共有

Metric Alerts - List By Resource Group

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

List metric alert rules

要求のサンプル

応答のサンプル

定義

AggregationTypeEnum

DynamicMetricCriteria

DynamicThresholdFailingPeriods

DynamicThresholdOperator

DynamicThresholdSensitivity

ErrorResponse

MetricAlertAction

MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertResource

MetricAlertResourceCollection

MetricAlertSingleResourceMultipleMetricCriteria

MetricCriteria

MetricDimension

Operator

WebtestLocationAvailabilityCriteria

その他のリソース