Alerts - Get By Id

Layanan:: Monitor

Versi API:: 2019-03-01

Dapatkan peringatan tertentu.
Dapatkan informasi yang terkait dengan pemberitahuan tertentu. Jika cakupan adalah sumber daya yang dihapus, gunakan cakupan sebagai sumber daya induk dari sumber daya yang dihapus. Misalnya, jika id pemberitahuan saya adalah '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' dan 'vm1' dihapus, maka jika Anda ingin mendapatkan pemberitahuan berdasarkan id, gunakan sumber daya induk cakupan. Jadi dalam contoh ini dapatkan peringatan dengan panggilan id akan terlihat seperti ini: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}?api-version=2019-03-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
alertId	path	True	string	ID unik dari instans pemberitahuan.
scope	path	True	string	cakupan di sini adalah resourceId yang pemberitahuannya dibuat.
api-version	query	True	api-version	Versi API.

Respons

Nama	Jenis	Deskripsi
200 OK	alert	OK. Mengembalikan pemberitahuan dengan ID yang ditentukan.
Other Status Codes	AlertsManagementErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

GetById

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100?api-version=2019-03-01

Respon sampel

Kode status:: 200

{
  "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://sersdfsdfinsight.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"
}

Definisi

Nama	Deskripsi
actionStatus	Status tindakan
alert	Pemberitahuan yang dibuat di layanan manajemen pemberitahuan.
alertProperties	Tas properti peringatan
AlertsManagementErrorResponse	Respons kesalahan dari layanan.
AlertState	Status objek peringatan, yang dapat dimodifikasi oleh pengguna.
api-version	Versi API.
errorResponseBody	Detail respons kesalahan.
essentials	Objek ini berisi bidang yang konsisten di berbagai layanan monitor.
MonitorCondition	Dapat berupa 'Dipecat' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
MonitorService	Memantau layanan tempat aturan(monitor) ditetapkan.
Severity	Tingkat keparahan peringatan Sev0 tertinggi dan Sev4 terendah.
SignalType	Jenis sinyal yang menjadi dasar peringatan, yang bisa berupa metrik, log, atau log aktivitas.

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 peringatan
type	string	Jenis sumber daya Azure

alertProperties

Objek

Tas properti peringatan

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

AlertsManagementErrorResponse

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	errorResponseBody	Detail respons kesalahan.

AlertState

Enumerasi

Status objek peringatan, yang dapat dimodifikasi oleh pengguna.

Nilai	Deskripsi
New
Acknowledged
Closed

api-version

Enumerasi

Versi API.

Nilai	Deskripsi
2019-03-01

errorResponseBody

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan, dimaksudkan untuk digunakan secara terprogram.
details	errorResponseBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Deskripsi kesalahan, dimaksudkan untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu, misalnya nama properti.

essentials

Objek

Objek ini berisi bidang yang konsisten di berbagai layanan monitor.

Nama	Jenis	Deskripsi
actionStatus	actionStatus	Status tindakan
alertRule	string	Rule(monitor) yang memicu instance peringatan. Tergantung pada layanan monitor, ini akan menjadi id ARM atau nama aturan.
alertState	AlertState	Status objek peringatan, yang dapat dimodifikasi oleh pengguna.
description	string	Deskripsi peringatan.
lastModifiedDateTime	string (date-time)	Waktu modifikasi terakhir (format ISO-8601) dari instans peringatan.
lastModifiedUserName	string	Pengguna yang terakhir memodifikasi peringatan, dalam hal memantau pembaruan layanan pengguna akan menjadi 'sistem', jika tidak, nama pengguna.
monitorCondition	MonitorCondition	Dapat berupa 'Dipecat' atau 'Diselesaikan', yang mewakili apakah kondisi yang mendasarinya telah melewati ambang batas aturan pemberitahuan yang ditentukan.
monitorConditionResolvedDateTime	string (date-time)	Waktu yang diselesaikan (format ISO-8601) instans peringatan. Ini akan diperbarui saat layanan monitor menyelesaikan instans pemberitahuan karena kondisi aturan tidak lagi terpenuhi.
monitorService	MonitorService	Memantau layanan tempat aturan(monitor) ditetapkan.
severity	Severity	Tingkat keparahan peringatan Sev0 tertinggi dan Sev4 terendah.
signalType	SignalType	Jenis sinyal yang menjadi dasar peringatan, yang bisa berupa metrik, log, atau log aktivitas.
smartGroupId	string	ID unik grup pintar
smartGroupingReason	string	Alasan bertele-tele yang menjelaskan alasan mengapa instans pemberitahuan ini ditambahkan ke grup pintar
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 peringatan.
targetResource	string	Target sumber daya ARM, 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

Enumerasi

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

Nilai	Deskripsi
Fired
Resolved

MonitorService

Enumerasi

Memantau layanan tempat aturan(monitor) ditetapkan.

Nilai	Deskripsi
Application Insights
ActivityLog Administrative
ActivityLog Security
ActivityLog Recommendation
ActivityLog Policy
ActivityLog Autoscale
Log Analytics
Nagios
Platform
SCOM
ServiceHealth
SmartDetector
VM Insights
Zabbix
Resource Health

Severity

Enumerasi

Tingkat keparahan peringatan Sev0 tertinggi dan Sev4 terendah.

Nilai	Deskripsi
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Enumerasi

Jenis sinyal yang menjadi dasar peringatan, yang bisa berupa metrik, log, atau log aktivitas.

Nilai	Deskripsi
Metric
Log
Unknown

Bagikan melalui

Alerts - Get By Id

Parameter URI

Respons

Contoh

GetById

Permintaan sampel

Respon sampel

Definisi

actionStatus

alert

alertProperties

AlertsManagementErrorResponse

AlertState

api-version

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType