Skema pemberitahuan umum

Artikel
02/21/2024

Skema pemberitahuan umum menstandarkan konsumsi pemberitahuan pemberitahuan Azure Monitor. Secara historis, pemberitahuan log aktivitas, metrik, dan pencarian log masing-masing memiliki templat email dan skema webhook mereka sendiri. Skema pemberitahuan umum menyediakan satu skema standar untuk semua pemberitahuan pemberitahuan.

Menggunakan skema standar membantu meminimalkan jumlah integrasi, yang menyederhanakan proses pengelolaan dan pemeliharaan integrasi Anda. Skema umum memungkinkan pengalaman konsumsi pemberitahuan yang lebih kaya di portal Azure dan aplikasi seluler Azure.

Skema pemberitahuan umum menyediakan struktur yang konsisten untuk:

Templat email: Gunakan templat email terperinci untuk mendiagnosis masalah secara sekilas. Tautan yang disematkan ke instans pemberitahuan di portal dan ke sumber daya yang terpengaruh memastikan bahwa Anda dapat dengan cepat melompat ke proses remediasi.
Struktur JSON: Gunakan struktur JSON yang konsisten untuk membangun integrasi untuk semua jenis pemberitahuan menggunakan:
- Azure Logic Apps
- Azure Functions
- Runbook Azure Automation

Catatan

Pemberitahuan yang dihasilkan oleh wawasan VM tidak mendukung skema umum.
Pemberitahuan deteksi pintar menggunakan skema umum secara default. Anda tidak perlu mengaktifkan skema umum untuk pemberitahuan deteksi pintar.

Struktur skema umum

Skema umum mencakup informasi tentang sumber daya yang terpengaruh dan penyebab pemberitahuan di bagian ini:

Esensial: Bidang standar, digunakan oleh semua jenis pemberitahuan yang menjelaskan sumber daya yang terpengaruh oleh metadata pemberitahuan dan pemberitahuan umum, seperti tingkat keparahan atau deskripsi.

Jika Anda ingin merutekan instans pemberitahuan ke tim tertentu berdasarkan kriteria seperti grup sumber daya, Anda dapat menggunakan bidang di bagian Esensial untuk menyediakan logika perutean untuk semua jenis pemberitahuan. Tim yang menerima pemberitahuan pemberitahuan kemudian dapat menggunakan bidang konteks untuk penyelidikan mereka.
Konteks pemberitahuan: Bidang yang bervariasi tergantung pada jenis pemberitahuan. Bidang konteks pemberitahuan menjelaskan penyebab pemberitahuan. Misalnya, peringatan metrik akan memiliki bidang seperti nama metrik dan nilai metrik dalam konteks peringatan. Peringatan log aktivitas akan memiliki informasi mengenai peristiwa yang menghasilkan peringatan tersebut.
Properti kustom: Informasi tambahan yang tidak disertakan dalam payload pemberitahuan secara default dapat disertakan dalam payload pemberitahuan menggunakan properti kustom. Properti kustom adalah pasangan Kunci:Nilai yang dapat menyertakan informasi apa pun yang dikonfigurasi dalam aturan pemberitahuan.

Contoh payload pemberitahuan

{
  "schemaId": "azureMonitorCommonAlertSchema",
  "data": {
    "essentials": {
      "alertId": "/subscriptions/<subscription ID>/providers/Microsoft.AlertsManagement/alerts/b9569717-bc32-442f-add5-83a997729330",
      "alertRule": "WCUS-R2-Gen2",
      "severity": "Sev3",
      "signalType": "Metric",
      "monitorCondition": "Resolved",
      "monitoringService": "Platform",
      "alertTargetIDs": [
        "/subscriptions/<subscription ID>/resourcegroups/pipelinealertrg/providers/microsoft.compute/virtualmachines/wcus-r2-gen2"
      ],
      "configurationItems": [
        "wcus-r2-gen2"
      ],
      "originAlertId": "3f2d4487-b0fc-4125-8bd5-7ad17384221e_PipeLineAlertRG_microsoft.insights_metricAlerts_WCUS-R2-Gen2_-117781227",
      "firedDateTime": "2019-03-22T13:58:24.3713213Z",
      "resolvedDateTime": "2019-03-22T14:03:16.2246313Z",
      "description": "",
      "essentialsVersion": "1.0",
      "alertContextVersion": "1.0"
    },
    "alertContext": {
      "properties": null,
      "conditionType": "SingleResourceMultipleMetricCriteria",
      "condition": {
        "windowSize": "PT5M",
        "allOf": [
          {
            "metricName": "Percentage CPU",
            "metricNamespace": "Microsoft.Compute/virtualMachines",
            "operator": "GreaterThan",
            "threshold": "25",
            "timeAggregation": "Average",
            "dimensions": [
              {
                "name": "ResourceId",
                "value": "3efad9dc-3d50-4eac-9c87-8b3fd6f97e4e"
              }
            ],
            "metricValue": 7.727
          }
        ]
      }
    },
    "customProperties": {
      "Key1": "Value1",
      "Key2": "Value2"
    }
  }
}

Untuk contoh pemberitahuan yang menggunakan skema umum, lihat Contoh payload pemberitahuan.

Bidang esensial

