Alert Rules - List By Subscription

參考

Service:: Monitor

API Version:: 2016-03-01

列出訂用帳戶內的傳統計量警示規則。

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

URI 參數

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

回應

名稱	類型	Description
200 OK	AlertRuleResourceCollection	警示規則清單的成功要求
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

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

範例

List alert rules

Sample Request

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


/**
 * Samples for AlertRules List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleBySubscription.
     * json
     */
    /**
     * Sample code: List alert rules.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAlertRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.diagnosticSettings().manager().serviceClient().getAlertRules().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/2016-03-01/examples/listAlertRuleBySubscription.json
func ExampleAlertRulesClient_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.NewAlertRulesClient().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.AlertRuleResourceCollection = armmonitor.AlertRuleResourceCollection{
		// 	Value: []*armmonitor.AlertRuleResource{
		// 		{
		// 			Name: to.Ptr("myRuleName"),
		// 			Type: to.Ptr("Microsoft.Insights/alertRules"),
		// 			ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName"),
		// 			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("myRuleName"),
		// 				Description: to.Ptr("Pura Vida"),
		// 				Actions: []armmonitor.RuleActionClassification{
		// 					&armmonitor.RuleEmailAction{
		// 						ODataType: to.Ptr("Microsoft.Azure.Management.Insights.Models.RuleEmailAction"),
		// 						CustomEmails: []*string{
		// 							to.Ptr("gu@ms.com"),
		// 							to.Ptr("su@ms.net")},
		// 							SendToServiceOwners: to.Ptr(true),
		// 					}},
		// 					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](2),
		// 						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-10T21:04:39.000Z"); return t}()),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("chiricutin0"),
		// 				Type: to.Ptr("Microsoft.Insights/alertRules"),
		// 				ID: to.Ptr("/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0"),
		// 				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("chiricutin0"),
		// 					Description: to.Ptr("Pura Vida 0"),
		// 					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](2),
		// 						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-10T21:04:39.108Z"); 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 List the classic metric alert rules within a subscription.
 *
 * @summary List the classic metric alert rules within a subscription.
 * x-ms-original-file: specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json
 */
async function listAlertRules() {
  const subscriptionId =
    process.env["MONITOR_SUBSCRIPTION_ID"] || "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
  const credential = new DefaultAzureCredential();
  const client = new MonitorClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.alertRules.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 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/listAlertRuleBySubscription.json
// this example is just showing the usage of "AlertRules_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 = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (AlertRuleResource item in subscriptionResource.GetAlertRulesAsync())
{
    // 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
    AlertRuleData 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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/myRuleName",
      "name": "myRuleName",
      "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": "myRuleName",
        "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": 2,
          "windowSize": "PT5M",
          "timeAggregation": "Total"
        },
        "lastUpdatedTime": "2016-11-10T21:04:39.0005255Z",
        "actions": [
          {
            "odata.type": "Microsoft.Azure.Management.Insights.Models.RuleEmailAction",
            "sendToServiceOwners": true,
            "customEmails": [
              "gu@ms.com",
              "su@ms.net"
            ]
          }
        ]
      }
    },
    {
      "id": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/microsoft.insights/alertrules/chiricutin0",
      "name": "chiricutin0",
      "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": "chiricutin0",
        "description": "Pura Vida 0",
        "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": 2,
          "windowSize": "PT5M",
          "timeAggregation": "Total"
        },
        "lastUpdatedTime": "2016-11-10T21:04:39.1082596Z",
        "actions": []
      }
    }
  ]
}

定義

名稱	Description
AlertRuleResource	警示規則資源。
AlertRuleResourceCollection	表示警示規則資源的集合。
ConditionOperator	規則條件中允許的運算符。
ErrorResponse	描述錯誤回應的格式。
LocationThresholdRuleCondition	根據特定位置數目的規則條件失敗。
ManagementEventAggregationCondition	收集的資料應如何隨著時間結合。
ManagementEventRuleCondition	管理事件規則條件。
RuleEmailAction	指定評估規則條件時要傳送電子郵件的動作。在此案例中，辨別子一律為 RuleEmailAction。
RuleManagementEventClaimsDataSource	規則管理事件數據源的宣告。
RuleManagementEventDataSource	規則管理事件數據源。在此案例中，鑒別子字段一律為 RuleManagementEventDataSource。
RuleMetricDataSource	規則計量數據源。在此情況下，辨別子值一律為 RuleMetricDataSource。
RuleWebhookAction	指定要在評估規則條件時張貼至服務的動作。在此案例中，鑒別子一律為 RuleWebhookAction。
ThresholdRuleCondition	根據超出臨界值之計量的規則條件。
TimeAggregationOperator	規則中允許的匯總運算符。

AlertRuleResource

警示規則資源。

名稱	類型	Description
id	string	Azure 資源標識碼
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 資源類型

AlertRuleResourceCollection

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

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

ConditionOperator

規則條件中允許的運算符。

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

ErrorResponse

描述錯誤回應的格式。

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

LocationThresholdRuleCondition

根據特定位置數目的規則條件失敗。

名稱	類型	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	規則從中收集數據的資源。針對此類型 dataSource，一律為 RuleMetricDataSource 類型。
failedLocationCount	integer	必須無法啟動警示的位置數目。
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	會指定條件的類型。這可以是下列三種類型之一：ManagementEventRuleCondition () 、LocationThresholdRuleCondition (，根據 Web 測試) 的失敗數目，以及根據計量) 的臨界值來 (的 ThresholdRuleCondition。
windowSize	string	ISO 8601 持續時間格式 (期間) ，用來根據閾值監視警示活動。如果指定，則它必須介於 5 分鐘到 1 天之間。

ManagementEventAggregationCondition

收集的資料應如何隨著時間結合。

名稱	類型	Description
operator	ConditionOperator	條件運算元。
threshold	number	啟動警示的臨界值。
windowSize	string	ISO 8601 持續時間格式 (期間) ，用來根據閾值監視警示活動。如果指定，則它必須介於 5 分鐘到 1 天之間。

ManagementEventRuleCondition

管理事件規則條件。

名稱	類型	Description
aggregation	ManagementEventAggregationCondition	收集的數據應該如何隨著時間結合，以及何時啟動警示。請注意，管理事件警示彙總是選用的 - 若未提供，則任何事件都會導致警示啟動。
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	規則從中收集數據的資源。針對此類型 dataSource，一律為 RuleMetricDataSource 類型。
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	會指定條件的類型。這可以是下列三種類型之一：ManagementEventRuleCondition () 、LocationThresholdRuleCondition (，根據 Web 測試) 的失敗數目，以及根據計量) 的臨界值來 (的 ThresholdRuleCondition。

RuleEmailAction

指定評估規則條件時要傳送電子郵件的動作。在此案例中，辨別子一律為 RuleEmailAction。

名稱	類型	Description
customEmails	string[]	系統管理員自定義電子郵件地址清單，以通知警示的啟用。
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	指定動作的類型。有兩種類型的動作：RuleEmailAction 和 RuleWebhookAction。
sendToServiceOwners	boolean	啟動警示時，是否應該通知服務的系統管理員 (服務和共同管理員)。

RuleManagementEventClaimsDataSource

規則管理事件數據源的宣告。

名稱	類型	Description
emailAddress	string	電子郵件位址。

RuleManagementEventDataSource

規則管理事件數據源。在此案例中，鑒別子字段一律為 RuleManagementEventDataSource。

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

名稱	類型	Description
legacyResourceId	string	規則所監視之資源的舊版資源標識符。注意：無法更新現有規則的這個屬性。
metricName	string	定義規則監視之計量的名稱。
metricNamespace	string	計量的命名空間。
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	指定數據源的類型。規則數據源有兩種類型：RuleMetricDataSource 和 RuleManagementEventDataSource
resourceLocation	string	資源的位置。
resourceUri	string	規則所監視之資源的資源標識碼。注意：無法更新現有規則的這個屬性。

RuleWebhookAction

指定要在評估規則條件時張貼至服務的動作。在此案例中，鑒別子一律為 RuleWebhookAction。

名稱	類型	Description
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	指定動作的類型。有兩種類型的動作：RuleEmailAction 和 RuleWebhookAction。
properties	object	要包含在post作業中的自訂屬性字典。這些數據會附加至 Webhook 承載。
serviceUri	string	當警示啟動或解決時，要張貼通知的服務 URI。

ThresholdRuleCondition

根據超出臨界值之計量的規則條件。

名稱	類型	Description
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	規則從中收集數據的資源。針對此類型 dataSource，一律為 RuleMetricDataSource 類型。
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	會指定條件的類型。這可以是下列三種類型之一：ManagementEventRuleCondition () 、LocationThresholdRuleCondition (，根據 Web 測試) 的失敗數目，以及根據計量) 的臨界值來 (的 ThresholdRuleCondition。
operator	ConditionOperator	用來比較數據和閾值的運算符。
threshold	number	啟動警示的臨界值。
timeAggregation	TimeAggregationOperator	時間匯總運算子。收集的數據應該如何隨著時間合併。預設值為 Metric 的 PrimaryAggregationType。
windowSize	string	ISO 8601 持續時間格式 (期間) ，用來根據閾值監視警示活動。如果指定，則它必須介於 5 分鐘到 1 天之間。

TimeAggregationOperator

規則中允許的匯總運算符。

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

Alert Rules - List By Subscription

URI 參數

回應

安全性

azure_auth

Scopes

範例

List alert rules

Sample Request

Sample Response

定義

AlertRuleResource

AlertRuleResourceCollection

ConditionOperator

ErrorResponse

LocationThresholdRuleCondition

ManagementEventAggregationCondition

ManagementEventRuleCondition

RuleEmailAction

RuleManagementEventClaimsDataSource

RuleManagementEventDataSource

RuleMetricDataSource

RuleWebhookAction

ThresholdRuleCondition

TimeAggregationOperator

其他資源