Metric Alerts - List By Subscription

サービス:

Monitor

API バージョン:

2024-03-01-preview

サブスクリプション内でアラートルールの定義を取得してください。

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

URI パラメーター

名前	/	必須	型	説明
subscriptionId	path	True	string minLength: 1	ターゲット サブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	MetricAlertResourceCollection	Azureの運用は無事に完了しました。
Other Status Codes	MetricAlertErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

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

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

List metric alert rules

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "type": "Microsoft.Insights/metricAlerts",
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/highcpu",
      "location": "global",
      "properties": {
        "description": "This is the description of the rule1",
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ],
        "criteria": {
          "allOf": [
            {
              "name": "High_CPU_80",
              "criterionType": "StaticThresholdCriterion",
              "dimensions": [],
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "operator": "GreaterThan",
              "threshold": 80.5,
              "timeAggregation": "Average"
            }
          ],
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
        },
        "enabled": true,
        "evaluationFrequency": "PT1M",
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "severity": 3,
        "windowSize": "PT15M"
      },
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      }
    },
    {
      "type": "Microsoft.Insights/metricAlerts",
      "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/mediumcpu",
      "location": "global",
      "properties": {
        "description": "Med cpu alert",
        "actions": [
          {
            "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
            "webHookProperties": {
              "key11": "value11",
              "key12": "value12"
            }
          }
        ],
        "criteria": {
          "allOf": [
            {
              "name": "Medium_CPU_50",
              "criterionType": "StaticThresholdCriterion",
              "dimensions": [],
              "metricName": "CustomMetric_\\Processor(_Total)\\% Processor Time",
              "operator": "GreaterThan",
              "threshold": 50.5,
              "timeAggregation": "Average"
            }
          ],
          "odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
        },
        "enabled": true,
        "evaluationFrequency": "PT1M",
        "scopes": [
          "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
        ],
        "severity": 4,
        "windowSize": "PT15M"
      },
      "tags": {
        "hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
      }
    }
  ]
}

定義

名前	説明
AggregationTypeEnum	基準時間集計タイプ。 以前は文書化されていなかった値が返される可能性があります
createdByType	リソースを作成した ID の種類。
DynamicMetricCriteria	動的しきい値の基準。
DynamicPromQLCriteria	ダイナミックプロムの問い合わせの基準。
DynamicThresholdFailingPeriods	アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。
DynamicThresholdOperator	メトリック値をしきい値と比較するために使用される演算子。 以前は文書化されていなかった値が返される可能性があります
DynamicThresholdSensitivity	アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 以前は文書化されていなかった値が返される可能性があります
IdentityType	マネージド サービス ID の種類。
MetricAlertAction	アラートアクション。
MetricAlertErrorResponse	エラー応答の形式について説明します。
MetricAlertMultipleResourceMultipleMetricCriteria	複数の指標基準を持つ複数のリソースに対するメトリックアラート基準を指定します。
MetricAlertResource	メトリックアラートリソース。
MetricAlertResourceCollection	アラート ルール リソースのコレクションを表します。
MetricAlertSingleResourceMultipleMetricCriteria	複数のメトリック基準を持つ単一のリソースに対するメトリックアラート基準を指定します。
MetricCriteria	フィルター指標の基準。
MetricDimension	メートルの次元を指定します。
Microsoft.Common.ErrorDetail	エラー応答の詳細を記述します。
Microsoft.Common.ErrorDetailAdditionalInfoItem
Microsoft.Common.ErrorResponseError
Microsoft.Common.ErrorResponseErrorAdditionalInfoItem
Microsoft.Common.Identity	リソースの ID。
Microsoft.Common.UserIdentityProperties	ユーザー割り当てのアイデンティティのプロパティ。
Odatatype	アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
Operator	条件演算子。 以前は文書化されていなかった値が返される可能性があります
PromQLCriteria	メトリックアラートリソースのPromQL基準を指定します。
QueryFailingPeriods	クエリベースのアラートでの失敗期間の設定。
ResolveConfiguration
StaticPromQLCriteria	静的なプロムの問い合わせの基準。
systemData	リソースの作成と最後の変更に関連するメタデータ。
WebtestLocationAvailabilityCriteria	ウェブテストリソースのメトリックアラートルール基準を指定します。

AggregationTypeEnum

列挙

基準時間集計タイプ。 以前は文書化されていなかった値が返される可能性があります

値	説明
Average	Average
Count	数える
Minimum	最小値
Maximum	最大値
Total	合計

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DynamicMetricCriteria

Object

動的しきい値の基準。

