Alert Rules - Get

サービス:

Monitor

API バージョン:

2016-03-01

クラシック メトリック アラート ルールを取得します

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

URI パラメーター

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

応答

名前	型	説明
200 OK	AlertRuleResource	アラート ルールを取得する要求が成功しました
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

Get an alert rule

要求のサンプル

HTTP

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

Java

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

Go

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

JavaScript

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

dotnet

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/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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "b67f7fec-69fc-4974-9099-a26bd6ffeda3";
string resourceGroupName = "Rac46PostSwapRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AlertRuleResource
AlertRuleCollection collection = resourceGroupResource.GetAlertRules();

// invoke the operation
string ruleName = "chiricutin";
NullableResponse<AlertRuleResource> response = await collection.GetIfExistsAsync(ruleName);
AlertRuleResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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

応答のサンプル

状態コード:

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": []
  }
}

定義

名前	説明
AlertRuleResource	アラート ルール リソース。
ConditionOperator	ルール条件で使用できる演算子。
ErrorResponse	エラー応答の形式について説明します。
LocationThresholdRuleCondition	特定の場所の数に基づくルールの条件が失敗します。
ManagementEventAggregationCondition	収集されたデータの経時的な結合方法。
ManagementEventRuleCondition	管理イベント ルールの条件。
RuleEmailAction	ルール条件が評価されたときに電子メールを送信するアクションを指定します。 この場合、識別子は常に RuleEmailAction です。
RuleManagementEventClaimsDataSource	ルール管理イベント データ ソースの要求。
RuleManagementEventDataSource	ルール管理イベント データ ソース。 この場合、識別子フィールドは常に RuleManagementEventDataSource です。
RuleMetricDataSource	ルール メトリック データ ソース。 この場合、識別子の値は常に RuleMetricDataSource です。
RuleWebhookAction	ルールの条件が評価されたときにサービスに投稿するアクションを指定します。 この場合、識別子は常に RuleWebhookAction です。
ThresholdRuleCondition	しきい値を超えるメトリックに基づくルール条件。
TimeAggregationOperator	ルールで使用できる集計演算子。

AlertRuleResource

アラート ルール リソース。

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

ルール条件で使用できる演算子。

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

ErrorResponse

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

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

LocationThresholdRuleCondition

特定の場所の数に基づくルールの条件が失敗します。

名前	型	説明
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。
failedLocationCount	integer	アラートのアクティブ化に失敗する必要がある場所の数。
odata.type	string: Microsoft.Azure.Management.Insights.Models.LocationThresholdRuleCondition	は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。
windowSize	string	しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

ManagementEventAggregationCondition

収集されたデータの経時的な結合方法。

名前	型	説明
operator	ConditionOperator	条件演算子。
threshold	number	アラートを有効にするしきい値。
windowSize	string	しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

ManagementEventRuleCondition

管理イベント ルールの条件。

名前	型	説明
aggregation	ManagementEventAggregationCondition	収集されるデータを時間の経過とタイミングで組み合わせる方法と、アラートがアクティブ化されるタイミング。 管理イベントのアラートの集計は省略可能です。指定しない場合は、すべてのイベントによってアラートがアクティブ化されます。
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。
odata.type	string: Microsoft.Azure.Management.Insights.Models.ManagementEventRuleCondition	は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。

RuleEmailAction

ルール条件が評価されたときに電子メールを送信するアクションを指定します。 この場合、識別子は常に RuleEmailAction です。

名前	型	説明
customEmails	string[]	アラートのアクティブ化を通知する管理者のカスタム 電子メール アドレスの一覧。
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleEmailAction	は、アクションの種類を指定します。 アクションには、RuleEmailAction と RuleWebhookAction の 2 種類があります。
sendToServiceOwners	boolean	アラートがアクティブ化されたときにサービスの管理者 (サービスと共同管理者) に通知する必要があるかどうか。