Bidang	Deskripsi
alertId	ID sumber daya unik yang mengidentifikasi instans pemberitahuan.
alertRule	Nama aturan pemberitahuan yang menghasilkan instans pemberitahuan.
Tingkat keparahan	Tingkat keseriusan pemberitahuan. Nilai yang mungkin adalah Sev0, Sev1, Sev2, Sev3, atau Sev4.
signalType	Mengidentifikasi sinyal tempat aturan pemberitahuan ditentukan. Nilai yang mungkin adalah Metrik, Log, atau Log Aktivitas.
monitorCondition	Saat pemberitahuan dipicu, kondisi monitor pemberitahuan diatur ke Dipicu. Saat kondisi yang mendasarinya yang menyebabkan pemberitahuan terpicu api dibersihkan, kondisi monitor diatur ke Selesai.
monitoringService	Layanan atau solusi pemantauan yang menghasilkan pemberitahuan. Layanan pemantauan menentukan bidang mana yang berada dalam konteks pemberitahuan.
alertTargetIDs	Daftar ID Azure Resource Manager yang menjadi target pemberitahuan yang terpengaruh. Untuk pemberitahuan pencarian log yang ditentukan pada ruang kerja Log Analytics atau instans Application Insights, ini adalah ruang kerja atau aplikasi masing-masing.
configurationItems	Daftar sumber daya yang terpengaruh dari pemberitahuan. Dalam beberapa kasus, item konfigurasi dapat berbeda dari target pemberitahuan. Misalnya, dalam pemberitahuan pencarian metrik-untuk-log atau log yang ditentukan pada ruang kerja Log Analytics, item konfigurasi adalah sumber daya aktual yang mengirim data, dan bukan ruang kerja. Dalam API pemberitahuan pencarian log (Aturan Kueri Terjadwal) v2021-08-01, `configurationItem` nilai diambil dari dimensi yang ditentukan secara eksplisit dalam prioritas ini: `_ResourceId`, , `ResourceIdResource`, `Computer`. Dalam versi SEBELUMNYA dari API pemberitahuan pencarian log, `configurationItem` nilai diambil secara implisit dari hasil dalam prioritas ini: `_ResourceId`, , `ResourceIdResource`, `Computer`. Dalam sistem ITSM, `configurationItems` bidang digunakan untuk menghubungkan pemberitahuan dengan sumber daya dalam database manajemen konfigurasi.
originAlertId	ID instans pemberitahuan, seperti yang dihasilkan oleh layanan pemantauan yang menghasilkannya.
firedDateTime	Tanggal dan waktu saat instans pemberitahuan dipicu dalam Waktu Universal Terkoordinasi (UTC).
resolvedDateTime	Tanggal dan waktu ketika kondisi monitor untuk instans pemberitahuan diatur ke Selasai dalam UTC. Saat ini hanya berlaku untuk pemberitahuan metrik.
description	Deskripsi, seperti yang ditentukan dalam aturan pemberitahuan.
essentialsVersion	Nomor versi untuk bagian esensial.
alertContextVersion	Nomor versi untuk bagian `alertContext`.

Bidang konteks pemberitahuan untuk pemberitahuan metrik

Bidang	Deskripsi
properti	(Opsional.) Kumpulan properti yang ditentukan pelanggan.
conditionType	Jenis kondisi yang dipilih untuk aturan pemberitahuan: - ambang statis - ambang batas dinamis - webtest
kondisi
windowSize	Periode waktu yang dianalisis oleh aturan pemberitahuan.
allOf	Menunjukkan bahwa semua kondisi yang ditentukan dalam aturan pemberitahuan harus dipenuhi untuk memicu pemberitahuan.
alertSensitivity	Dalam aturan pemberitahuan dengan ambang batas dinamis, menunjukkan seberapa sensitif aturan, atau berapa banyak nilai yang dapat menyimpang dari ambang batas atas atau bawah.
failingPeriods	Dalam aturan pemberitahuan dengan ambang batas dinamis, jumlah periode evaluasi yang tidak memenuhi ambang pemberitahuan yang memicu pemberitahuan. Misalnya, Anda dapat menunjukkan bahwa pemberitahuan dipicu ketika 3 dari lima periode evaluasi terakhir tidak berada dalam ambang batas pemberitahuan.
numberOfEvaluationPeriods	Jumlah total evaluasi.
minFailingPeriodsToAlert	Jumlah minimum evaluasi yang tidak memenuhi kondisi aturan pemberitahuan.
ignoreDataBefore	(Opsional.) Dalam aturan pemberitahuan dengan ambang batas dinamis, tanggal dari mana ambang batas dihitung. Gunakan nilai ini untuk menunjukkan bahwa aturan tidak boleh menghitung ambang batas dinamis menggunakan data dari sebelum tanggal yang ditentukan.
metricName	Nama metrik yang dipantau oleh aturan pemberitahuan.
metricNamespace	Namespace metrik yang dipantau oleh aturan pemberitahuan.
operator	Operator logis aturan pemberitahuan.
ambang	Ambang batas yang ditentukan dalam aturan pemberitahuan. Untuk aturan pemberitahuan dengan ambang batas dinamis, nilai ini adalah ambang batas terhitung.
timeAggregation	Jenis agregasi aturan pemberitahuan.
ukuran	Dimensi metrik yang memicu pemberitahuan.
nama	Nama dimensi.
value	Nilai dimensi.
metricValue	Nilai metrik pada saat melanggar ambang batas.
webTestName	Jika jenis kondisi adalah `webtest`, nama webtest.
windowStartTime	Waktu mulai jendela evaluasi tempat pemberitahuan diaktifkan.
windowEndTime	Waktu akhir jendela evaluasi tempat pemberitahuan diaktifkan.

Contoh pemberitahuan metrik dengan ambang statis saat monitoringService = `Platform`

{
  "alertContext": {
      "properties": null,
      "conditionType": "SingleResourceMultipleMetricCriteria",
      "condition": {
        "windowSize": "PT5M",
        "allOf": [
          {
            "metricName": "Percentage CPU",
            "metricNamespace": "Microsoft.Compute/virtualMachines",
            "operator": "GreaterThan",
            "threshold": "25",
            "timeAggregation": "Average",
            "dimensions": [
              {
                "name": "ResourceId",
                "value": "3efad9dc-3d50-4eac-9c87-8b3fd6f97e4e"
              }
            ],
            "metricValue": 31.1105
          }
        ],
        "windowStartTime": "2019-03-22T13:40:03.064Z",
        "windowEndTime": "2019-03-22T13:45:03.064Z"
      }
    }
}

Contoh pemberitahuan metrik dengan ambang batas dinamis saat monitoringService = `Platform`

{
  "alertContext": {
      "properties": null,
      "conditionType": "DynamicThresholdCriteria",
      "condition": {
        "windowSize": "PT5M",
        "allOf": [
          {
            "alertSensitivity": "High",
            "failingPeriods": {
              "numberOfEvaluationPeriods": 1,
              "minFailingPeriodsToAlert": 1
            },
            "ignoreDataBefore": null,
            "metricName": "Egress",
            "metricNamespace": "microsoft.storage/storageaccounts",
            "operator": "GreaterThan",
            "threshold": "47658",
            "timeAggregation": "Total",
            "dimensions": [],
            "metricValue": 50101
          }
        ],
        "windowStartTime": "2021-07-20T05:07:26.363Z",
        "windowEndTime": "2021-07-20T05:12:26.363Z"
      }
    }
}

Contoh pemberitahuan metrik untuk pengujian ketersediaan saat monitoringService = `Platform`

{
  "alertContext": {
      "properties": null,
      "conditionType": "WebtestLocationAvailabilityCriteria",
      "condition": {
        "windowSize": "PT5M",
        "allOf": [
          {
            "metricName": "Failed Location",
            "metricNamespace": null,
            "operator": "GreaterThan",
            "threshold": "2",
            "timeAggregation": "Sum",
            "dimensions": [],
            "metricValue": 5,
            "webTestName": "myAvailabilityTest-myApplication"
          }
        ],
        "windowStartTime": "2019-03-22T13:40:03.064Z",
        "windowEndTime": "2019-03-22T13:45:03.064Z"
      }
    }
}

Bidang konteks pemberitahuan untuk pemberitahuan pencarian log

Catatan

Saat Anda mengaktifkan skema umum, bidang dalam payload diatur ulang ke bidang skema umum. Oleh karena itu, pemberitahuan pencarian log memiliki batasan ini mengenai skema umum:

Skema umum tidak didukung untuk pemberitahuan pencarian log menggunakan webhook dengan subjek email kustom dan/atau payload JSON, karena skema umum menimpa konfigurasi kustom.
Pemberitahuan yang menggunakan skema umum memiliki batas ukuran atas 256 KB per pemberitahuan. Jika payload pemberitahuan pencarian log menyertakan hasil pencarian yang menyebabkan pemberitahuan melebihi ukuran maksimum, hasil pencarian tidak disematkan dalam payload pemberitahuan pencarian log. Anda dapat memeriksa apakah payload menyertakan hasil pencarian dengan IncludedSearchResults bendera . Gunakan LinkToFilteredSearchResultsAPI atau LinkToSearchResultsAPI untuk mengakses hasil kueri dengan LOG Analytics API jika hasil pencarian tidak disertakan.

Bidang	Deskripsi
SearchQuery	Kueri yang ditentukan dalam aturan pemberitahuan.
SearchIntervalStartTimeUtc	Waktu mulai jendela evaluasi di mana pemberitahuan diaktifkan di UTC.
SearchIntervalEndTimeUtc	Waktu akhir jendela evaluasi tempat pemberitahuan diaktifkan di UTC.
ResultCount	Jumlah rekaman yang dikembalikan oleh kueri. Untuk aturan pengukuran metrik, angka atau rekaman yang cocok dengan kombinasi dimensi tertentu.
LinkToSearchResults	Tautan ke hasil pencarian.
LinkToFilteredSearchResultsUI	Untuk aturan pengukuran metrik, tautan ke hasil pencarian setelah difilter berdasarkan kombinasi dimensi.
LinkToSearchResultsAPI	Tautan ke hasil kueri menggunakan API Analitik Log.
LinkToFilteredSearchResultsAPI	Untuk aturan pengukuran metrik, tautan ke hasil pencarian menggunakan API Analitik Log setelah difilter berdasarkan kombinasi dimensi.
SearchIntervalDurationMin	Jumlah total menit dalam interval pencarian.
SearchIntervalInMin	Jumlah total menit dalam interval pencarian.
Ambang	Ambang batas yang ditentukan dalam aturan pemberitahuan.
Operator	Operator yang ditentukan dalam aturan pemberitahuan.
ApplicationID	ID Application Insights tempat pemberitahuan dipicu.
Dimensi	Untuk aturan pengukuran metrik, dimensi metrik tempat pemberitahuan dipicu.
nama	Nama dimensi.
value	Nilai dimensi.
SearchResults	Hasil pencarian lengkap.
tabel	Tabel hasil dalam hasil pencarian.
nama	Nama tabel dalam hasil pencarian.
columns	Kolom dalam tabel.
nama	Nama kolom.
jenis	Jenis kolom.
baris	Baris dalam tabel.
DataSources	Sumber data tempat pemberitahuan dipicu.
resourceID	ID sumber daya yang terpengaruh oleh pemberitahuan.
tabel	Tabel respons draf yang disertakan dalam kueri.
IncludedSearchResults	Bendera yang menunjukkan apakah payload harus berisi hasilnya.
AlertType	Jenis pemberitahuan: - Pengukuran Metrik - Jumlah hasil

Contoh pemberitahuan pencarian log saat monitoringService = Log Analytics

{
  "alertContext": {
    "SearchQuery": "Perf | where ObjectName == \"Processor\" and CounterName == \"% Processor Time\" | summarize AggregatedValue = avg(CounterValue) by bin(TimeGenerated, 5m), Computer",
    "SearchIntervalStartTimeUtc": "3/22/2019 1:36:31 PM",
    "SearchIntervalEndtimeUtc": "3/22/2019 1:51:31 PM",
    "ResultCount": 2,
    "LinkToSearchResults": "https://portal.azure.com/#Analyticsblade/search/index?_timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
    "LinkToFilteredSearchResultsUI": "https://portal.azure.com/#Analyticsblade/search/index?_timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
    "LinkToSearchResultsAPI": "https://api.loganalytics.io/v1/workspaces/workspaceID/query?query=Heartbeat&timespan=2020-05-07T18%3a11%3a51.0000000Z%2f2020-05-07T18%3a16%3a51.0000000Z",
    "LinkToFilteredSearchResultsAPI": "https://api.loganalytics.io/v1/workspaces/workspaceID/query?query=Heartbeat&timespan=2020-05-07T18%3a11%3a51.0000000Z%2f2020-05-07T18%3a16%3a51.0000000Z",
    "SeverityDescription": "Warning",
    "WorkspaceId": "12345a-1234b-123c-123d-12345678e",
    "SearchIntervalDurationMin": "15",
    "AffectedConfigurationItems": [
      "INC-Gen2Alert"
    ],
    "SearchIntervalInMinutes": "15",
    "Threshold": 10000,
    "Operator": "Less Than",
    "Dimensions": [
      {
        "name": "Computer",
        "value": "INC-Gen2Alert"
      }
    ],
    "SearchResults": {
      "tables": [
        {
          "name": "PrimaryResult",
          "columns": [
            {
              "name": "$table",
              "type": "string"
            },
            {
              "name": "Computer",
              "type": "string"
            },
            {
              "name": "TimeGenerated",
              "type": "datetime"
            }
          ],
          "rows": [
            [
              "Fabrikam",
              "33446677a",
              "2018-02-02T15:03:12.18Z"
            ],
            [
              "Contoso",
              "33445566b",
              "2018-02-02T15:16:53.932Z"
            ]
          ]
        }
      ],
      "dataSources": [
        {
          "resourceId": "/subscriptions/a5ea55e2-7482-49ba-90b3-60e7496dd873/resourcegroups/test/providers/microsoft.operationalinsights/workspaces/test",
          "tables": [
            "Heartbeat"
          ]
        }
      ]
    },
    "IncludedSearchResults": "True",
    "AlertType": "Metric measurement"
  }
}

Contoh pemberitahuan pencarian log saat monitoringService = Application Insights

{
  "alertContext": {
    "SearchQuery": "requests | where resultCode == \"500\" | summarize AggregatedValue = Count by bin(Timestamp, 5m), IP",
    "SearchIntervalStartTimeUtc": "3/22/2019 1:36:33 PM",
    "SearchIntervalEndtimeUtc": "3/22/2019 1:51:33 PM",
    "ResultCount": 2,
    "LinkToSearchResults": "https://portal.azure.com/AnalyticsBlade/subscriptions/12345a-1234b-123c-123d-12345678e/?query=search+*+&timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
    "LinkToFilteredSearchResultsUI": "https://portal.azure.com/AnalyticsBlade/subscriptions/12345a-1234b-123c-123d-12345678e/?query=search+*+&timeInterval.intervalEnd=2018-03-26T09%3a10%3a40.0000000Z&_timeInterval.intervalDuration=3600&q=Usage",
    "LinkToSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/0MyAppId0/metrics/requests/count",
    "LinkToFilteredSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/0MyAppId0/metrics/requests/count",
    "SearchIntervalDurationMin": "15",
    "SearchIntervalInMinutes": "15",
    "Threshold": 10000.0,
    "Operator": "Less Than",
    "ApplicationId": "8e20151d-75b2-4d66-b965-153fb69d65a6",
    "Dimensions": [
      {
        "name": "IP",
        "value": "1.1.1.1"
      }
    ],
    "SearchResults": {
      "tables": [
        {
          "name": "PrimaryResult",
          "columns": [
            {
              "name": "$table",
              "type": "string"
            },
            {
              "name": "Id",
              "type": "string"
            },
            {
              "name": "Timestamp",
              "type": "datetime"
            }
          ],
          "rows": [
            [
              "Fabrikam",
              "33446677a",
              "2018-02-02T15:03:12.18Z"
            ],
            [
              "Contoso",
              "33445566b",
              "2018-02-02T15:16:53.932Z"
            ]
          ]
        }
      ],
      "dataSources": [
        {
          "resourceId": "/subscriptions/a5ea27e2-7482-49ba-90b3-52e7496dd873/resourcegroups/test/providers/microsoft.operationalinsights/workspaces/test",
          "tables": [
            "Heartbeat"
          ]
        }
      ]
    },
    "IncludedSearchResults": "True",
    "AlertType": "Metric measurement"
  }
}

Contoh pemberitahuan pencarian log saat monitoringService = Log Alerts V2

Catatan

Aturan pemberitahuan pencarian log dari API versi 2020-05-01 menggunakan jenis payload ini, yang hanya mendukung skema umum. Hasil pencarian tidak disematkan dalam payload pemberitahuan pencarian log saat Anda menggunakan versi ini. Gunakan dimensi untuk memberikan konteks ke pemberitahuan yang diaktifkan. Anda juga dapat menggunakan LinkToFilteredSearchResultsAPI atau LinkToSearchResultsAPI untuk mengakses hasil kueri dengan API Analitik Log. Jika Anda harus menyematkan hasilnya, gunakan aplikasi logika dengan tautan yang disediakan untuk menghasilkan payload kustom.

{
  "alertContext": {
    "properties": {
      "name1": "value1",
      "name2": "value2"
    },
    "conditionType": "LogQueryCriteria",
    "condition": {
      "windowSize": "PT10M",
      "allOf": [
        {
          "searchQuery": "Heartbeat",
          "metricMeasureColumn": "CounterValue",
          "targetResourceTypes": "['Microsoft.Compute/virtualMachines']",
          "operator": "LowerThan",
          "threshold": "1",
          "timeAggregation": "Count",
          "dimensions": [
            {
              "name": "Computer",
              "value": "TestComputer"
            }
          ],
          "metricValue": 0.0,
          "failingPeriods": {
            "numberOfEvaluationPeriods": 1,
            "minFailingPeriodsToAlert": 1
          },
          "linkToSearchResultsUI": "https://portal.azure.com#@12345a-1234b-123c-123d-12345678e/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%212345a-1234b-123c-123d-12345678e%2FresourceGroups%2FContoso%2Fproviders%2FMicrosoft.Compute%2FvirtualMachines%2FContoso%22%7D%5D%7D/q/eJzzSE0sKklKTSypUSjPSC1KVQjJzE11T81LLUosSU1RSEotKU9NzdNIAfJKgDIaRgZGBroG5roGliGGxlYmJlbGJnoGEKCpp4dDmSmKMk0A/prettify/1/timespan/2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
          "linkToFilteredSearchResultsUI": "https://portal.azure.com#@12345a-1234b-123c-123d-12345678e/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%212345a-1234b-123c-123d-12345678e%2FresourceGroups%2FContoso%2Fproviders%2FMicrosoft.Compute%2FvirtualMachines%2FContoso%22%7D%5D%7D/q/eJzzSE0sKklKTSypUSjPSC1KVQjJzE11T81LLUosSU1RSEotKU9NzdNIAfJKgDIaRgZGBroG5roGliGGxlYmJlbGJnoGEKCpp4dDmSmKMk0A/prettify/1/timespan/2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
          "linkToSearchResultsAPI": "https://api.loganalytics.io/v1/subscriptions/12345a-1234b-123c-123d-12345678e/resourceGroups/Contoso/providers/Microsoft.Compute/virtualMachines/Contoso/query?query=Heartbeat%7C%20where%20TimeGenerated%20between%28datetime%282020-07-09T13%3A44%3A34.0000000%29..datetime%282020-07-09T13%3A54%3A34.0000000%29%29&timespan=2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z",
          "linkToFilteredSearchResultsAPI": "https://api.loganalytics.io/v1/subscriptions/12345a-1234b-123c-123d-12345678e/resourceGroups/Contoso/providers/Microsoft.Compute/virtualMachines/Contoso/query?query=Heartbeat%7C%20where%20TimeGenerated%20between%28datetime%282020-07-09T13%3A44%3A34.0000000%29..datetime%282020-07-09T13%3A54%3A34.0000000%29%29&timespan=2020-07-07T13%3a54%3a34.0000000Z%2f2020-07-09T13%3a54%3a34.0000000Z"
        }
      ],
      "windowStartTime": "2020-07-07T13:54:34Z",
      "windowEndTime": "2020-07-09T13:54:34Z"
    }
  }
}

Bidang konteks pemberitahuan untuk pemberitahuan log aktivitas

Lihat Skema peristiwa log aktivitas Azure untuk informasi terperinci tentang bidang dalam pemberitahuan log aktivitas.

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Administratif

{
  "alertContext": {
      "authorization": {
        "action": "Microsoft.Compute/virtualMachines/restart/action",
        "scope": "/subscriptions/<subscription ID>/resourceGroups/PipeLineAlertRG/providers/Microsoft.Compute/virtualMachines/WCUS-R2-ActLog"
      },
      "channels": "Operation",
      "claims": "{\"aud\":\"https://management.core.windows.net/\",\"iss\":\"https://sts.windows.net/12345a-1234b-123c-123d-12345678e/\",\"iat\":\"1553260826\",\"nbf\":\"1553260826\",\"exp\":\"1553264726\",\"aio\":\"42JgYNjdt+rr+3j/dx68v018XhuFAwA=\",\"appid\":\"e9a02282-074f-45cf-93b0-50568e0e7e50\",\"appidacr\":\"2\",\"http://schemas.microsoft.com/identity/claims/identityprovider\":\"https://sts.windows.net/12345a-1234b-123c-123d-12345678e/\",\"http://schemas.microsoft.com/identity/claims/objectidentifier\":\"9778283b-b94c-4ac6-8a41-d5b493d03aa3\",\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\":\"9778283b-b94c-4ac6-8a41-d5b493d03aa3\",\"http://schemas.microsoft.com/identity/claims/tenantid\":\"12345a-1234b-123c-123d-12345678e\",\"uti\":\"v5wYC9t9ekuA2rkZSVZbAA\",\"ver\":\"1.0\"}",
      "caller": "9778283b-b94c-4ac6-8a41-d5b493d03aa3",
      "correlationId": "8ee9c32a-92a1-4a8f-989c-b0ba09292a91",
      "eventSource": "Administrative",
      "eventTimestamp": "2019-03-22T13:56:31.2917159+00:00",
      "eventDataId": "161fda7e-1cb4-4bc5-9c90-857c55a8f57b",
      "level": "Informational",
      "operationName": "Microsoft.Compute/virtualMachines/restart/action",
      "operationId": "310db69b-690f-436b-b740-6103ab6b0cba",
      "status": "Succeeded",
      "subStatus": "",
      "submissionTimestamp": "2019-03-22T13:56:54.067593+00:00"
    }
}

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Kebijakan

{
  "alertContext": {
    "authorization": {
      "action": "Microsoft.Resources/checkPolicyCompliance/read",
      "scope": "/subscriptions/<GUID>"
    },
    "channels": "Operation",
    "claims": "{\"aud\":\"https://management.azure.com/\",\"iss\":\"https://sts.windows.net/<GUID>/\",\"iat\":\"1566711059\",\"nbf\":\"1566711059\",\"exp\":\"1566740159\",\"aio\":\"42FgYOhynHNw0scy3T/bL71+xLyqEwA=\",\"appid\":\"<GUID>\",\"appidacr\":\"2\",\"http://schemas.microsoft.com/identity/claims/identityprovider\":\"https://sts.windows.net/<GUID>/\",\"http://schemas.microsoft.com/identity/claims/objectidentifier\":\"<GUID>\",\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\":\"<GUID>\",\"http://schemas.microsoft.com/identity/claims/tenantid\":\"<GUID>\",\"uti\":\"Miy1GzoAG0Scu_l3m1aIAA\",\"ver\":\"1.0\"}",
    "caller": "<GUID>",
    "correlationId": "<GUID>",
    "eventSource": "Policy",
    "eventTimestamp": "2019-08-25T11:11:34.2269098+00:00",
    "eventDataId": "<GUID>",
    "level": "Warning",
    "operationName": "Microsoft.Authorization/policies/audit/action",
    "operationId": "<GUID>",
    "properties": {
      "isComplianceCheck": "True",
      "resourceLocation": "eastus2",
      "ancestors": "<GUID>",
      "policies": "[{\"policyDefinitionId\":\"/providers/Microsoft.Authorization/policyDefinitions/<GUID>/\",\"policySetDefinitionId\":\"/providers/Microsoft.Authorization/policySetDefinitions/<GUID>/\",\"policyDefinitionReferenceId\":\"vulnerabilityAssessmentMonitoring\",\"policySetDefinitionName\":\"<GUID>\",\"policyDefinitionName\":\"<GUID>\",\"policyDefinitionEffect\":\"AuditIfNotExists\",\"policyAssignmentId\":\"/subscriptions/<GUID>/providers/Microsoft.Authorization/policyAssignments/SecurityCenterBuiltIn/\",\"policyAssignmentName\":\"SecurityCenterBuiltIn\",\"policyAssignmentScope\":\"/subscriptions/<GUID>\",\"policyAssignmentSku\":{\"name\":\"A1\",\"tier\":\"Standard\"},\"policyAssignmentParameters\":{}}]"
    },
    "status": "Succeeded",
    "subStatus": "",
    "submissionTimestamp": "2019-08-25T11:12:46.1557298+00:00"
  }
}

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Skala Otomatis

