Alerts - Get All

  • Referensi
Service:
Monitor
API Version:
2019-03-01

Cantumkan semua pemberitahuan yang ada, di mana hasilnya dapat difilter berdasarkan beberapa parameter (misalnya rentang waktu). Hasilnya kemudian dapat diurutkan berdasarkan bidang tertentu, dengan defaultnya adalah lastModifiedDateTime.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?api-version=2019-03-01
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=2019-03-01

Parameter URI

Name In Required Type Description
scope
 path True
  • string

cakupan di sini adalah resourceId yang pemberitahuannya dibuat.
api-version
 query True

Versi API.
alertRule
 query
  • string

Filter menurut aturan pemberitahuan tertentu. Nilai defaultnya adalah memilih semua.
alertState
 query

Filter menurut status instans pemberitahuan. Nilai defaultnya adalah memilih semua.
customTimeRange
 query
  • string

Filter menurut rentang waktu kustom dalam format / di mana waktu berada dalam (format ISO-8601)'. Nilai yang diizinkan dalam waktu 30 hari sejak waktu kueri. TimeRange atau customTimeRange dapat digunakan tetapi tidak keduanya. Defaultnya adalah tidak ada.
includeContext
 query
  • boolean

Sertakan konteks yang memiliki data kontekstual khusus untuk layanan pemantauan. Nilai defaultnya adalah false'
includeEgressConfig
 query
  • boolean

Sertakan konfigurasi keluar yang akan digunakan untuk menampilkan konten di portal. Nilai defaultnya adalah 'false'.
monitorCondition
 query

Filter menurut kondisi monitor yang 'Diaktifkan' atau 'Diselesaikan'. Nilai defaultnya adalah memilih semua.
monitorService
 query

Filter menurut layanan monitor yang menghasilkan instans pemberitahuan. Nilai defaultnya adalah pilih semua.
pageCount
 query
  • integer

Menentukan jumlah pemberitahuan yang dikembalikan per halaman sebagai respons. Nilai yang diizinkan adalah antara 1 hingga 250. Ketika filter "includeContent" dipilih, nilai maksimum yang diizinkan adalah 25. Nilai default adalah 25.
select
 query
  • string

Filter ini memungkinkan pemilihan bidang (dipisahkan koma) yang akan menjadi bagian penting. Ini akan memungkinkan untuk memproyeksikan hanya bidang yang diperlukan daripada mendapatkan seluruh konten. Defaultnya adalah mengambil semua bidang di bagian penting.
severity
 query

Filter menurut tingkat keparahan. Nilai defaultnya adalah pilih semua.
smartGroupId
 query
  • string

Filter daftar pemberitahuan menurut Id Grup Pintar. Nilai default tidak ada.
sortBy
 query

Urutkan hasil kueri menurut bidang input, Nilai defaultnya adalah 'lastModifiedDateTime'.
sortOrder
 query
  • string

Urutkan urutan hasil kueri dalam urutan naik atau turun. Nilai default adalah 'desc' untuk bidang waktu dan 'asc' untuk orang lain.
targetResource
 query
  • string

Filter menurut sumber daya target( yang merupakan ARM ID lengkap) Nilai default adalah pilih semua.
targetResourceGroup
 query
  • string

Filter menurut nama grup sumber daya target. Nilai defaultnya adalah pilih semua.
targetResourceType
 query
  • string

Filter menurut jenis sumber daya target. Nilai defaultnya adalah pilih semua.
timeRange
 query

Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

Respons

Name Type Description
200 OK

OK. Berhasil mencantumkan objek pemberitahuan.
Other Status Codes

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

ListAlerts

Sample Request

GET https://management.azure.com/subscriptions/3b540246-808d-4331-99aa-917b808a9166/providers/Microsoft.AlertsManagement/alerts?api-version=2019-03-01

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/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/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/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    }
  ]
}

Definisi

actionStatus

Status tindakan
alert

Pemberitahuan yang dibuat di layanan manajemen pemberitahuan.
alertProperties

Tas properti pemberitahuan
alertsList

Mencantumkan pemberitahuan.
AlertsManagementErrorResponse

Respons kesalahan dari layanan.
AlertsSortByFields

Urutkan hasil kueri menurut bidang input, Nilai defaultnya adalah 'lastModifiedDateTime'.
AlertState

Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.
api-version

Versi API.
errorResponseBody

Detail respons kesalahan.
essentials

Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.
MonitorCondition

Dapat berupa 'Diaktifkan' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
MonitorService

Layanan pemantauan tempat aturan (monitor) diatur.
Severity

Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.
SignalType

Jenis sinyal yang didasarkan pada pemberitahuan, yang bisa berupa metrik, log, atau log aktivitas.
TimeRange

Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

actionStatus

Status tindakan

Name Type Description
isSuppressed
  • boolean

