Alerts - Get Summary

リファレンス

サービス:: Monitor

API バージョン:: 2023-07-12-preview

さまざまなパラメーターでグループ化されたアラートの集計カウントを取得します (たとえば、"重大度" によるグループ化は、各重大度のアラートの数を返します)。

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&api-version=2023-07-12-preview

省略可能なパラメーターを含む:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	ここでのスコープは、アラートが作成される resourceId です。
api-version	query	True	string	この操作に使用する API バージョン。
groupby	query	True	AlertsSummaryGroupByFields	このパラメーターを使用すると、結果セットを入力フィールドでグループ化できます (最大 2 つのコンマ区切りフィールドがサポートされます)。たとえば、groupby=severity、groupby=severity、alertstate などです。
alertRule	query		string	特定のアラートルールでフィルター処理します。既定値は、すべて選択します。
alertState	query		AlertState	アラートインスタンスの状態でフィルター処理します。既定値は、すべて選択します。
customTimeRange	query		string	時間が (ISO-8601 形式) の形式でカスタム時間範囲でフィルター処理されます。許容される値は、クエリ時間から 30 日以内です。 timeRange または customTimeRange を使用できますが、両方を使用することはできません。既定値は none です。
includeSmartGroupsCount	query		boolean	概要の一部として SmartGroups の数を含めます。既定値は 'false' です。
monitorCondition	query		MonitorCondition	"発生" または "解決済み" のモニター条件でフィルター処理します。既定値は、すべて選択します。
monitorService	query		MonitorService	アラートインスタンスを生成するモニターサービスでフィルター処理します。既定値は [すべて選択] です。
severity	query		Severity	重要度でフィルター処理します。既定値は [すべて選択] です。
targetResource	query		string	ターゲットリソース (完全な ARM ID) でフィルター処理します。既定値はすべて選択されます。
targetResourceGroup	query		string	ターゲットリソースグループ名でフィルター処理します。既定値は [すべて選択] です。
targetResourceType	query		string	ターゲットリソースの種類でフィルター処理します。既定値は [すべて選択] です。
timeRange	query		TimeRange	次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

応答

名前	型	説明
200 OK	alertsSummary	OK です。アラートの概要が返されました。
Other Status Codes	errorResponse	操作に失敗した理由を説明するエラー応答。

例

Summary

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2023-07-12-preview

応答のサンプル

状態コード:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

定義

名前	説明
alertsSummary	入力フィルターと 'groupby' パラメーターに基づくアラートの概要。
alertsSummaryGroup	結果セットをグループ化します。
AlertsSummaryGroupByFields	このパラメーターを使用すると、結果セットを入力フィールドでグループ化できます (最大 2 つのコンマ区切りフィールドがサポートされます)。たとえば、groupby=severity、groupby=severity、alertstate などです。
alertsSummaryGroupItem	アラートの概要グループ項目
AlertState	ユーザーが変更できるアラートオブジェクトの状態。
errorResponse	サービスからのエラー応答。
errorResponseBody	エラー応答の詳細。
MonitorCondition	モニターサービスでのルールの条件。基になる条件が定義されたアラートルールのしきい値を超えたかどうかを表します。
MonitorService	ルール (モニター) が設定されているサービスを監視します。
Severity	アラート Sev0 が最も高く、Sev4 が最も低い重大度。
TimeRange	次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

alertsSummary

入力フィルターと 'groupby' パラメーターに基づくアラートの概要。

名前	型	説明
id	string	Azure リソース ID
name	string	Azure リソース名
properties	alertsSummaryGroup	結果セットをグループ化します。
type	string	Azure リソースタイプ

alertsSummaryGroup

結果セットをグループ化します。

名前	型	説明
groupedby	string	集計されたフィールドの名前
smartGroupsCount	integer	スマートグループの合計数。
total	integer	結果セットの合計数。
values	alertsSummaryGroupItem[]	項目の一覧

AlertsSummaryGroupByFields

このパラメーターを使用すると、結果セットを入力フィールドでグループ化できます (最大 2 つのコンマ区切りフィールドがサポートされます)。たとえば、groupby=severity、groupby=severity、alertstate などです。

名前	型	説明
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

アラートの概要グループ項目

名前	型	説明
count	integer	集計フィールドの数
groupedby	string	集計されたフィールドの名前
name	string	集計フィールドの値
values	alertsSummaryGroupItem[]	項目の一覧

AlertState

ユーザーが変更できるアラートオブジェクトの状態。

名前	型	説明
Acknowledged	string
Closed	string
New	string

errorResponse

サービスからのエラー応答。

名前	型	説明
error	errorResponseBody	エラー応答の詳細。

errorResponseBody

エラー応答の詳細。

名前	型	説明
code	string	プログラムで使用することを目的としたエラーコード。
details	errorResponseBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザーインターフェイスでの表示を目的としたエラーの説明。
target	string	プロパティの名前など、特定のエラーのターゲット。

MonitorCondition

モニターサービスでのルールの条件。基になる条件が定義されたアラートルールのしきい値を超えたかどうかを表します。

名前	型	説明
Fired	string
Resolved	string

MonitorService

ルール (モニター) が設定されているサービスを監視します。

名前	型	説明
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
Resource Health	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

Severity

アラート Sev0 が最も高く、Sev4 が最も低い重大度。

名前	型	説明
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

名前	型	説明
1d	string
1h	string
30d	string
7d	string

次の方法で共有