{
  "alertContext": {
    "channels": "Admin, Operation",
    "claims": "{\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/spn\":\"Microsoft.Insights/autoscaleSettings\"}",
    "caller": "Microsoft.Insights/autoscaleSettings",
    "correlationId": "<GUID>",
    "eventSource": "Autoscale",
    "eventTimestamp": "2019-08-21T16:17:47.1551167+00:00",
    "eventDataId": "<GUID>",
    "level": "Informational",
    "operationName": "Microsoft.Insights/AutoscaleSettings/Scaleup/Action",
    "operationId": "<GUID>",
    "properties": {
      "description": "The autoscale engine attempting to scale resource '/subscriptions/d<GUID>/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachineScaleSets/testVMSS' from 9 instances count to 10 instances count.",
      "resourceName": "/subscriptions/<GUID>/resourceGroups/voiceassistancedemo/providers/Microsoft.Compute/virtualMachineScaleSets/alexademo",
      "oldInstancesCount": "9",
      "newInstancesCount": "10",
      "activeAutoscaleProfile": "{\r\n  \"Name\": \"Auto created scale condition\",\r\n  \"Capacity\": {\r\n    \"Minimum\": \"1\",\r\n    \"Maximum\": \"10\",\r\n    \"Default\": \"1\"\r\n  },\r\n  \"Rules\": [\r\n    {\r\n      \"MetricTrigger\": {\r\n        \"Name\": \"Percentage CPU\",\r\n        \"Namespace\": \"microsoft.compute/virtualmachinescalesets\",\r\n        \"Resource\": \"/subscriptions/<GUID>/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachineScaleSets/testVMSS\",\r\n        \"ResourceLocation\": \"eastus\",\r\n        \"TimeGrain\": \"PT1M\",\r\n        \"Statistic\": \"Average\",\r\n        \"TimeWindow\": \"PT5M\",\r\n        \"TimeAggregation\": \"Average\",\r\n        \"Operator\": \"GreaterThan\",\r\n        \"Threshold\": 0.0,\r\n        \"Source\": \"/subscriptions/<GUID>/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachineScaleSets/testVMSS\",\r\n        \"MetricType\": \"MDM\",\r\n        \"Dimensions\": [],\r\n        \"DividePerInstance\": false\r\n      },\r\n      \"ScaleAction\": {\r\n        \"Direction\": \"Increase\",\r\n        \"Type\": \"ChangeCount\",\r\n        \"Value\": \"1\",\r\n        \"Cooldown\": \"PT1M\"\r\n      }\r\n    }\r\n  ]\r\n}",
      "lastScaleActionTime": "Wed, 21 Aug 2019 16:17:47 GMT"
    },
    "status": "Succeeded",
    "submissionTimestamp": "2019-08-21T16:17:47.2410185+00:00"
  }
}

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Keamanan

{
  "alertContext": {
    "channels": "Operation",
    "correlationId": "<GUID>",
    "eventSource": "Security",
    "eventTimestamp": "2019-08-26T08:34:14+00:00",
    "eventDataId": "<GUID>",
    "level": "Informational",
    "operationName": "Microsoft.Security/locations/alerts/activate/action",
    "operationId": "<GUID>",
    "properties": {
      "threatStatus": "Quarantined",
      "category": "Virus",
      "threatID": "2147519003",
      "filePath": "C:\\AlertGeneration\\test.eicar",
      "protectionType": "Windows Defender",
      "actionTaken": "Blocked",
      "resourceType": "Virtual Machine",
      "severity": "Low",
      "compromisedEntity": "testVM",
      "remediationSteps": "[\"No user action is necessary\"]",
      "attackedResourceType": "Virtual Machine"
    },
    "status": "Active",
    "submissionTimestamp": "2019-08-26T09:28:58.3019107+00:00"
  }
}

Contoh pemberitahuan log aktivitas saat monitoringService = ServiceHealth

{
  "alertContext": {
    "authorization": null,
    "channels": 1,
    "claims": null,
    "caller": null,
    "correlationId": "f3cf2430-1ee3-4158-8e35-7a1d615acfc7",
    "eventSource": 2,
    "eventTimestamp": "2019-06-24T11:31:19.0312699+00:00",
    "httpRequest": null,
    "eventDataId": "<GUID>",
    "level": 3,
    "operationName": "Microsoft.ServiceHealth/maintenance/action",
    "operationId": "<GUID>",
    "properties": {
      "title": "Azure Synapse Analytics Scheduled Maintenance Pending",
      "service": "Azure Synapse Analytics",
      "region": "East US",
      "communication": "<MESSAGE>",
      "incidentType": "Maintenance",
      "trackingId": "<GUID>",
      "impactStartTime": "2019-06-26T04:00:00Z",
      "impactMitigationTime": "2019-06-26T12:00:00Z",
      "impactedServices": "[{\"ImpactedRegions\":[{\"RegionName\":\"East US\"}],\"ServiceName\":\"Azure Synapse Analytics\"}]",
      "impactedServicesTableRows": "<tr>\r\n<td align='center' style='padding: 5px 10px; border-right:1px solid black; border-bottom:1px solid black'>Azure Synapse Analytics</td>\r\n<td align='center' style='padding: 5px 10px; border-bottom:1px solid black'>East US<br></td>\r\n</tr>\r\n",
      "defaultLanguageTitle": "Azure Synapse Analytics Scheduled Maintenance Pending",
      "defaultLanguageContent": "<MESSAGE>",
      "stage": "Planned",
      "communicationId": "<GUID>",
      "maintenanceId": "<GUID>",
      "isHIR": "false",
      "version": "0.1.1"
    },
    "status": "Active",
    "subStatus": null,
    "submissionTimestamp": "2019-06-24T11:31:31.7147357+00:00",
    "ResourceType": null
  }
}

Contoh pemberitahuan log aktivitas saat monitoringService = ResourceHealth

{
  "alertContext": {
    "channels": "Admin, Operation",
    "correlationId": "<GUID>",
    "eventSource": "ResourceHealth",
    "eventTimestamp": "2019-06-24T15:42:54.074+00:00",
    "eventDataId": "<GUID>",
    "level": "Informational",
    "operationName": "Microsoft.Resourcehealth/healthevent/Activated/action",
    "operationId": "<GUID>",
    "properties": {
      "title": "This virtual machine is stopping and deallocating as requested by an authorized user or process",
      "details": null,
      "currentHealthStatus": "Unavailable",
      "previousHealthStatus": "Available",
      "type": "Downtime",
      "cause": "UserInitiated"
    },
    "status": "Active",
    "submissionTimestamp": "2019-06-24T15:45:20.4488186+00:00"
  }
}

Bidang konteks pemberitahuan untuk pemberitahuan Prometheus

