Alerts - Get All

リファレンス

サービス:: Monitor

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

複数のパラメーター (時間範囲など) に基づいて結果をフィルター処理できる、既存のすべてのアラートを一覧表示します。結果は、特定のフィールドに基づいて並べ替えることができます。既定値は lastModifiedDateTime です。

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

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

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&smartGroupId={smartGroupId}&includeContext={includeContext}&includeEgressConfig={includeEgressConfig}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&select={select}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	ここでのスコープは、アラートが作成される resourceId です。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
alertRule	query		string	特定のアラートルールでフィルター処理します。既定値は、すべて選択します。
alertState	query		AlertState	アラートインスタンスの状態でフィルター処理します。既定値は、すべて選択します。
customTimeRange	query		string	時刻が (ISO-8601 形式) の形式でカスタム時間範囲でフィルター処理されます。許容される値は、クエリ時間から 30 日以内です。 timeRange または customTimeRange を使用できますが、両方を使用することはできません。既定値は none です。
includeContext	query		boolean	モニターサービスに固有のコンテキストデータを持つコンテキストを含めます。既定値は false' です。
includeEgressConfig	query		boolean	ポータルでコンテンツを表示するために使用されるエグレス構成を含めます。既定値は 'false' です。
monitorCondition	query		MonitorCondition	"Fired" または "Resolved" のいずれかのモニター条件でフィルター処理します。既定値は、すべて選択します。
monitorService	query		MonitorService	アラートインスタンスを生成するモニターサービスでフィルター処理します。既定値は [すべて選択] です。
pageCount	query		integer (int64)	応答で 1 ページあたりに返されるアラートの数を決定します。許容値は 1 ~ 250 です。 "includeContent" フィルターが選択されている場合、許可される最大値は 25 です。既定値は 25 です。
select	query		string	このフィルターを使用すると、必須セクションの一部となるフィールド (コンマ区切り) を選択できます。これにより、コンテンツ全体を取得するのではなく、必要なフィールドのみを投影できます。既定値は、essentials セクションのすべてのフィールドをフェッチします。
severity	query		Severity	重大度でフィルター処理します。既定値は [すべて選択] です。
smartGroupId	query		string	スマートグループ ID でアラートの一覧をフィルター処理します。既定値は none です。
sortBy	query		AlertsSortByFields	入力フィールドでクエリ結果を並べ替えます。既定値は 'lastModifiedDateTime' です。
sortOrder	query		SortOrder	クエリ結果の順序を昇順または降順で並べ替えます。時刻フィールドの既定値は 'desc' で、それ以外の場合は 'asc' です。
targetResource	query		string	ターゲットリソース (完全な ARM ID) でフィルター処理します。既定値はすべて選択されます。
targetResourceGroup	query		string	ターゲットリソースグループ名でフィルター処理します。既定値は [すべて選択] です。
targetResourceType	query		string	ターゲットリソースの種類でフィルター処理します。既定値は [すべて選択] です。
timeRange	query		TimeRange	次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

応答

名前	型	説明
200 OK	alertsList	わかりました。アラートオブジェクトが正常に一覧表示されました。
Other Status Codes	errorResponse	操作が失敗した理由を説明するエラー応答。

例

ListAlerts

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "Acknowledged",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
          "targetResourceName": "servicedeskappinsight",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
          "smartGroupingReason": "Occurred frequently with other alerts",
          "alertRule": "https://servisdffsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    },
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "New",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus",
          "targetResourceName": "servicedeskwcus",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "d1c49c89-ea95-4697-a299-c0f5ebac62f1",
          "smartGroupingReason": "Alerts that frequently occur together have been grouped.",
          "alertRule": "https://servicsdfsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    }
  ]
}

定義

名前	説明
actionStatus	アクションの状態
alert	アラート管理サービスで作成されたアラート。
alertProperties	Alert プロパティバッグ
alertsList	アラートを一覧表示します。
AlertsSortByFields	入力フィールドでクエリ結果を並べ替えます。既定値は 'lastModifiedDateTime' です。
AlertState	アラートオブジェクトの状態。ユーザーが変更できます。
errorResponse	サービスからのエラー応答。
errorResponseBody	エラー応答の詳細。
essentials	このオブジェクトには、さまざまなモニターサービス間で一貫性のあるフィールドが含まれています。
MonitorCondition	監視サービスでのルールの条件。これは、基になる条件が定義されたアラートルールのしきい値を超えたかどうかを表します。
MonitorService	ルール (モニター) が設定されているサービスを監視します。
Severity	アラート Sev0 の重大度が最も高く、Sev4 が最も低い。
SignalType	アラートの基になるシグナルの種類 (メトリック、ログ、アクティビティログなど)。
SortOrder	クエリ結果の順序を昇順または降順で並べ替えます。時刻フィールドの既定値は 'desc' で、それ以外の場合は 'asc' です。
TimeRange	次の一覧の値で時間範囲でフィルター処理します。既定値は 1 日です。

actionStatus

Object

アクションの状態

名前	型	説明
isSuppressed	boolean	アラートが抑制されるかどうかを示す値。

alert

Object

アラート管理サービスで作成されたアラート。

名前	型	説明
id	string	Azure リソース ID
name	string	Azure リソース名
properties	alertProperties	Alert プロパティバッグ
type	string	Azure リソースの種類

alertProperties

Object

Alert プロパティバッグ

名前	型	説明
context	object	アラートに関するよりコンテキストに基づく詳細を提供する、監視サービスに固有の情報。
egressConfig	object	ポータルでデータを表示するために使用される構成。
essentials	essentials	このオブジェクトには、さまざまなモニターサービス間で一貫性のあるフィールドが含まれています。

alertsList

Object

アラートを一覧表示します。

名前	型	説明
nextLink	string	アラートの次のセットをフェッチする URL。
value	alert[]	アラートの一覧

AlertsSortByFields

列挙

入力フィールドでクエリ結果を並べ替えます。既定値は 'lastModifiedDateTime' です。

値	説明
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

列挙

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

値	説明
Acknowledged
Closed
New

errorResponse

Object

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

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

errorResponseBody

Object

エラー応答の詳細。

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

essentials

Object

このオブジェクトには、さまざまなモニターサービス間で一貫性のあるフィールドが含まれています。

名前	型	説明
actionStatus	actionStatus	アクションの状態
alertRule	string	アラートインスタンスが発生した Rule(monitor)。監視サービスに応じて、これは ARM ID または規則の名前になります。
alertState	AlertState	アラートオブジェクトの状態。ユーザーが変更できます。
description	string	アラートの説明。
lastModifiedDateTime	string (date-time)	アラートインスタンスの最終変更時刻 (ISO-8601 形式)。
lastModifiedUserName	string	監視サービスの更新の場合、アラートを最後に変更したユーザーは "system" になり、それ以外の場合はユーザーの名前になります。
monitorCondition	MonitorCondition	監視サービスでのルールの条件。これは、基になる条件が定義されたアラートルールのしきい値を超えたかどうかを表します。
monitorConditionResolvedDateTime	string (date-time)	アラートインスタンスの解決時刻 (ISO-8601 形式)。これは、ルールの条件が満たされなくなったため、モニターサービスがアラートインスタンスを解決したときに更新されます。
monitorService	MonitorService	ルール (モニター) が設定されているサービスを監視します。
severity	Severity	アラート Sev0 の重大度が最も高く、Sev4 が最も低い。
signalType	SignalType	アラートの基になるシグナルの種類 (メトリック、ログ、アクティビティログなど)。
smartGroupId	string	スマートグループの一意の ID
smartGroupingReason	string	このアラートインスタンスがスマートグループに追加される理由を説明する詳細な理由
sourceCreatedId	string	アラートインスタンスごとにモニターサービスによって作成された一意の ID。これは、Nagios、Zabbix、SCOM などの場合に、監視サービスで問題を追跡するために使用できます。
startDateTime	string (date-time)	アラートインスタンスの作成時間 (ISO-8601 形式)。
targetResource	string	アラートが作成されたターゲット ARM リソース。
targetResourceGroup	string	アラートが作成されたターゲット ARM リソースのリソースグループ。
targetResourceName	string	アラートが作成されたターゲット ARM リソース名の名前。
targetResourceType	string	アラートが作成されたターゲット ARM リソースのリソースの種類。

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

SignalType

列挙

アラートの基になるシグナルの種類 (メトリック、ログ、アクティビティログなど)。

値	説明
Log
Metric
Unknown

SortOrder

列挙

クエリ結果の順序を昇順または降順で並べ替えます。時刻フィールドの既定値は 'desc' で、それ以外の場合は 'asc' です。

値	説明
asc
desc

TimeRange

列挙

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

値	説明
1d
1h
30d
7d

次の方法で共有

Alerts - Get All

URI パラメーター

応答

例

ListAlerts

要求のサンプル

応答のサンプル

定義

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

その他のリソース