Alerts - Get All

リファレンス

Service:: Monitor

API Version:: 2023-07-12-preview

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

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

With optional parameters:

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	この操作に使用する 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	"発生済み" または "解決済み" のモニター条件でフィルター処理します。既定値は、すべて選択する場合です。
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	OK です。アラートオブジェクトが正常に一覧表示されました。
Other Status Codes	errorResponse	操作に失敗した理由を説明するエラー応答。

例

ListAlerts

Sample Request

HTTP

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

Sample Response

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

actionStatus

アクションの状態

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

alert

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

名前	型	説明
id	string	Azure リソース ID
name	string	Azure リソース名
properties	alertProperties	アラートプロパティバッグ
type	string	Azure リソースタイプ

alertProperties

アラートプロパティバッグ

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

alertsList

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

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

AlertsSortByFields

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

名前	型	説明
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

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

名前	型	説明
Acknowledged	string
Closed	string
New	string

errorResponse

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

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

errorResponseBody

エラー応答の詳細。

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

essentials

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

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

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

SignalType

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

名前	型	説明
Log	string
Metric	string
Unknown	string

SortOrder

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

名前	型	説明
asc	string
desc	string

TimeRange

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

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