Lihat Layanan terkelola Azure Monitor untuk grup aturan Prometheus (pratinjau) untuk informasi terperinci tentang bidang di pemberitahuan Prometheus.

Contoh pemberitahuan Prometheus

{
  "alertContext": {
    "interval": "PT1M",
    "expression": "sql_up > 0",
    "expressionValue": "0",
    "for": "PT2M",
    "labels": {
      "Environment": "Prod",
      "cluster": "myCluster1"
    },
    "annotations": {
      "summary": "alert on SQL availability"
    },
    "ruleGroup": "/subscriptions/<subscription ID>/resourceGroups/myResourceGroup/providers/Microsoft.AlertsManagement/prometheusRuleGroups/myRuleGroup"
  }
}

Bidang properti kustom

Jika aturan pemberitahuan yang menghasilkan pemberitahuan Anda berisi grup tindakan, properti kustom dapat berisi informasi tambahan tentang pemberitahuan tersebut. Bagian properti kustom berisi objek "kunci: nilai" yang ditambahkan ke pemberitahuan webhook.

Jika properti kustom tidak diatur dalam aturan pemberitahuan, bidang tersebut null.

Mengaktifkan skema pemberitahuan umum

Gunakan grup tindakan di portal Azure atau gunakan REST API untuk mengaktifkan skema peringatan umum. Skema didefinisikan pada tingkat tindakan. Misalnya, Anda harus mengaktifkan skema secara terpisah untuk tindakan email dan tindakan webhook.

Mengaktifkan skema umum di portal Azure

Buka tindakan yang sudah ada atau tindakan baru dalam grup tindakan.
Pilih Ya untuk mengaktifkan skema peringatan umum.

Mengaktifkan skema umum menggunakan REST API

Anda juga dapat menggunakan API Grup Tindakan untuk memilih ikut dalam skema pemberitahuan umum. Dalam panggilan buat atau perbarui REST API,

Atur bendera "useCommonAlertSchema" ke true untuk mengaktifkan skema umum
Atur bendera "useCommonAlertSchema" ke untuk false menggunakan skema non-umum untuk email, webhook, Logic Apps, Azure Functions, atau tindakan runbook Automation.

Contoh panggilan REST API untuk menggunakan skema umum

Berikut ini membuat atau memperbarui permintaan REST API:

Mengaktifkan skema pemberitahuan umum untuk tindakan email "Email John Doe."
Menonaktifkan skema pemberitahuan umum untuk tindakan email "Email Jane Smith."
Mengaktifkan skema pemberitahuan umum untuk tindakan webhook "Sampel webhook."

{
  "properties": {
    "groupShortName": "sample",
    "enabled": true,
    "emailReceivers": [
      {
        "name": "John Doe's email",
        "emailAddress": "johndoe@email.com",
        "useCommonAlertSchema": true
      },
      {
        "name": "Jane Smith's email",
        "emailAddress": "janesmith@email.com",
        "useCommonAlertSchema": false
      }
    ],
    "smsReceivers": [
      {
        "name": "John Doe's mobile",
        "countryCode": "1",
        "phoneNumber": "1234567890"
      },
      {
        "name": "Jane Smith's mobile",
        "countryCode": "1",
        "phoneNumber": "0987654321"
      }
    ],
    "webhookReceivers": [
      {
        "name": "Sample webhook",
        "serviceUri": "http://www.example.com/webhook",
        "useCommonAlertSchema": true
      }
    ]
  },
  "location": "Global",
  "tags": {}
}

Langkah berikutnya

Pelajari cara membuat aplikasi logika yang menggunakan skema peringatan umum untuk menangani semua peringatan Anda

Skema pemberitahuan umum

Struktur skema umum

Contoh payload pemberitahuan

Bidang esensial

Bidang konteks pemberitahuan untuk pemberitahuan metrik

Contoh pemberitahuan metrik dengan ambang statis saat monitoringService = Platform

Contoh pemberitahuan metrik dengan ambang batas dinamis saat monitoringService = Platform

Contoh pemberitahuan metrik untuk pengujian ketersediaan saat monitoringService = Platform

Bidang konteks pemberitahuan untuk pemberitahuan pencarian log

Contoh pemberitahuan pencarian log saat monitoringService = Log Analytics

Contoh pemberitahuan pencarian log saat monitoringService = Application Insights

Contoh pemberitahuan pencarian log saat monitoringService = Log Alerts V2

Bidang konteks pemberitahuan untuk pemberitahuan log aktivitas

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Administratif

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Kebijakan

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Skala Otomatis

Contoh pemberitahuan log aktivitas saat monitoringService = Log Aktivitas - Keamanan

Contoh pemberitahuan log aktivitas saat monitoringService = ServiceHealth

Contoh pemberitahuan log aktivitas saat monitoringService = ResourceHealth

Bidang konteks pemberitahuan untuk pemberitahuan Prometheus

Contoh pemberitahuan Prometheus

Bidang properti kustom

Mengaktifkan skema pemberitahuan umum

Mengaktifkan skema umum di portal Azure

Mengaktifkan skema umum menggunakan REST API

Contoh panggilan REST API untuk menggunakan skema umum

Langkah berikutnya

Sumber Daya Tambahan:

Contoh pemberitahuan metrik dengan ambang statis saat monitoringService = `Platform`

Contoh pemberitahuan metrik dengan ambang batas dinamis saat monitoringService = `Platform`

Contoh pemberitahuan metrik untuk pengujian ketersediaan saat monitoringService = `Platform`