Metric Alerts - List By Subscription

參考

服務:: Monitor

API 版本:: 2018-03-01

擷取訂用帳戶中的警示規則定義。

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

URI 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	MetricAlertResourceCollection	計量警示清單的成功要求
Other Status Codes	ErrorResponse	BadRequest

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List metric alert rules

範例要求

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


/**
 * Samples for MetricAlerts List.
 */
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().list(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"
            }
          }
        ]
      }
    }
  ]
}

定義

名稱	Description
AdditionalInfo	具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的，且相依於 'type' 字串。
AggregationTypeEnum	準則時間匯總類型。
DynamicMetricCriteria	動態閾值的準則。
DynamicThresholdFailingPeriods	引發警示所需的所選回溯時間範圍內所需的違規數目下限。
DynamicThresholdOperator	運算子，用來比較計量值與臨界值。
DynamicThresholdSensitivity	觸發警示所需的偏差範圍。這會影響臨界值與計量數列模式的緊密程度。
Error
ErrorDetail	描述錯誤回應的詳細數據。
ErrorResponse	描述錯誤回應的格式。
MetricAlertAction	警示動作。
MetricAlertMultipleResourceMultipleMetricCriteria	指定具有多個計量準則之多個資源的計量警示準則。
MetricAlertResource	計量警示資源。
MetricAlertResourceCollection	表示警示規則資源的集合。
MetricAlertSingleResourceMultipleMetricCriteria	指定具有多個計量準則之單一資源的計量警示準則。
MetricCriteria	篩選計量的準則。
MetricDimension	指定計量維度。
Operator	criteria 運算子。
WebtestLocationAvailabilityCriteria	指定 Web 測試資源的計量警示規則準則。

AdditionalInfo

具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的，且相依於 'type' 字串。

名稱	類型	Description
info	object	類型特有的其他資訊。
type	string	其他信息的類型。

AggregationTypeEnum

準則時間匯總類型。

名稱	類型	Description
Average	string
Count	string
Maximum	string
Minimum	string
Total	string

DynamicMetricCriteria

動態閾值的準則。

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

引發警示所需的所選回溯時間範圍內所需的違規數目下限。

名稱	類型	Description
minFailingPeriodsToAlert	number	觸發警示的違規次數。應小於或等於 numberOfEvaluationPeriods。
numberOfEvaluationPeriods	number	匯總回溯點的數目。回溯時間範圍是根據匯總數據粒度（windowSize）和選取的匯總點數目來計算。

DynamicThresholdOperator

運算子，用來比較計量值與臨界值。

名稱	類型	Description
GreaterOrLessThan	string
GreaterThan	string
LessThan	string

DynamicThresholdSensitivity

觸發警示所需的偏差範圍。這會影響臨界值與計量數列模式的緊密程度。

名稱	類型	Description
High	string
Low	string
Medium	string

Error

名稱	類型	Description
additionalInfo	AdditionalInfo[]	具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的，且相依於 'type' 字串。
code	string	未設定字串，可用來以程式設計方式識別錯誤。
details	ErrorDetail[]	其他巢狀錯誤回應資訊對象的陣列，如此合約所述。
message	string	詳細說明錯誤並提供偵錯資訊。如果在要求中設定 Accept-Language，則必須將其當地語系化為該語言。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。

ErrorDetail

描述錯誤回應的詳細數據。

名稱	類型	Description
additionalInfo	AdditionalInfo[]	具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的，且相依於 'type' 字串。
code	string	未設定字串，可用來以程式設計方式識別錯誤。
message	string	詳細說明錯誤並提供偵錯資訊。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。

ErrorResponse

描述錯誤回應的格式。

名稱	類型	Description
error	Error

MetricAlertAction

警示動作。

名稱	類型	Description
actionGroupId	string	要使用的動作群組標識碼。
webHookProperties	object	此欄位允許指定自定義屬性，這會附加至傳送為 Webhook 輸入的警示承載。

MetricAlertMultipleResourceMultipleMetricCriteria

指定具有多個計量準則之多個資源的計量警示準則。

名稱	類型	Description
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	此「所有」作業的多個計量準則清單。
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	指定警示準則的類型。

MetricAlertResource

計量警示資源。

名稱	類型	Description
id	string	Azure 資源標識碼
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[]	資源標識碼的清單是此計量警示的範圍。
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

表示警示規則資源的集合。

名稱	類型	Description
value	MetricAlertResource[]	警示規則資源的值。

MetricAlertSingleResourceMultipleMetricCriteria

指定具有多個計量準則之單一資源的計量警示準則。

名稱	類型	Description
allOf	MetricCriteria[]	此「所有」作業的計量準則清單。
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	指定警示準則的類型。

MetricCriteria

篩選計量的準則。

名稱	類型	Description
criterionType	string: StaticThresholdCriterion	指定臨界值準則的類型
dimensions	MetricDimension[]	維度條件的清單。
metricName	string	計量的名稱。
metricNamespace	string	計量的命名空間。
name	string	準則的名稱。
operator	Operator	criteria 運算子。
skipMetricValidation	boolean	允許在尚未發出的自定義計量上建立警示規則，方法是略過計量驗證。
threshold	number	啟動警示的準則臨界值。
timeAggregation	AggregationTypeEnum	準則時間匯總類型。

MetricDimension

指定計量維度。

名稱	類型	Description
name	string	維度的名稱。
operator	string	維度運算子。僅支援 'Include' 和 'Exclude'
values	string[]	維度值的清單。

Operator

criteria 運算子。

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

WebtestLocationAvailabilityCriteria

指定 Web 測試資源的計量警示規則準則。

名稱	類型	Description
componentId	string	Application Insights 資源標識符。
failedLocationCount	number	失敗的位置數目。
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	指定警示準則的類型。
webTestId	string	Application Insights Web 測試標識符。

共用方式為

Metric Alerts - List By Subscription

URI 參數

回應

安全性

azure_auth

範圍

範例

List metric alert rules

範例要求

範例回覆

定義

AdditionalInfo

AggregationTypeEnum

DynamicMetricCriteria

DynamicThresholdFailingPeriods

DynamicThresholdOperator

DynamicThresholdSensitivity

Error

ErrorDetail

ErrorResponse

MetricAlertAction

MetricAlertMultipleResourceMultipleMetricCriteria

MetricAlertResource

MetricAlertResourceCollection

MetricAlertSingleResourceMultipleMetricCriteria

MetricCriteria

MetricDimension

Operator

WebtestLocationAvailabilityCriteria

其他資源