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 minLength: 1	この操作に使用する 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	概要の一部として SmartGroup の数を含めます。既定値は 'false' です。
monitorCondition	query		MonitorCondition	"Fired" または "Resolved" のいずれかのモニター条件でフィルター処理します。既定値は、すべて選択します。
monitorService	query		MonitorService	アラートインスタンスを生成するモニターサービスでフィルター処理します。既定値は [すべて選択] です。
severity	query		Severity	重大度でフィルター処理します。既定値は [すべて選択] です。
targetResource	query		string	ターゲットリソース (完全な ARM ID) でフィルター処理します。既定値はすべて選択されます。
targetResourceGroup	query		string	ターゲットリソースグループ名でフィルター処理します。既定値は [すべて選択] です。
targetResourceType	query		string	ターゲットリソースの種類でフィルター処理します。既定値は [すべて選択] です。
timeRange	query		TimeRange	次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

応答

名前	型	説明
200 OK	alertsSummary	わかりました。アラートの概要が返されました。
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

Object

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

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

alertsSummaryGroup

Object

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

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

AlertsSummaryGroupByFields

列挙

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

値	説明
alertRule
alertState
monitorCondition
monitorService
severity
signalType

alertsSummaryGroupItem

Object

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

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

AlertState

列挙

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

値	説明
Acknowledged
Closed
New

errorResponse

Object

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

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

errorResponseBody

Object

エラー応答の詳細。

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

MonitorCondition

列挙

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

値	説明
Fired
Resolved

MonitorService

列挙

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

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

Severity

列挙

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

値	説明
Sev0
Sev1
Sev2
Sev3
Sev4

TimeRange

列挙

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

値	説明
1d
1h
30d
7d

次の方法で共有

Alerts - Get Summary

URI パラメーター

応答

例

Summary

要求のサンプル

応答のサンプル

定義

alertsSummary

alertsSummaryGroup

AlertsSummaryGroupByFields

alertsSummaryGroupItem

AlertState

errorResponse

errorResponseBody

MonitorCondition

MonitorService

Severity

TimeRange

その他のリソース