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 매개 변수

Name	In(다음 안에)	필수	형식	Description
scope	path	True	string	scope 경고가 생성되는 resourceId입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.
alertRule	query		string	특정 경고 규칙을 기준으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
alertState	query		AlertState	경고 instance 상태를 기준으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
customTimeRange	query		string	시간(ISO-8601 형식)의 형식/위치로 사용자 지정 시간 범위를 기준으로 필터링합니다. 허용되는 값은 쿼리 시간으로부터 30일 이내입니다. timeRange 또는 customTimeRange를 사용할 수 있지만 둘 다 사용할 수는 없습니다. 기본값은 none입니다.
includeContext	query		boolean	모니터 서비스와 관련된 컨텍스트 데이터가 있는 컨텍스트를 포함합니다. 기본값은 false'입니다.
includeEgressConfig	query		boolean	포털에서 콘텐츠를 표시하는 데 사용할 송신 구성을 포함합니다. 기본값은 'false'입니다.
monitorCondition	query		MonitorCondition	'발생' 또는 '해결됨'인 모니터 조건으로 필터링합니다. 기본값은 모두를 선택하는 것입니다.
monitorService	query		MonitorService	경고 instance 생성하는 모니터 서비스별로 필터링합니다. 기본값은 모두 선택입니다.
pageCount	query		integer int64	응답으로 페이지당 반환된 경고 수를 결정합니다. 허용되는 값은 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일입니다.

응답

Name	형식	Description
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"
    }
  ]
}

정의

Name	Description
actionStatus	작업 상태
alert	경고 관리 서비스에서 만든 경고입니다.
alertProperties	경고 속성 모음
alertsList	경고를 나열합니다.
AlertsSortByFields	입력 필드를 기준으로 쿼리 결과를 정렬합니다. 기본값은 'lastModifiedDateTime'입니다.
AlertState	사용자가 수정할 수 있는 경고 개체 상태입니다.
errorResponse	서비스의 오류 응답입니다.
errorResponseBody	오류 응답에 대한 세부 정보입니다.
essentials	이 개체는 여러 모니터 서비스에서 일관된 필드를 포함합니다.
MonitorCondition	모니터 서비스의 규칙 조건입니다. 기본 조건이 정의된 경고 규칙 임계값을 초과했는지 여부를 나타냅니다.
MonitorService	규칙(모니터)이 설정된 서비스를 모니터링합니다.
Severity	경고 Sev0의 심각도가 가장 높고 Sev4가 가장 낮습니다.
SignalType	경고가 기반으로 하는 신호 유형이며 메트릭, 로그 또는 활동 로그일 수 있습니다.
SortOrder	쿼리 결과 순서를 오름차순 또는 내림차순으로 정렬합니다. 기본값은 시간 필드의 경우 'desc'이고 다른 필드에는 'asc'입니다.
TimeRange	아래 나열된 값을 기준으로 시간 범위를 기준으로 필터링합니다. 기본값은 1일입니다.

actionStatus

작업 상태

Name	형식	Description
isSuppressed	boolean	경고가 표시되지 않는지 여부를 나타내는 값입니다.

alert

경고 관리 서비스에서 만든 경고입니다.

Name	형식	Description
id	string	Azure 리소스 ID
name	string	Azure 리소스 이름
properties	alertProperties	경고 속성 모음
type	string	Azure 리소스 종류

alertProperties

경고 속성 모음

Name	형식	Description
context	object	경고에 대한 자세한 상황별 세부 정보를 제공하는 모니터 서비스와 관련된 정보입니다.
egressConfig	object	포털에서 데이터를 표시하는 데 사용할 구성입니다.
essentials	essentials	이 개체는 여러 모니터 서비스에서 일관된 필드를 포함합니다.

alertsList

경고를 나열합니다.

Name	형식	Description
nextLink	string	다음 경고 집합을 가져오는 URL입니다.
value	alert[]	경고 목록

AlertsSortByFields

입력 필드를 기준으로 쿼리 결과를 정렬합니다. 기본값은 'lastModifiedDateTime'입니다.

Name	형식	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

AlertState

사용자가 수정할 수 있는 경고 개체 상태입니다.

Name	형식	Description
Acknowledged	string
Closed	string
New	string

errorResponse

서비스의 오류 응답입니다.

Name	형식	Description
error	errorResponseBody	오류 응답에 대한 세부 정보입니다.

errorResponseBody

오류 응답에 대한 세부 정보입니다.

Name	형식	Description
code	string	프로그래밍 방식으로 사용할 오류 코드입니다.
details	errorResponseBody[]	오류에 대한 추가 세부 정보 목록입니다.
message	string	사용자 인터페이스에 표시하기 위한 오류에 대한 설명입니다.
target	string	특정 오류의 대상(예: 속성 이름).

essentials

이 개체는 여러 모니터 서비스에서 일관된 필드를 포함합니다.

Name	형식	Description
actionStatus	actionStatus	작업 상태
alertRule	string	경고 instance 발생시킨 Rule(monitor) 모니터 서비스에 따라 ARM ID 또는 규칙 이름이 됩니다.
alertState	AlertState	사용자가 수정할 수 있는 경고 개체 상태입니다.
description	string	경고 설명.
lastModifiedDateTime	string	경고 instance 마지막 수정 시간(ISO-8601 형식)입니다.
lastModifiedUserName	string	모니터 서비스 업데이트의 경우 경고를 마지막으로 수정한 사용자는 '시스템'이고, 그렇지 않으면 사용자의 이름입니다.
monitorCondition	MonitorCondition	모니터 서비스의 규칙 조건입니다. 기본 조건이 정의된 경고 규칙 임계값을 초과했는지 여부를 나타냅니다.
monitorConditionResolvedDateTime	string	경고 instance 확인된 시간(ISO-8601 형식)입니다. 이는 규칙 조건이 더 이상 충족되지 않으므로 모니터 서비스가 경고 instance 확인할 때 업데이트됩니다.
monitorService	MonitorService	규칙(모니터)이 설정된 서비스를 모니터링합니다.
severity	Severity	경고 Sev0의 심각도가 가장 높고 Sev4가 가장 낮습니다.
signalType	SignalType	경고가 기반으로 하는 신호 유형이며 메트릭, 로그 또는 활동 로그일 수 있습니다.
smartGroupId	string	스마트 그룹의 고유 ID
smartGroupingReason	string	이 경고 instance 스마트 그룹에 추가된 이유를 설명하는 자세한 이유
sourceCreatedId	string	각 경고 instance 대한 모니터 서비스에서 만든 고유 ID입니다. Nagios, Zabbix, SCOM 등의 경우 모니터 서비스에서 문제를 추적하는 데 사용할 수 있습니다.
startDateTime	string	경고 instance 생성 시간(ISO-8601 형식)입니다.
targetResource	string	경고가 생성된 대상 ARM 리소스입니다.
targetResourceGroup	string	경고가 생성된 대상 ARM 리소스의 리소스 그룹입니다.
targetResourceName	string	경고가 생성된 대상 ARM 리소스 이름의 이름입니다.
targetResourceType	string	경고가 생성된 대상 ARM 리소스의 리소스 종류입니다.

MonitorCondition

모니터 서비스의 규칙 조건입니다. 기본 조건이 정의된 경고 규칙 임계값을 초과했는지 여부를 나타냅니다.

Name	형식	Description
Fired	string
Resolved	string

MonitorService

규칙(모니터)이 설정된 서비스를 모니터링합니다.

Name	형식	Description
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가 가장 낮습니다.

Name	형식	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

SignalType

경고가 기반으로 하는 신호 유형이며 메트릭, 로그 또는 활동 로그일 수 있습니다.

Name	형식	Description
Log	string
Metric	string
Unknown	string

SortOrder

쿼리 결과 순서를 오름차순 또는 내림차순으로 정렬합니다. 기본값은 시간 필드의 경우 'desc'이고 다른 필드에는 'asc'입니다.

Name	형식	Description
asc	string
desc	string

TimeRange

아래 나열된 값을 기준으로 시간 범위를 기준으로 필터링합니다. 기본값은 1일입니다.

Name	형식	Description
1d	string
1h	string
30d	string
7d	string