Scheduled Query Rules - Create Or Update
Membuat atau memperbarui aturan kueri terjadwal.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}?api-version=2021-08-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 | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
location | True |
string |
Lokasi geografis tempat sumber daya berada |
properties.criteria | True |
Kriteria aturan yang menentukan kondisi aturan kueri terjadwal. |
|
properties.enabled | True |
boolean |
Bendera yang menunjukkan apakah aturan kueri terjadwal ini diaktifkan. Nilai harus benar atau salah |
properties.scopes | True |
string[] |
Daftar id sumber daya yang dilingkup oleh aturan kueri terjadwal ini. |
kind |
Menunjukkan jenis aturan kueri terjadwal. Defaultnya adalah LogAlert. |
||
properties.actions |
Tindakan yang akan dipanggil saat pemberitahuan diaktifkan. |
||
properties.autoMitigate |
boolean |
Bendera yang menunjukkan apakah pemberitahuan harus diselesaikan secara otomatis atau tidak. Secara default adalah benar. Hanya relevan untuk aturan jenis LogAlert. |
|
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Bendera yang menunjukkan apakah aturan kueri terjadwal ini harus disimpan di penyimpanan pelanggan. Defaultnya adalah false (salah). Hanya relevan untuk aturan jenis LogAlert. |
|
properties.description |
string |
Deskripsi aturan kueri terjadwal. |
|
properties.displayName |
string |
Nama tampilan aturan pemberitahuan |
|
properties.evaluationFrequency |
string |
Seberapa sering aturan kueri terjadwal dievaluasi yang diwakili dalam format durasi ISO 8601. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
|
properties.muteActionsDuration |
string |
Matikan suara tindakan untuk periode waktu yang dipilih (dalam format durasi ISO 8601) setelah pemberitahuan diaktifkan. Hanya relevan untuk aturan jenis LogAlert. |
|
properties.overrideQueryTimeRange |
string |
Jika ditentukan, maka mengambil alih rentang waktu kueri (defaultnya adalah WindowSize*NumberOfEvaluationPeriods). Hanya relevan untuk aturan jenis LogAlert. |
|
properties.severity |
Tingkat keparahan pemberitahuan. Harus berupa bilangan bulat antara [0-4]. Nilai 0 paling parah. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
||
properties.skipQueryValidation |
boolean |
Bendera yang menunjukkan apakah kueri yang disediakan harus divalidasi atau tidak. Defaultnya adalah false (salah). Hanya relevan untuk aturan jenis LogAlert. |
|
properties.targetResourceTypes |
string[] |
Daftar jenis sumber daya sumber daya target tempat pemberitahuan dibuat/diperbarui. Misalnya jika cakupannya adalah grup sumber daya dan targetResourceTypes adalah Microsoft.Compute/virtualMachines, maka pemberitahuan yang berbeda akan diaktifkan untuk setiap komputer virtual dalam grup sumber daya yang memenuhi kriteria pemberitahuan. Hanya relevan untuk aturan jenis LogAlert |
|
properties.windowSize |
string |
Periode waktu (dalam format durasi ISO 8601) tempat kueri Pemberitahuan akan dijalankan (ukuran bin). Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
|
tags |
object |
Tag sumber daya. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Permintaan berhasil memperbarui aturan kueri terjadwal |
|
201 Created |
Membuat aturan kueri terjadwal |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
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 a scheduled query rule for Single Resource |
Create or update a scheduled query rule on Resource group(s) |
Create or update a scheduled query rule on Subscription |
Create or update a scheduled query rule for Single Resource
Permintaan sampel
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Respon sampel
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Resource group(s)
Permintaan sampel
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/heartbeat?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Respon sampel
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat",
"name": "heartbeat",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Health check rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Heartbeat",
"timeAggregation": "Count",
"dimensions": [],
"operator": "GreaterThan",
"threshold": 360,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Create or update a scheduled query rule on Subscription
Permintaan sampel
PUT https://management.azure.com/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourceGroups/QueryResourceGroupName/providers/Microsoft.Insights/scheduledQueryRules/perf?api-version=2021-08-01
{
"location": "eastus",
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Respon sampel
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
{
"id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf",
"name": "perf",
"type": "microsoft.insights/scheduledqueryrules",
"location": "eastus",
"tags": {},
"properties": {
"description": "Performance rule",
"severity": 4,
"enabled": true,
"evaluationFrequency": "PT5M",
"scopes": [
"/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147"
],
"targetResourceTypes": [
"Microsoft.Compute/virtualMachines"
],
"windowSize": "PT10M",
"criteria": {
"allOf": [
{
"query": "Perf | where ObjectName == \"Processor\"",
"timeAggregation": "Average",
"metricMeasureColumn": "% Processor Time",
"resourceIdColumn": "resourceId",
"dimensions": [
{
"name": "ComputerIp",
"operator": "Exclude",
"values": [
"192.168.1.1"
]
},
{
"name": "OSType",
"operator": "Include",
"values": [
"*"
]
}
],
"operator": "GreaterThan",
"threshold": 70,
"failingPeriods": {
"numberOfEvaluationPeriods": 1,
"minFailingPeriodsToAlert": 1
}
}
]
},
"muteActionsDuration": "PT30M",
"actions": {
"actionGroups": [
"/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup"
],
"customProperties": {
"key11": "value11",
"key12": "value12"
}
},
"autoMitigate": true,
"isWorkspaceAlertsStorageConfigured": true,
"checkWorkspaceAlertsStorageConfigured": true,
"skipQueryValidation": true
}
}
Definisi
Nama | Deskripsi |
---|---|
Actions |
Tindakan yang akan dipanggil saat pemberitahuan diaktifkan. |
Alert |
Tingkat keparahan pemberitahuan. Harus berupa bilangan bulat antara [0-4]. Nilai 0 paling parah. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
Condition |
Kondisi aturan kueri terjadwal. |
condition |
Operator kriteria. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
created |
Jenis identitas yang membuat sumber daya. |
Dimension |
Definisi pemisahan dan pemfilteran dimensi |
dimension |
Operator untuk nilai dimensi |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Menjelaskan format respons Kesalahan. |
Error |
Respons Kesalahan |
Failing |
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan. Hanya relevan untuk aturan jenis LogAlert. |
Kind |
Menunjukkan jenis aturan kueri terjadwal. Defaultnya adalah LogAlert. |
Scheduled |
Kriteria aturan yang menentukan kondisi aturan kueri terjadwal. |
Scheduled |
Sumber daya aturan kueri terjadwal. |
system |
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya. |
time |
Jenis agregasi. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
Actions
Tindakan yang akan dipanggil saat pemberitahuan diaktifkan.
Nama | Jenis | Deskripsi |
---|---|---|
actionGroups |
string[] |
Id sumber daya Grup Tindakan untuk dipanggil saat pemberitahuan diaktifkan. |
customProperties |
object |
Properti payload pemberitahuan. |
AlertSeverity
Tingkat keparahan pemberitahuan. Harus berupa bilangan bulat antara [0-4]. Nilai 0 paling parah. Relevan dan diperlukan hanya untuk aturan jenis LogAlert.
Nama | Jenis | Deskripsi |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
Condition
Kondisi aturan kueri terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
dimensions |
Daftar kondisi Dimensi |
|
failingPeriods |
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan. Hanya relevan untuk aturan jenis LogAlert. |
|
metricMeasureColumn |
string |
Kolom yang berisi nomor pengukuran metrik. Hanya relevan untuk aturan jenis LogAlert. |
metricName |
string |
Nama metrik yang akan dikirim. Relevan dan diperlukan hanya untuk aturan jenis LogToMetric. |
operator |
Operator kriteria. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
|
query |
string |
Pemberitahuan kueri log |
resourceIdColumn |
string |
Kolom yang berisi id sumber daya. Konten kolom harus berupa uri yang diformat sebagai id sumber daya. Hanya relevan untuk aturan jenis LogAlert. |
threshold |
number |
nilai ambang kriteria yang mengaktifkan pemberitahuan. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
timeAggregation |
Jenis agregasi. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
conditionOperator
Operator kriteria. Relevan dan diperlukan hanya untuk aturan jenis LogAlert.
Nama | Jenis | Deskripsi |
---|---|---|
Equals |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqual |
string |
|
LessThan |
string |
|
LessThanOrEqual |
string |
createdByType
Jenis identitas yang membuat sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Dimension
Definisi pemisahan dan pemfilteran dimensi
Nama | Jenis | Deskripsi |
---|---|---|
name |
string |
Nama dimensi |
operator |
Operator untuk nilai dimensi |
|
values |
string[] |
Daftar nilai dimensi |
dimensionOperator
Operator untuk nilai dimensi
Nama | Jenis | Deskripsi |
---|---|---|
Exclude |
string |
|
Include |
string |
ErrorAdditionalInfo
Info tambahan kesalahan manajemen sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
info |
object |
Info tambahan. |
type |
string |
Jenis info tambahan. |
ErrorContract
Menjelaskan format respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error |
Respons Kesalahan |
ErrorResponse
Respons Kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
additionalInfo |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
FailingPeriods
Jumlah minimum pelanggaran yang diperlukan dalam jendela waktu lookback yang dipilih diperlukan untuk menaikkan pemberitahuan. Hanya relevan untuk aturan jenis LogAlert.
Nama | Jenis | Nilai default | Deskripsi |
---|---|---|---|
minFailingPeriodsToAlert |
integer |
1 |
Jumlah pelanggaran untuk memicu pemberitahuan. Harus lebih kecil atau sama dengan numberOfEvaluationPeriods. Nilai defaultnya adalah 1 |
numberOfEvaluationPeriods |
integer |
1 |
Jumlah titik lookback agregat. Jendela waktu lookback dihitung berdasarkan granularitas agregasi (windowSize) dan jumlah titik agregat yang dipilih. Nilai defaultnya adalah 1 |
Kind
Menunjukkan jenis aturan kueri terjadwal. Defaultnya adalah LogAlert.
Nama | Jenis | Deskripsi |
---|---|---|
LogAlert |
string |
|
LogToMetric |
string |
ScheduledQueryRuleCriteria
Kriteria aturan yang menentukan kondisi aturan kueri terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
allOf |
Daftar kondisi untuk dievaluasi terhadap cakupan yang ditentukan |
ScheduledQueryRuleResource
Sumber daya aturan kueri terjadwal.
Nama | Jenis | Deskripsi |
---|---|---|
etag |
string |
Bidang etag tidak diperlukan. Jika disediakan dalam isi respons, itu juga harus disediakan sebagai header per konvensi etag normal. Tag entitas digunakan untuk membandingkan dua entitas atau lebih dari sumber daya yang diminta yang sama. HTTP/1.1 menggunakan tag entitas di bidang header etag (bagian 14.19), If-Match (bagian 14.24), If-None-Match (bagian 14.26), dan If-Range (bagian 14.27). |
id |
string |
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
kind |
Menunjukkan jenis aturan kueri terjadwal. Defaultnya adalah LogAlert. |
|
location |
string |
Lokasi geografis tempat sumber daya berada |
name |
string |
Nama sumber daya. |
properties.actions |
Tindakan yang akan dipanggil saat pemberitahuan diaktifkan. |
|
properties.autoMitigate |
boolean |
Bendera yang menunjukkan apakah pemberitahuan harus diselesaikan secara otomatis atau tidak. Secara default adalah benar. Hanya relevan untuk aturan jenis LogAlert. |
properties.checkWorkspaceAlertsStorageConfigured |
boolean |
Bendera yang menunjukkan apakah aturan kueri terjadwal ini harus disimpan di penyimpanan pelanggan. Defaultnya adalah false (salah). Hanya relevan untuk aturan jenis LogAlert. |
properties.createdWithApiVersion |
string |
Versi api yang digunakan saat membuat aturan pemberitahuan ini |
properties.criteria |
Kriteria aturan yang menentukan kondisi aturan kueri terjadwal. |
|
properties.description |
string |
Deskripsi aturan kueri terjadwal. |
properties.displayName |
string |
Nama tampilan aturan pemberitahuan |
properties.enabled |
boolean |
Bendera yang menunjukkan apakah aturan kueri terjadwal ini diaktifkan. Nilai harus benar atau salah |
properties.evaluationFrequency |
string |
Seberapa sering aturan kueri terjadwal dievaluasi yang diwakili dalam format durasi ISO 8601. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
properties.isLegacyLogAnalyticsRule |
boolean |
True jika aturan pemberitahuan adalah aturan Analitik Log warisan |
properties.isWorkspaceAlertsStorageConfigured |
boolean |
Bendera yang menunjukkan apakah aturan kueri terjadwal ini telah dikonfigurasi untuk disimpan di penyimpanan pelanggan. Defaultnya adalah false (salah). |
properties.muteActionsDuration |
string |
Matikan suara tindakan untuk periode waktu yang dipilih (dalam format durasi ISO 8601) setelah pemberitahuan diaktifkan. Hanya relevan untuk aturan jenis LogAlert. |
properties.overrideQueryTimeRange |
string |
Jika ditentukan, maka mengambil alih rentang waktu kueri (defaultnya adalah WindowSize*NumberOfEvaluationPeriods). Hanya relevan untuk aturan jenis LogAlert. |
properties.scopes |
string[] |
Daftar id sumber daya yang dilingkup oleh aturan kueri terjadwal ini. |
properties.severity |
Tingkat keparahan pemberitahuan. Harus berupa bilangan bulat antara [0-4]. Nilai 0 paling parah. Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
|
properties.skipQueryValidation |
boolean |
Bendera yang menunjukkan apakah kueri yang disediakan harus divalidasi atau tidak. Defaultnya adalah false (salah). Hanya relevan untuk aturan jenis LogAlert. |
properties.targetResourceTypes |
string[] |
Daftar jenis sumber daya sumber daya target tempat pemberitahuan dibuat/diperbarui. Misalnya jika cakupannya adalah grup sumber daya dan targetResourceTypes adalah Microsoft.Compute/virtualMachines, maka pemberitahuan yang berbeda akan diaktifkan untuk setiap komputer virtual dalam grup sumber daya yang memenuhi kriteria pemberitahuan. Hanya relevan untuk aturan jenis LogAlert |
properties.windowSize |
string |
Periode waktu (dalam format durasi ISO 8601) tempat kueri Pemberitahuan akan dijalankan (ukuran bin). Relevan dan diperlukan hanya untuk aturan jenis LogAlert. |
systemData |
SystemData dari ScheduledQueryRule. |
|
tags |
object |
Tag sumber daya. |
type |
string |
Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
systemData
Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Nama | Jenis | Deskripsi |
---|---|---|
createdAt |
string |
Tanda waktu pembuatan sumber daya (UTC). |
createdBy |
string |
Identitas yang membuat sumber daya. |
createdByType |
Jenis identitas yang membuat sumber daya. |
|
lastModifiedAt |
string |
Tanda waktu modifikasi terakhir sumber daya (UTC) |
lastModifiedBy |
string |
Identitas yang terakhir mengubah sumber daya. |
lastModifiedByType |
Jenis identitas yang terakhir mengubah sumber daya. |
timeAggregation
Jenis agregasi. Relevan dan diperlukan hanya untuk aturan jenis LogAlert.
Nama | Jenis | Deskripsi |
---|---|---|
Average |
string |
|
Count |
string |
|
Maximum |
string |
|
Minimum |
string |
|
Total |
string |