RuleManagementEventClaimsDataSource

ルール管理イベント データ ソースの要求。

名前	型	説明
emailAddress	string	電子メール アドレス。

RuleManagementEventDataSource

ルール管理イベント データ ソース。 この場合、識別子フィールドは常に RuleManagementEventDataSource です。

名前	型	説明
claims	RuleManagementEventClaimsDataSource	クレーム。
eventName	string	イベント名。
eventSource	string	イベント ソース。
legacyResourceId	string	ルールが監視するリソースのレガシ リソース識別子。 注: このプロパティは、既存のルールに対して更新できません。
level	string	レベル。
metricNamespace	string	メトリックの名前空間。
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleManagementEventDataSource	は、データ ソースの種類を指定します。 ルール データ ソースには、RuleMetricDataSource と RuleManagementEventDataSource の 2 種類があります。
operationName	string	確認する必要がある操作の名前。 名前を指定しない場合は、すべての操作が一致します。
resourceGroupName	string	リソース グループ名。
resourceLocation	string	リソースの場所。
resourceProviderName	string	リソース プロバイダー名。
resourceUri	string	ルールが監視するリソースのリソース識別子。 注: このプロパティは、既存のルールに対して更新できません。
status	string	確認する必要がある操作の状態。 状態を指定しない場合は、すべての状態が一致します。
subStatus	string	サブステータス。

RuleMetricDataSource

ルール メトリック データ ソース。 この場合、識別子の値は常に RuleMetricDataSource です。

名前	型	説明
legacyResourceId	string	ルールが監視するリソースのレガシ リソース識別子。 注: このプロパティは、既存のルールに対して更新できません。
metricName	string	ルールが監視する内容を定義するメトリックの名前。
metricNamespace	string	メトリックの名前空間。
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleMetricDataSource	は、データ ソースの種類を指定します。 ルール データ ソースには、RuleMetricDataSource と RuleManagementEventDataSource の 2 種類があります。
resourceLocation	string	リソースの場所。
resourceUri	string	ルールが監視するリソースのリソース識別子。 注: このプロパティは、既存のルールに対して更新できません。

RuleWebhookAction

ルールの条件が評価されたときにサービスに投稿するアクションを指定します。 この場合、識別子は常に RuleWebhookAction です。

名前	型	説明
odata.type	string: Microsoft.Azure.Management.Insights.Models.RuleWebhookAction	は、アクションの種類を指定します。 アクションには、RuleEmailAction と RuleWebhookAction の 2 種類があります。
properties	object	post 操作に含めるカスタム プロパティのディクショナリ。 これらのデータは Webhook ペイロードに追加されます。
serviceUri	string	アラートがアクティブ化または解決されたときに通知を投稿するサービス URI。

ThresholdRuleCondition

しきい値を超えるメトリックに基づくルール条件。

名前	型	説明
dataSource	RuleDataSource: RuleManagementEventDataSource RuleMetricDataSource	ルールがデータを収集するリソース。 この型の場合、dataSource は常に RuleMetricDataSource 型になります。
odata.type	string: Microsoft.Azure.Management.Insights.Models.ThresholdRuleCondition	は条件の種類を指定します。 これは、ManagementEventRuleCondition (管理イベントの発生)、LocationThresholdRuleCondition (Web テストの失敗の数に基づく)、ThresholdRuleCondition (メトリックのしきい値に基づく) の 3 種類のいずれかです。
operator	ConditionOperator	データとしきい値の比較に使用される演算子。
threshold	number	アラートをアクティブにするしきい値。
timeAggregation	TimeAggregationOperator	時間集計演算子。 収集されるデータを時間の経過と同時に組み合わせる方法。 既定値は、メトリックの PrimaryAggregationType です。
windowSize	string	しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 指定する場合は、5 分から 1 日の間にする必要があります。

TimeAggregationOperator

ルールで使用できる集計演算子。

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