Alerts - Get All

Referensi

Layanan:: Monitor

Versi API:: 2023-07-12-preview

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=2023-07-12-preview

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
scope	path	True	string	cakupan di sini adalah resourceId yang pemberitahuannya dibuat.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.
alertRule	query		string	Filter menurut aturan pemberitahuan tertentu. Nilai defaultnya adalah memilih semua.
alertState	query		AlertState	Filter menurut status instans pemberitahuan. Nilai defaultnya adalah memilih semua.
customTimeRange	query		string	Filter menurut rentang waktu kustom dalam format / di mana waktu berada (format ISO-8601)'. Nilai yang diizinkan dalam waktu 30 hari dari 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		MonitorCondition	Filter menurut kondisi monitor yang 'Diaktifkan' atau 'Diselesaikan'. Nilai defaultnya adalah memilih semua.
monitorService	query		MonitorService	Filter menurut layanan monitor yang menghasilkan instans pemberitahuan. Nilai defaultnya adalah pilih semua.
pageCount	query		integer (int64)	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		Severity	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		AlertsSortByFields	Urutkan hasil kueri menurut bidang input, Nilai defaultnya adalah 'lastModifiedDateTime'.
sortOrder	query		SortOrder	Urutkan urutan hasil kueri dalam urutan naik atau turun. Nilai default adalah 'desc' untuk bidang waktu dan 'asc' untuk yang lain.
targetResource	query		string	Filter menurut sumber daya target( yang merupakan ID ARM penuh) 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		TimeRange	Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

Respons

Nama	Jenis	Deskripsi
200 OK	alertsList	OKE. Berhasil mencantumkan objek pemberitahuan.
Other Status Codes	errorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

ListAlerts

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
    }
  ]
}

Definisi

Nama	Deskripsi
actionStatus	Status tindakan
alert	Pemberitahuan yang dibuat di layanan manajemen pemberitahuan.
alertProperties	Tas properti pemberitahuan
alertsList	Mencantumkan pemberitahuan.
AlertsSortByFields	Urutkan hasil kueri menurut bidang input, Nilai defaultnya adalah 'lastModifiedDateTime'.
AlertState	Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.
errorResponse	Respons kesalahan dari layanan.
errorResponseBody	Detail respons kesalahan.
essentials	Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.
MonitorCondition	Kondisi aturan di layanan monitor. Ini mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
MonitorService	Memantau layanan 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.
SortOrder	Urutkan urutan hasil kueri dalam urutan naik atau turun. Nilai default adalah 'desc' untuk bidang waktu dan 'asc' untuk yang lain.
TimeRange	Filter menurut rentang waktu menurut nilai yang tercantum di bawah ini. Nilai defaultnya adalah 1 hari.

actionStatus

Objek

Status tindakan

Nama	Jenis	Deskripsi
isSuppressed	boolean	Nilai yang menunjukkan apakah pemberitahuan ditekan.

alert

Objek

Pemberitahuan yang dibuat di layanan manajemen pemberitahuan.

Nama	Jenis	Deskripsi
id	string	Id sumber daya Azure
name	string	Nama sumber daya Azure
properties	alertProperties	Tas properti pemberitahuan
type	string	Jenis sumber daya Azure

alertProperties

Objek

Tas properti pemberitahuan

Nama	Jenis	Deskripsi
context	object	Informasi khusus untuk layanan pemantauan yang memberikan detail kontekstual lebih lanjut tentang pemberitahuan.
egressConfig	object	Konfigurasi yang akan digunakan untuk menampilkan data di portal.
essentials	essentials	Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.

alertsList

Objek

Mencantumkan pemberitahuan.

Nama	Jenis	Deskripsi
nextLink	string	URL untuk mengambil serangkaian pemberitahuan berikutnya.
value	alert[]	Daftar pemberitahuan

AlertsSortByFields

Enumeration

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

Nilai	Deskripsi
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Enumeration

Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.

Nilai	Deskripsi
Acknowledged
Closed
New

errorResponse

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	errorResponseBody	Detail respons kesalahan.

errorResponseBody

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan, dimaksudkan untuk dikonsumsi secara terprogram.
details	errorResponseBody[]	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

Objek ini berisi bidang yang konsisten di berbagai layanan pemantauan.

Nama	Jenis	Deskripsi
actionStatus	actionStatus	Status tindakan
alertRule	string	Aturan(monitor) yang mengaktifkan instans pemberitahuan. Tergantung pada layanan monitor, ini akan menjadi id ARM atau nama aturan.
alertState	AlertState	Status objek pemberitahuan, yang dapat dimodifikasi oleh pengguna.
description	string	Deskripsi pemberitahuan.
lastModifiedDateTime	string (date-time)	Waktu modifikasi terakhir (format ISO-8601) instans pemberitahuan.
lastModifiedUserName	string	Pengguna yang terakhir memodifikasi pemberitahuan, jika pengguna pembaruan layanan monitor akan menjadi 'sistem', jika tidak, nama pengguna.
monitorCondition	MonitorCondition	Kondisi aturan di layanan monitor. Ini mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
monitorConditionResolvedDateTime	string (date-time)	Waktu yang diselesaikan (format ISO-8601) instans pemberitahuan. Ini akan diperbarui saat layanan pemantauan menyelesaikan instans pemberitahuan karena kondisi aturan tidak lagi terpenuhi.
monitorService	MonitorService	Memantau layanan tempat aturan (monitor) diatur.
severity	Severity	Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.
signalType	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 monitor, dalam kasus Nagios, Zabbix, SCOM dll.
startDateTime	string (date-time)	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 nama sumber daya ARM target, tempat pemberitahuan dibuat.
targetResourceType	string	Jenis sumber daya sumber daya ARM target, di mana pemberitahuan dibuat.

MonitorCondition

Enumeration

Kondisi aturan di layanan monitor. Ini mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.

Nilai	Deskripsi
Fired
Resolved

MonitorService

Enumeration

Memantau layanan tempat aturan (monitor) diatur.

Nilai	Deskripsi
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

Enumeration

Tingkat keparahan pemberitahuan Sev0 tertinggi dan Sev4 terendah.

Nilai	Deskripsi
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Enumeration

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

Nilai	Deskripsi
Log
Metric
Unknown

SortOrder

Enumeration

Urutkan urutan hasil kueri dalam urutan naik atau turun. Nilai default adalah 'desc' untuk bidang waktu dan 'asc' untuk yang lain.

Nilai	Deskripsi
asc
desc

TimeRange

Enumeration

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

Nilai	Deskripsi
1d
1h
30d
7d

Bagikan melalui

Alerts - Get All

Parameter URI

Respons

Contoh

ListAlerts

Permintaan sampel

Respon sampel

Definisi

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Sumber Daya Tambahan: