Alerts - Get All

Başvuru

Hizmet:: Monitor

API Sürümü:: 2023-07-12-preview

Sonuçların birden çok parametreye (örneğin zaman aralığı) göre filtrelenebileceği tüm mevcut uyarıları listeleyin. Ardından sonuçlar, varsayılan değer lastModifiedDateTime olacak şekilde belirli alanlara göre sıralanabilir.

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

İsteğe bağlı parametrelerle:

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
scope	path	True	string	buradaki kapsam, uyarının oluşturulduğu resourceId'dir.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.
alertRule	query		string	Belirli uyarı kuralına göre filtreleyin. Varsayılan değer tümünü seçmektir.
alertState	query		AlertState	Uyarı örneğinin durumuna göre filtreleyin. Varsayılan değer tümünü seçmektir.
customTimeRange	query		string	Özel zaman aralığına göre biçimine / nerede olduğuna göre filtreleyin (ISO-8601 biçiminde)'. İzin verilen değerler sorgu zamanından itibaren 30 gün içindedir. timeRange veya customTimeRange kullanılabilir ancak ikisi birden kullanılamaz. Varsayılan değer yok.
includeContext	query		boolean	İzleyici hizmetine özgü bağlamsal verilere sahip bağlamı dahil edin. Varsayılan değer false'
includeEgressConfig	query		boolean	İçeriği portalda görüntülemek için kullanılacak çıkış yapılandırmasını dahil edin. Varsayılan değer :'false'.
monitorCondition	query		MonitorCondition	'Tetiklendi' veya 'Çözüldü' olan izleme koşuluna göre filtreleyin. Varsayılan değer tümünü seçmektir.
monitorService	query		MonitorService	Uyarı örneğini oluşturan izleyici hizmetine göre filtreleyin. Varsayılan değer tümünü seç'tir.
pageCount	query		integer (int64)	Yanıt olarak sayfa başına döndürülen uyarı sayısını belirler. İzin verilen değer 1 ile 250 arasındadır. "includeContent" filtresi seçildiğinde, izin verilen en yüksek değer 25'tir. Varsayılan değer 25'tir.
select	query		string	Bu filtre, temel bölümün parçası olacak alanların (virgülle ayrılmış) seçilmesini sağlar. Bu, içeriğin tamamını almak yerine yalnızca gerekli alanları yansıtmaya olanak sağlar. Varsayılan değer temel bilgiler bölümündeki tüm alanları getirmektir.
severity	query		Severity	Önem derecesine göre filtreleyin. Varsayılan değer tümünü seç'tir.
smartGroupId	query		string	Uyarı listesini Akıllı Grup Kimliği'ne göre filtreleyin. Varsayılan değer yoktur.
sortBy	query		AlertsSortByFields	Sorgu sonuçlarını giriş alanına göre sıralayın; Varsayılan değer :'lastModifiedDateTime'.
sortOrder	query		SortOrder	Sorgu sonuçlarını artan veya azalan düzende sıralayın. Varsayılan değer, zaman alanları için 'desc' ve diğerleri için 'asc'dir.
targetResource	query		string	Hedef kaynağa göre filtrele (tam ARM kimliğidir) Varsayılan değer tümünü seçer.
targetResourceGroup	query		string	Hedef kaynak grubu adına göre filtreleyin. Varsayılan değer tümünü seç'tir.
targetResourceType	query		string	Hedef kaynak türüne göre filtreleyin. Varsayılan değer tümünü seç'tir.
timeRange	query		TimeRange	Aşağıdaki listelenen değerlere göre zaman aralığına göre filtreleyin. Varsayılan değer 1 gündür.

Yanıtlar

Name	Tür	Description
200 OK	alertsList	TAMAM. Uyarı nesneleri başarıyla listelendi.
Other Status Codes	errorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

ListAlerts

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
    }
  ]
}

Tanımlar

Name	Description
actionStatus	Eylem durumu
alert	Uyarı yönetim hizmetinde oluşturulan bir uyarı.
alertProperties	Uyarı özellik paketi
alertsList	Uyarıları listeleyin.
AlertsSortByFields	Sorgu sonuçlarını giriş alanına göre sıralayın; Varsayılan değer :'lastModifiedDateTime'.
AlertState	Kullanıcı tarafından değiştirilebilen uyarı nesnesi durumu.
errorResponse	Hizmetten bir hata yanıtı.
errorResponseBody	Hata yanıtının ayrıntıları.
essentials	Bu nesne, farklı monitör hizmetlerinde tutarlı alanlar içerir.
MonitorCondition	İzleyici hizmetindeki kuralın koşulu. Temel koşulların tanımlı uyarı kuralı eşiklerini geçip geçmediğini temsil eder.
MonitorService	Kuralın (izleyicinin) ayarlandığı hizmeti izleyin.
Severity	Önem derecesi uyarı Önem Derecesi0 en yüksek, Önem Derecesi4 ise en düşük.
SignalType	Uyarının temel aldığı sinyal türü; ölçümler, günlükler veya etkinlik günlükleri olabilir.
SortOrder	Sorgu sonuçlarını artan veya azalan düzende sıralayın. Varsayılan değer, zaman alanları için 'desc' ve diğerleri için 'asc'dir.
TimeRange	Aşağıdaki listelenen değerlere göre zaman aralığına göre filtreleyin. Varsayılan değer 1 gündür.

actionStatus

Object

Eylem durumu

Name	Tür	Description
isSuppressed	boolean	Uyarının gizlenip gizlenmediğini gösteren değer.

alert

Object

Uyarı yönetim hizmetinde oluşturulan bir uyarı.

Name	Tür	Description
id	string	Azure kaynak kimliği
name	string	Azure kaynak adı
properties	alertProperties	Uyarı özellik paketi
type	string	Azure kaynak türü

alertProperties

Object

Uyarı özellik paketi

Name	Tür	Description
context	object	Uyarı hakkında daha fazla bağlamsal ayrıntı sağlayan izleyici hizmetine özgü bilgiler.
egressConfig	object	Portalda verileri görüntülemek için kullanılacak yapılandırma.
essentials	essentials	Bu nesne, farklı monitör hizmetlerinde tutarlı alanlar içerir.

alertsList

Object

Uyarıları listeleyin.

Name	Tür	Description
nextLink	string	Sonraki uyarı kümesini getirmek için URL.
value	alert[]	Uyarıların listesi

AlertsSortByFields

Listeleme

Sorgu sonuçlarını giriş alanına göre sıralayın; Varsayılan değer :'lastModifiedDateTime'.

Değer	Description
alertState
lastModifiedDateTime
monitorCondition
name
severity
startDateTime
targetResource
targetResourceGroup
targetResourceName
targetResourceType

AlertState

Listeleme

Kullanıcı tarafından değiştirilebilen uyarı nesnesi durumu.

Değer	Description
Acknowledged
Closed
New

errorResponse

Object

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	errorResponseBody	Hata yanıtının ayrıntıları.

errorResponseBody

Object

Hata yanıtının ayrıntıları.

Name	Tür	Description
code	string	Program aracılığıyla kullanılması amaçlanan hata kodu.
details	errorResponseBody[]	Hatayla ilgili ek ayrıntıların listesi.
message	string	Kullanıcı arabiriminde görüntülenmesi amaçlanan hatanın açıklaması.
target	string	Belirli bir hatanın hedefi, örneğin özelliğin adı.

essentials

Object

Bu nesne, farklı monitör hizmetlerinde tutarlı alanlar içerir.

Name	Tür	Description
actionStatus	actionStatus	Eylem durumu
alertRule	string	Uyarı örneğini tetikleyen kural(izleyici). İzleme hizmetine bağlı olarak, bu ARM kimliği veya kuralın adı olabilir.
alertState	AlertState	Kullanıcı tarafından değiştirilebilen uyarı nesnesi durumu.
description	string	Uyarı açıklaması.
lastModifiedDateTime	string (date-time)	Uyarı örneğinin son değiştirme zamanı (ISO-8601 biçimi).
lastModifiedUserName	string	Uyarıyı son değiştiren kullanıcı, izleme hizmeti güncelleştirmeleri durumunda kullanıcı "sistem" olur, aksi takdirde kullanıcının adı olur.
monitorCondition	MonitorCondition	İzleyici hizmetindeki kuralın koşulu. Temel koşulların tanımlı uyarı kuralı eşiklerini geçip geçmediğini temsil eder.
monitorConditionResolvedDateTime	string (date-time)	Uyarı örneğinin çözümlenme zamanı (ISO-8601 biçimi). Kural koşulu artık karşılanmadığından, izleme hizmeti uyarı örneğini çözümlediğinde bu güncelleştirme yapılır.
monitorService	MonitorService	Kuralın (izleyicinin) ayarlandığı hizmeti izleyin.
severity	Severity	Önem derecesi uyarı Önem Derecesi0 en yüksek, Önem Derecesi4 ise en düşük.
signalType	SignalType	Uyarının temel aldığı sinyal türü; ölçümler, günlükler veya etkinlik günlükleri olabilir.
smartGroupId	string	Akıllı grubun benzersiz kimliği
smartGroupingReason	string	Bu uyarı örneğinin bir akıllı gruba eklenmesinin nedenini açıklayan ayrıntılı neden
sourceCreatedId	string	Her uyarı örneği için izleme hizmeti tarafından oluşturulan benzersiz kimlik. Bu, Nagios, Zabbix, SCOM vb. durumlarda monitör hizmetinde sorunu izlemek için kullanılabilir.
startDateTime	string (date-time)	Uyarı örneğinin oluşturma zamanı (ISO-8601 biçimi).
targetResource	string	Uyarının oluşturulduğu hedef ARM kaynağı.
targetResourceGroup	string	Uyarının oluşturulduğu hedef ARM kaynağı kaynak grubu.
targetResourceName	string	Uyarının oluşturulduğu hedef ARM kaynak adının adı.
targetResourceType	string	Uyarının oluşturulduğu hedef ARM kaynağının kaynak türü.

MonitorCondition

Listeleme

İzleyici hizmetindeki kuralın koşulu. Temel koşulların tanımlı uyarı kuralı eşiklerini geçip geçmediğini temsil eder.

Değer	Description
Fired
Resolved

MonitorService

Listeleme

Kuralın (izleyicinin) ayarlandığı hizmeti izleyin.

Değer	Description
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

Listeleme

Önem derecesi uyarı Önem Derecesi0 en yüksek, Önem Derecesi4 ise en düşük.

Değer	Description
Sev0
Sev1
Sev2
Sev3
Sev4

SignalType

Listeleme

Uyarının temel aldığı sinyal türü; ölçümler, günlükler veya etkinlik günlükleri olabilir.

Değer	Description
Log
Metric
Unknown

SortOrder

Listeleme

Sorgu sonuçlarını artan veya azalan düzende sıralayın. Varsayılan değer, zaman alanları için 'desc' ve diğerleri için 'asc'dir.

Değer	Description
asc
desc

TimeRange

Listeleme

Aşağıdaki listelenen değerlere göre zaman aralığına göre filtreleyin. Varsayılan değer 1 gündür.

Değer	Description
1d
1h
30d
7d

Aracılığıyla paylaş

Alerts - Get All

URI Parametreleri

Yanıtlar

Örnekler

ListAlerts

Örnek isteği

Örnek yanıt

Tanımlar

actionStatus

alert

alertProperties

alertsList

AlertsSortByFields

AlertState

errorResponse

errorResponseBody

essentials

MonitorCondition

MonitorService

Severity

SignalType

SortOrder

TimeRange

Ek kaynaklar