名前	型	説明
alertSensitivity	DynamicThresholdSensitivity	アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 以前は文書化されていなかった値が返される可能性があります
criterionType	string: DynamicThresholdCriterion	しきい値基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
dimensions	MetricDimension[]	ディメンション条件の一覧。
failingPeriods	DynamicThresholdFailingPeriods	アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。
ignoreDataBefore	string (date-time)	このオプションを使用して、メトリック履歴データの学習を開始する日付を設定し、動的しきい値を (ISO8601形式で) 計算します。
metricName	string	メトリックの名前。
metricNamespace	string	メトリックのNamespace。
name	string	条件の名前。
operator	DynamicThresholdOperator	メトリック値をしきい値と比較するために使用される演算子。 以前は文書化されていなかった値が返される可能性があります
skipMetricValidation	boolean	メトリックの検証をスキップすることで、まだ出力されていないカスタム メトリックに対してアラート ルールを作成できるようにします。
timeAggregation	AggregationTypeEnum	基準時間集計タイプ。 以前は文書化されていなかった値が返される可能性があります

DynamicPromQLCriteria

Object

ダイナミックプロムの問い合わせの基準。

名前	型	説明
alertSensitivity	DynamicThresholdSensitivity	アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 以前は文書化されていなかった値が返される可能性があります
criterionType	string: DynamicThresholdCriterion	しきい値基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
ignoreDataBefore	string (date-time)	このオプションを使用して、メトリック履歴データの学習を開始する日付を設定し、動的しきい値を (ISO8601形式で) 計算します。
name	string	条件の名前。
operator	DynamicThresholdOperator	メトリック値をしきい値と比較するために使用される演算子。 以前は文書化されていなかった値が返される可能性があります
query	string	アラート ルールの評価に使用されるクエリ

DynamicThresholdFailingPeriods

Object

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

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

DynamicThresholdOperator

列挙

メトリック値をしきい値と比較するために使用される演算子。 以前は文書化されていなかった値が返される可能性があります

値	説明
GreaterThan	GreaterThan
LessThan	LessThan
GreaterOrLessThan	グレーター・オア・レスタン

DynamicThresholdSensitivity

列挙

アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 以前は文書化されていなかった値が返される可能性があります

値	説明
Low	低
Medium	Medium
High	High

IdentityType

列挙

マネージド サービス ID の種類。

値	説明
SystemAssigned	システム割り当て
UserAssigned	UserAssigned
None	None

MetricAlertAction

Object

アラートアクション。

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

MetricAlertErrorResponse

Object

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

名前	型	説明
error	Microsoft.Common.ErrorResponseError

MetricAlertMultipleResourceMultipleMetricCriteria

Object

複数の指標基準を持つ複数のリソースに対するメトリックアラート基準を指定します。

名前	型	説明
allOf	MultiMetricCriteria[]: DynamicMetricCriteria[] MetricCriteria[]	この「すべて」操作の複数のメトリック基準のリスト。
odata.type	string: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります

MetricAlertResource

Object

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

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Microsoft.Common.Identity	リソースの ID。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties.actionProperties	object	アクション プロパティのプロパティ。
properties.actions	MetricAlertAction[]	アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクションの配列。
properties.autoMitigate	boolean	アラートを自動解決するかどうかを示すフラグ。 既定値は true です。
properties.criteria	MetricAlertCriteria: MetricAlertMultipleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria PromQLCriteria WebtestLocationAvailabilityCriteria	特定のアラート基準情報を定義します。
properties.customProperties	object	アラート ペイロードのプロパティ。
properties.description	string	アラート メールに含まれるメトリック アラートの説明。
properties.enabled	boolean	メトリック・アラートが有効になっているかどうかを示すフラグ。
properties.evaluationFrequency	string (duration)	メトリック アラートが評価される頻度は、ISO 8601 期間形式で表されます。
properties.isMigrated	boolean	この値は、このアラートルールが移行されているかどうかを示します。
properties.lastUpdatedTime	string (date-time)	前回はルールがISO8601形式で更新されました。
properties.resolveConfiguration	ResolveConfiguration	アラートの解決方法の構成。 PromQLCriteriaに適用できます。
properties.scopes	string[]	このメトリック アラートのスコープが設定されるリソース ID の一覧。 ログに基づいてメトリック ルールのスコープを変更することはできません。
properties.severity	integer (int32)	アラートの重大度 {0、1、2、3、4}
properties.targetResourceRegion	string	アラートが作成/更新されるターゲット・リソースのリージョン。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。
properties.targetResourceType	string	アラートが作成/更新されるターゲット・リソースのリソース・タイプ。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。
properties.windowSize	string (duration)	しきい値に基づいてアラート・アクティビティーをモニターするために使用される期間 (ISO 8601 期間形式)。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

MetricAlertResourceCollection

Object

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

名前	型	説明
nextLink	string	次の結果セットを取得するための URL。
value	MetricAlertResource[]	アラートルールリソースの値。

MetricAlertSingleResourceMultipleMetricCriteria

Object

複数のメトリック基準を持つ単一のリソースに対するメトリックアラート基準を指定します。

名前	型	説明
allOf	MetricCriteria[]	この 'all of' 操作のメトリック条件の一覧。
odata.type	string: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります

MetricCriteria

Object

フィルター指標の基準。

名前	型	説明
criterionType	string: StaticThresholdCriterion	しきい値基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
dimensions	MetricDimension[]	ディメンション条件の一覧。
metricName	string	メトリックの名前。
metricNamespace	string	メトリックのNamespace。
name	string	条件の名前。
operator	Operator	条件演算子。 以前は文書化されていなかった値が返される可能性があります
skipMetricValidation	boolean	メトリックの検証をスキップすることで、まだ出力されていないカスタム メトリックに対してアラート ルールを作成できるようにします。
threshold	number (double)	アラートをアクティブにする条件のしきい値。
timeAggregation	AggregationTypeEnum	基準時間集計タイプ。 以前は文書化されていなかった値が返される可能性があります

MetricDimension

Object

メートルの次元を指定します。

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

Microsoft.Common.ErrorDetail

Object

エラー応答の詳細を記述します。

名前	型	説明
additionalInfo	Microsoft.Common.ErrorDetailAdditionalInfoItem[]	「型」と「情報」のプロパティを持つオブジェクトの配列です。 「info」のスキーマはサービスごとに異なり、「タイプ」文字列に依存します。
code	string	非局在化文字列で、エラーをプログラム的に識別するために使えます。
message	string	エラーの詳細を説明し、デバッグ情報を提供します。
target	string	特定のエラーのターゲット (たとえば、エラーのあるプロパティの名前)。

Microsoft.Common.ErrorDetailAdditionalInfoItem

Object

名前	型	説明
info		タイプに特有の追加情報。
type	string	追加情報の種類。

Microsoft.Common.ErrorResponseError

Object

名前	型	説明
additionalInfo	Microsoft.Common.ErrorResponseErrorAdditionalInfoItem[]	「型」と「情報」のプロパティを持つオブジェクトの配列です。 「info」のスキーマはサービスごとに異なり、「タイプ」文字列に依存します。
code	string	非局在化文字列で、エラーをプログラム的に識別するために使えます。
details	Microsoft.Common.ErrorDetail[]	このコントラクトで説明されているように、追加の入れ子になったエラー応答情報オブジェクトの配列。
message	string	エラーの詳細を説明し、デバッグ情報を提供します。 リクエストで Accept-Language が設定されている場合、その言語にローカライズされなければなりません。
target	string	特定のエラーのターゲット (たとえば、エラーのあるプロパティの名前)。

Microsoft.Common.ErrorResponseErrorAdditionalInfoItem

Object

名前	型	説明
info		タイプに特有の追加情報。
type	string	追加情報の種類。

Microsoft.Common.Identity

Object

リソースの ID。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	IdentityType	マネージド サービス ID の種類。
userAssignedIdentities	<string,  Microsoft.Common.UserIdentityProperties>	リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ のキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

Microsoft.Common.UserIdentityProperties

Object

ユーザー割り当てのアイデンティティのプロパティ。

名前	型	説明
clientId	string	リソース識別のクライアントID。
principalId	string	リソース ID のプリンシパル ID。

Odatatype

列挙

アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります

値	説明
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria	Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria	Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria
Microsoft.Azure.Monitor.PromQLCriteria	Microsoft.Azure.Monitor.PromQLCriteria

Operator

列挙

条件演算子。 以前は文書化されていなかった値が返される可能性があります

値	説明
Equals	等しい
GreaterThan	GreaterThan
GreaterThanOrEqual	GreaterThanOrEqual
LessThan	LessThan
LessThanOrEqual	LessThanOrEqual

PromQLCriteria

Object

メトリックアラートリソースのPromQL基準を指定します。

名前	型	説明
allOf	MultiPromQLCriteria[]: DynamicPromQLCriteria[] StaticPromQLCriteria[]	promQL 基準のリスト。 すべての条件が満たされるとアラートが発令されます。
failingPeriods	QueryFailingPeriods	クエリベースのアラートでの失敗期間の設定。
odata.type	string: Microsoft.Azure.Monitor.PromQLCriteria	アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります

QueryFailingPeriods

Object

クエリベースのアラートでの失敗期間の設定。

名前	型	説明
for	string (duration)	アラートが起動する前に、(ISO 8601 期間形式で)アクティブになっている必要があります。

ResolveConfiguration

Object

名前	型	説明
autoResolved	boolean	アラートを自動解決するかどうかを示します
timeToResolve	string (duration)	アラートが自動解決されるまでの時間 (ISO 8601 期間形式)

StaticPromQLCriteria

Object

静的なプロムの問い合わせの基準。

名前	型	説明
criterionType	string: StaticThresholdCriterion	しきい値基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
name	string	条件の名前。
query	string	アラート ルールの評価に使用されるクエリ

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

WebtestLocationAvailabilityCriteria

Object

ウェブテストリソースのメトリックアラートルール基準を指定します。

名前	型	説明
componentId	string	Application Insights リソース ID。
failedLocationCount	number (float)	失敗した場所の数。
odata.type	string: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria	アラート基準のタイプを指定します。 以前は文書化されていなかった値が返される可能性があります
webTestId	string	Application Insights Web テスト ID。