Metric Alerts - Update
Memperbarui definisi pemberitahuan metrik.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
rule
|
path | True |
string |
Nama aturan. |
subscription
|
path | True |
string |
ID langganan target. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
properties.actions |
array tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan saat kondisi pemberitahuan diselesaikan. |
|
properties.autoMitigate |
boolean |
bendera yang menunjukkan apakah pemberitahuan harus diselesaikan secara otomatis atau tidak. Secara default adalah benar. |
properties.criteria | MetricAlertCriteria: |
menentukan informasi kriteria pemberitahuan tertentu. |
properties.description |
string |
deskripsi pemberitahuan metrik yang akan disertakan dalam email pemberitahuan. |
properties.enabled |
boolean |
bendera yang menunjukkan apakah pemberitahuan metrik diaktifkan. |
properties.evaluationFrequency |
string |
seberapa sering pemberitahuan metrik dievaluasi yang diwakili dalam format durasi ISO 8601. |
properties.scopes |
string[] |
daftar id sumber daya yang dilingkup oleh pemberitahuan metrik ini. |
properties.severity |
integer |
Tingkat keparahan pemberitahuan {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
wilayah sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib untuk MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
jenis sumber daya dari sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib untuk MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. |
tags |
object |
Tag sumber daya |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
BadRequest |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory
Jenis:
oauth2
Alur:
implicit
URL Otorisasi:
https://login.microsoftonline.com/common/oauth2/authorize
Cakupan
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
Create or update an alert rule
Permintaan sampel
PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01
{
"tags": {},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Respon sampel
{
"id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/chiricutin",
"type": "Microsoft.Insights/metricAlerts",
"location": "global",
"tags": {
"hidden-link:/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/Rac46PostSwapRG/providers/Microsoft.Web/sites/leoalerttest": "Resource"
},
"properties": {
"description": "This is the description of the rule1",
"severity": 3,
"enabled": true,
"scopes": [
"/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
],
"evaluationFrequency": "Pt1m",
"windowSize": "Pt15m",
"criteria": {
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "StaticThresholdCriterion",
"name": "High_CPU_80",
"metricName": "\\Processor(_Total)\\% Processor Time",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 80.5,
"timeAggregation": "Average"
}
]
},
"autoMitigate": true,
"actions": [
{
"actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
"webHookProperties": {
"key11": "value11",
"key12": "value12"
}
}
]
}
}
Definisi
Nama | Deskripsi |
---|---|
Aggregation |
jenis agregasi waktu kriteria. |
Dynamic |
Kriteria untuk ambang batas dinamis. |
Dynamic |
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan. |
Dynamic |
Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas. |
Dynamic |
Tingkat penyimpangan yang diperlukan untuk memicu pemberitahuan. Ini akan memengaruhi seberapa ketat ambang batas ke pola seri metrik. |
Error |
Menjelaskan format respons Kesalahan. |
Metric |
Tindakan pemberitahuan. |
Metric |
Menentukan kriteria pemberitahuan metrik untuk beberapa sumber daya yang memiliki beberapa kriteria metrik. |
Metric |
Sumber daya pemberitahuan metrik. |
Metric |
Sumber daya pemberitahuan metrik untuk operasi patch. |
Metric |
Menentukan kriteria pemberitahuan metrik untuk satu sumber daya yang memiliki beberapa kriteria metrik. |
Metric |
Kriteria untuk memfilter metrik. |
Metric |
Menentukan dimensi metrik. |
Operator |
operator kriteria. |
Webtest |
Menentukan kriteria aturan pemberitahuan metrik untuk sumber daya pengujian web. |
AggregationTypeEnum
jenis agregasi waktu kriteria.
Nama | Jenis | Deskripsi |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |
DynamicMetricCriteria
Kriteria untuk ambang batas dinamis.
Nama | Jenis | Deskripsi |
---|---|---|
alertSensitivity |
Tingkat penyimpangan yang diperlukan untuk memicu pemberitahuan. Ini akan memengaruhi seberapa ketat ambang batas ke pola seri metrik. |
|
criterionType |
string:
Dynamic |
Menentukan jenis kriteria ambang batas |
dimensions |
Daftar kondisi dimensi. |
|
failingPeriods |
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan. |
|
ignoreDataBefore |
string |
Gunakan opsi ini untuk mengatur tanggal untuk mulai mempelajari data historis metrik dan menghitung ambang dinamis (dalam format ISO8601) |
metricName |
string |
Nama metrik. |
metricNamespace |
string |
Namespace metrik. |
name |
string |
Nama kriteria. |
operator |
Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas. |
|
skipMetricValidation |
boolean |
Memungkinkan pembuatan aturan peringatan pada metrik kustom yang belum dipancarkan, dengan menyebabkan validasi metrik dilewati. |
timeAggregation |
jenis agregasi waktu kriteria. |
DynamicThresholdFailingPeriods
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan.
Nama | Jenis | Deskripsi |
---|---|---|
minFailingPeriodsToAlert |
number |
Jumlah pelanggaran untuk memicu pemberitahuan. Harus lebih kecil atau sama dengan numberOfEvaluationPeriods. |
numberOfEvaluationPeriods |
number |
Jumlah titik lookback agregat. Jendela waktu lookback dihitung berdasarkan granularitas agregasi (windowSize) dan jumlah titik agregat yang dipilih. |
DynamicThresholdOperator
Operator yang digunakan untuk membandingkan nilai metrik dengan ambang batas.
Nama | Jenis | Deskripsi |
---|---|---|
GreaterOrLessThan |
string |
|
GreaterThan |
string |
|
LessThan |
string |
DynamicThresholdSensitivity
Tingkat penyimpangan yang diperlukan untuk memicu pemberitahuan. Ini akan memengaruhi seberapa ketat ambang batas ke pola seri metrik.
Nama | Jenis | Deskripsi |
---|---|---|
High |
string |
|
Low |
string |
|
Medium |
string |
ErrorResponse
Menjelaskan format respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan |
message |
string |
Pesan kesalahan yang menunjukkan mengapa operasi gagal. |
MetricAlertAction
Tindakan pemberitahuan.
Nama | Jenis | Deskripsi |
---|---|---|
actionGroupId |
string |
id grup tindakan yang akan digunakan. |
webHookProperties |
object |
Bidang ini memungkinkan penentuan properti kustom, yang akan ditambahkan ke payload pemberitahuan yang dikirim sebagai input ke webhook. |
MetricAlertMultipleResourceMultipleMetricCriteria
Menentukan kriteria pemberitahuan metrik untuk beberapa sumber daya yang memiliki beberapa kriteria metrik.
Nama | Jenis | Deskripsi |
---|---|---|
allOf | MultiMetricCriteria[]: |
daftar beberapa kriteria metrik untuk operasi 'semua' ini. |
odata.type |
string:
Microsoft. |
menentukan jenis kriteria pemberitahuan. |
MetricAlertResource
Sumber daya pemberitahuan metrik.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Id sumber daya Azure |
location |
string |
Lokasi sumber daya |
name |
string |
Nama sumber daya Azure |
properties.actions |
array tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan saat kondisi pemberitahuan diselesaikan. |
|
properties.autoMitigate |
boolean |
bendera yang menunjukkan apakah pemberitahuan harus diselesaikan secara otomatis atau tidak. Secara default adalah benar. |
properties.criteria | MetricAlertCriteria: |
menentukan informasi kriteria pemberitahuan tertentu. |
properties.description |
string |
deskripsi pemberitahuan metrik yang akan disertakan dalam email pemberitahuan. |
properties.enabled |
boolean |
bendera yang menunjukkan apakah pemberitahuan metrik diaktifkan. |
properties.evaluationFrequency |
string |
seberapa sering pemberitahuan metrik dievaluasi yang diwakili dalam format durasi ISO 8601. |
properties.isMigrated |
boolean |
nilai yang menunjukkan apakah aturan pemberitahuan ini dimigrasikan. |
properties.lastUpdatedTime |
string |
Terakhir kali aturan diperbarui dalam format ISO8601. |
properties.scopes |
string[] |
daftar id sumber daya yang menjadi cakupan pemberitahuan metrik ini. |
properties.severity |
integer |
Tingkat keparahan pemberitahuan {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
wilayah sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib jika cakupan berisi langganan, grup sumber daya, atau lebih dari satu sumber daya. |
properties.targetResourceType |
string |
jenis sumber daya sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib jika cakupan berisi langganan, grup sumber daya, atau lebih dari satu sumber daya. |
properties.windowSize |
string |
periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. |
tags |
object |
Tag sumber daya |
type |
string |
Jenis sumber daya Azure |
MetricAlertResourcePatch
Sumber daya pemberitahuan metrik untuk operasi patch.
Nama | Jenis | Deskripsi |
---|---|---|
properties.actions |
array tindakan yang dilakukan saat aturan pemberitahuan menjadi aktif, dan saat kondisi pemberitahuan diselesaikan. |
|
properties.autoMitigate |
boolean |
bendera yang menunjukkan apakah pemberitahuan harus diselesaikan secara otomatis atau tidak. Secara default adalah benar. |
properties.criteria | MetricAlertCriteria: |
menentukan informasi kriteria pemberitahuan tertentu. |
properties.description |
string |
deskripsi pemberitahuan metrik yang akan disertakan dalam email pemberitahuan. |
properties.enabled |
boolean |
bendera yang menunjukkan apakah pemberitahuan metrik diaktifkan. |
properties.evaluationFrequency |
string |
seberapa sering pemberitahuan metrik dievaluasi yang diwakili dalam format durasi ISO 8601. |
properties.isMigrated |
boolean |
nilai yang menunjukkan apakah aturan pemberitahuan ini dimigrasikan. |
properties.lastUpdatedTime |
string |
Terakhir kali aturan diperbarui dalam format ISO8601. |
properties.scopes |
string[] |
daftar id sumber daya yang menjadi cakupan pemberitahuan metrik ini. |
properties.severity |
integer |
Tingkat keparahan pemberitahuan {0, 1, 2, 3, 4} |
properties.targetResourceRegion |
string |
wilayah sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib untuk MultipleResourceMultipleMetricCriteria. |
properties.targetResourceType |
string |
jenis sumber daya sumber daya target tempat pemberitahuan dibuat/diperbarui. Wajib untuk MultipleResourceMultipleMetricCriteria. |
properties.windowSize |
string |
periode waktu (dalam format durasi ISO 8601) yang digunakan untuk memantau aktivitas pemberitahuan berdasarkan ambang batas. |
tags |
object |
Tag sumber daya |
MetricAlertSingleResourceMultipleMetricCriteria
Menentukan kriteria pemberitahuan metrik untuk satu sumber daya yang memiliki beberapa kriteria metrik.
Nama | Jenis | Deskripsi |
---|---|---|
allOf |
Daftar kriteria metrik untuk operasi 'semua' ini. |
|
odata.type |
string:
Microsoft. |
menentukan jenis kriteria pemberitahuan. |
MetricCriteria
Kriteria untuk memfilter metrik.
Nama | Jenis | Deskripsi |
---|---|---|
criterionType |
string:
Static |
Menentukan jenis kriteria ambang batas |
dimensions |
Daftar kondisi dimensi. |
|
metricName |
string |
Nama metrik. |
metricNamespace |
string |
Namespace metrik. |
name |
string |
Nama kriteria. |
operator |
operator kriteria. |
|
skipMetricValidation |
boolean |
Memungkinkan pembuatan aturan peringatan pada metrik kustom yang belum dipancarkan, dengan menyebabkan validasi metrik dilewati. |
threshold |
number |
nilai ambang batas kriteria yang mengaktifkan pemberitahuan. |
timeAggregation |
jenis agregasi waktu kriteria. |
MetricDimension
Menentukan dimensi metrik.
Nama | Jenis | Deskripsi |
---|---|---|
name |
string |
Nama dimensi. |
operator |
string |
operator dimensi. Hanya 'Sertakan' dan 'Kecualikan' yang didukung |
values |
string[] |
daftar nilai dimensi. |
Operator
operator kriteria.
Nama | Jenis | Deskripsi |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
WebtestLocationAvailabilityCriteria
Menentukan kriteria aturan pemberitahuan metrik untuk sumber daya pengujian web.
Nama | Jenis | Deskripsi |
---|---|---|
componentId |
string |
Id sumber daya Application Insights. |
failedLocationCount |
number |
Jumlah lokasi yang gagal. |
odata.type |
string:
Microsoft. |
menentukan jenis kriteria pemberitahuan. |
webTestId |
string |
Id pengujian web Application Insights. |