Nilai yang menunjukkan apakah pemberitahuan ditekan.

alert

Pemberitahuan yang dibuat di layanan manajemen pemberitahuan.

Name Type Description
id
  • string

Id sumber daya Azure
name
  • string

Nama sumber daya Azure
properties

Tas properti pemberitahuan
type
  • string

Jenis sumber daya Azure

alertProperties

Tas properti pemberitahuan

Name Type Description
context
  • object

Informasi khusus untuk layanan monitor yang memberikan detail yang lebih kontekstual tentang pemberitahuan.
egressConfig
  • object

Konfigurasi yang akan digunakan untuk menampilkan data di portal.
essentials

Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.

alertsList

Mencantumkan pemberitahuan.

Name Type Description
nextLink
  • string

URL untuk mengambil kumpulan pemberitahuan berikutnya.
value

Daftar pemberitahuan

AlertsManagementErrorResponse

Respons kesalahan dari layanan.

Name Type Description
error

Detail respons kesalahan.

AlertsSortByFields

Urutkan hasil kueri menurut bidang input, Nilai defaultnya adalah 'lastModifiedDateTime'.

Name Type Description
alertState
  • string
lastModifiedDateTime
  • string
monitorCondition
  • string
name
  • string
severity
  • string
startDateTime
  • string
targetResource
  • string
targetResourceGroup
  • string
targetResourceName
  • string
targetResourceType
  • string

AlertState

Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.

Name Type Description
Acknowledged
  • string
Closed
  • string
New
  • string

api-version

Versi API.

Name Type Description
2018-05-05
  • string

errorResponseBody

Detail respons kesalahan.

Name Type Description
code
  • string

Kode kesalahan, dimaksudkan untuk dikonsumsi secara terprogram.
details

Daftar detail tambahan tentang kesalahan.
message
  • string

Deskripsi kesalahan, ditujukan untuk ditampilkan di antarmuka pengguna.
target
  • string

Target kesalahan tertentu, misalnya nama properti.

essentials

Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.

Name Type Description
actionStatus

Status tindakan
alertRule
  • string

Aturan(monitor) yang mengaktifkan instans pemberitahuan. Tergantung pada layanan monitor, ini akan menjadi id ARM atau nama aturan.
alertState

Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.
description
  • string

Deskripsi pemberitahuan.
lastModifiedDateTime
  • string

Waktu modifikasi terakhir (format ISO-8601) instans pemberitahuan.
lastModifiedUserName
  • string

Pengguna yang terakhir memodifikasi pemberitahuan, jika terjadi pembaruan layanan monitor, pengguna akan menjadi 'sistem', jika tidak, nama pengguna.
monitorCondition

Dapat berupa 'Diaktifkan' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
monitorConditionResolvedDateTime
  • string

Waktu yang diselesaikan (format ISO-8601) instans pemberitahuan. Ini akan diperbarui ketika layanan monitor menyelesaikan instans pemberitahuan karena kondisi aturan tidak lagi terpenuhi.
monitorService

Layanan pemantauan tempat aturan (monitor) diatur.
severity

Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.
signalType

Jenis sinyal yang didasarkan pada pemberitahuan, yang bisa berupa metrik, log, atau log aktivitas.
smartGroupId
  • string

Id unik grup pintar
smartGroupingReason
  • string

Alasan verbose yang menjelaskan alasan mengapa instans pemberitahuan ini ditambahkan ke grup cerdas
sourceCreatedId
  • string

Id unik yang dibuat oleh layanan monitor untuk setiap instans pemberitahuan. Ini dapat digunakan untuk melacak masalah di layanan pemantauan, dalam kasus Nagios, Zabbix, SCOM dll.
startDateTime
  • string

Waktu pembuatan (format ISO-8601) instans pemberitahuan.
targetResource
  • string

Sumber daya ARM target, di mana pemberitahuan dibuat.
targetResourceGroup
  • string

Grup sumber daya sumber daya ARM target, di mana pemberitahuan dibuat.
targetResourceName
  • string

Nama sumber daya ARM target, tempat pemberitahuan dibuat.
targetResourceType
  • string

Jenis sumber daya sumber daya ARM target, di mana pemberitahuan dibuat.

MonitorCondition

Dapat berupa 'Diaktifkan' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.

Name Type Description
Fired
  • string
Resolved
  • string

MonitorService

Layanan pemantauan tempat aturan (monitor) diatur.

Name Type 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

Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.

Name Type Description
Sev0
  • string
Sev1
  • string
Sev2
  • string
Sev3
  • string
Sev4
  • string

SignalType

Jenis sinyal yang didasarkan pada pemberitahuan, yang bisa berupa metrik, log, atau log aktivitas.

Name Type Description
Log
  • string
Metric
  • string
Unknown
  • string

TimeRange

Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

Name Type Description
1d
  • string
1h
  • string
30d
  • string
7d
  • string