Metric Alerts - Update
更新指標警示定義。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2024-03-01-preview
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
資源群組的名稱。 名稱不區分大小寫。 |
|
rule
|
path | True |
string |
規則的名稱。 |
|
subscription
|
path | True |
string minLength: 1 |
目標訂用帳戶的標識碼。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| identity |
資源的身分識別。 |
|
| properties.actionProperties |
object |
動作屬性的屬性。 |
| properties.actions |
警示規則變成作用中,以及解決警示條件時所執行的動作陣列。 |
|
| properties.autoMitigate |
boolean |
指出是否應自動解決警示的旗標。 默認值為 true。 |
| properties.criteria | MetricAlertCriteria: |
定義特定的警示準則資訊。 |
| properties.customProperties |
object |
警示承載的屬性。 |
| properties.description |
string |
將包含在警示電子郵件中的計量警示描述。 |
| properties.enabled |
boolean |
指出是否已啟用度量警示的旗標。 |
| properties.evaluationFrequency |
string (duration) |
評估度量警示的頻率,以 ISO 8601 持續時間格式表示。 |
| properties.resolveConfiguration |
如何解決警示的設定。 適用於PromQLCriteria。 |
|
| properties.scopes |
string[] |
此計量警示的範圍為的資源識別碼清單。 |
| properties.severity |
integer (int32) |
警示嚴重性 {0, 1, 2, 3, 4} |
| properties.targetResourceRegion |
string |
建立/更新警示的目標資源區域。 多資源多重衡量標準的強制要求。 |
| properties.targetResourceType |
string |
建立/更新警示的目標資源的資源類型。 多資源多重衡量標準的強制要求。 |
| properties.windowSize |
string (duration) |
用來根據臨界值監視警示活動的時間段 (ISO 8601 持續時間格式)。 |
| tags |
object |
資源標籤 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
錯誤的請求 |
安全性
azure_auth
Azure Active Directory OAuth2 流
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
Create or update an alert rule
範例要求
PATCH https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2024-03-01-preview
{
"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"
}
}
]
}
}
範例回覆
{
"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"
}
}
]
}
}
定義
AdditionalInfo
一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的,並依賴於「類型」字串。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
針對特定類型的額外資訊。 |
|
| type |
string |
附加資訊的類型。 |
AggregationTypeEnum
準則時間彙總類型。 先前未記載的值可能會傳回
| 值 | Description |
|---|---|
| Average | |
| Count | |
| Minimum | |
| Maximum | |
| Total |
DynamicMetricCriteria
動態閾值標準。
| 名稱 | 類型 | Description |
|---|---|---|
| alertSensitivity |
觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。 先前未記載的值可能會傳回 |
|
| criterionType |
string:
Dynamic |
指定臨界值準則的類型。 先前未記載的值可能會傳回 |
| dimensions |
維度條件的清單。 |
|
| failingPeriods |
引發警示所需的所選回溯時間範圍內所需的違規數目下限。 |
|
| ignoreDataBefore |
string (date-time) |
使用此選項可設定開始學習計量歷程記錄資料的日期,並計算動態閾值(以ISO8601格式) |
| metricName |
string |
計量的名稱。 |
| metricNamespace |
string |
計量Namespace。 |
| name |
string |
準則的名稱。 |
| operator |
運算子,用來比較計量值與臨界值。 先前未記載的值可能會傳回 |
|
| skipMetricValidation |
boolean |
允許在尚未發出的自定義計量上建立警示規則,方法是略過計量驗證。 |
| timeAggregation |
準則時間彙總類型。 先前未記載的值可能會傳回 |
DynamicPromQLCriteria
動態舞會查詢的標準。
| 名稱 | 類型 | Description |
|---|---|---|
| alertSensitivity |
觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。 先前未記載的值可能會傳回 |
|
| criterionType |
string:
Dynamic |
指定臨界值準則的類型。 先前未記載的值可能會傳回 |
| ignoreDataBefore |
string (date-time) |
使用此選項可設定開始學習計量歷程記錄資料的日期,並計算動態閾值(以ISO8601格式) |
| name |
string |
準則的名稱。 |
| operator |
運算子,用來比較計量值與臨界值。 先前未記載的值可能會傳回 |
|
| query |
string |
用來評估警示規則的查詢 |
DynamicThresholdFailingPeriods
引發警示所需的所選回溯時間範圍內所需的違規數目下限。
| 名稱 | 類型 | Description |
|---|---|---|
| minFailingPeriodsToAlert |
number |
觸發警示的違規次數。 應小於或等於 numberOfEvaluationPeriods。 |
| numberOfEvaluationPeriods |
number |
匯總回溯點的數目。 回溯時間範圍是根據匯總數據粒度 (windowSize) 和選取的匯總點數目來計算。 |
DynamicThresholdOperator
運算子,用來比較計量值與臨界值。 先前未記載的值可能會傳回
| 值 | Description |
|---|---|
| GreaterThan | |
| LessThan | |
| GreaterOrLessThan |
DynamicThresholdSensitivity
觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。 先前未記載的值可能會傳回
| 值 | Description |
|---|---|
| Low | |
| Medium | |
| High |
Error
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的,並依賴於「類型」字串。 |
|
| code |
string |
未局域字串,可用於程式化識別錯誤。 |
| details |
其他巢狀錯誤回應資訊對象的陣列,如此合約所述。 |
|
| message |
string |
詳細描述錯誤並提供除錯資訊。 如果請求中設定了 Accept-Language,必須在地化到該語言。 |
| target |
string |
特定錯誤的目標 (例如,發生錯誤的屬性名稱)。 |
ErrorDetail
描述錯誤回應的細節。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
一組具有「類型」和「資訊」屬性的物件陣列。 「info」的結構是服務特定的,並依賴於「類型」字串。 |
|
| code |
string |
未局域字串,可用於程式化識別錯誤。 |
| message |
string |
詳細描述錯誤並提供除錯資訊。 |
| target |
string |
特定錯誤的目標 (例如,發生錯誤的屬性名稱)。 |
ErrorResponse
描述錯誤回應的格式。
| 名稱 | 類型 | Description |
|---|---|---|
| error |
Identity
資源的身分識別。
| 名稱 | 類型 | Description |
|---|---|---|
| principalId |
string |
資源識別的主要標識碼。 |
| tenantId |
string |
資源的租用戶標識碼。 |
| type |
受控服務識別的類型。 先前未記載的值可能會傳回 |
|
| userAssignedIdentities |
<string,
User |
與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考會是 Azure 資源識別碼,格式為:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityType
受控服務識別的類型。 先前未記載的值可能會傳回
| 值 | Description |
|---|---|
| SystemAssigned | |
| UserAssigned | |
| None |
MetricAlertAction
警示動作。
| 名稱 | 類型 | Description |
|---|---|---|
| actionGroupId |
string |
要使用的動作群組識別碼。 |
| webHookProperties |
object |
此欄位允許指定自定義屬性,這會附加至傳送為 Webhook 輸入的警示承載。 |
MetricAlertMultipleResourceMultipleMetricCriteria
指定多個資源的指標警示標準,且該資源具有多個指標條件。
| 名稱 | 類型 | Description |
|---|---|---|
| allOf | MultiMetricCriteria[]: |
此「全部」作業的多個度量準則清單。 |
| odata.type |
string:
Microsoft. |
指定警示準則的類型。 先前未記載的值可能會傳回 |
MetricAlertResource
指標警示資源。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
Azure 資源標識碼 |
| identity |
資源的身分識別。 |
|
| location |
string |
資源位置 |
| name |
string |
Azure 資源名稱 |
| properties.actionProperties |
object |
動作屬性的屬性。 |
| properties.actions |
警示規則變成作用中,以及解決警示條件時所執行的動作陣列。 |
|
| properties.autoMitigate |
boolean |
指出是否應自動解決警示的旗標。 默認值為 true。 |
| properties.criteria | MetricAlertCriteria: |
定義特定的警示準則資訊。 |
| properties.customProperties |
object |
警示承載的屬性。 |
| properties.description |
string |
將包含在警示電子郵件中的計量警示描述。 |
| properties.enabled |
boolean |
指出是否已啟用度量警示的旗標。 |
| properties.evaluationFrequency |
string (duration) |
評估度量警示的頻率,以 ISO 8601 持續時間格式表示。 |
| properties.isMigrated |
boolean |
該值指示該警報規則是否已被遷移。 |
| properties.lastUpdatedTime |
string (date-time) |
上次規則更新為ISO8601格式。 |
| properties.resolveConfiguration |
如何解決警示的設定。 適用於PromQLCriteria。 |
|
| properties.scopes |
string[] |
此計量警示的範圍為的資源識別碼清單。 您無法根據記錄來變更計量規則的範圍。 |
| properties.severity |
integer (int32) |
警示嚴重性 {0, 1, 2, 3, 4} |
| properties.targetResourceRegion |
string |
建立/更新警示的目標資源區域。 如果範圍包含訂用帳戶、資源群組或多個資源,則為必要專案。 |
| properties.targetResourceType |
string |
建立/更新警示的目標資源的資源類型。 如果範圍包含訂用帳戶、資源群組或多個資源,則為必要專案。 |
| properties.windowSize |
string (duration) |
用來根據臨界值監視警示活動的時間段 (ISO 8601 持續時間格式)。 |
| tags |
object |
資源標籤 |
| type |
string |
Azure 資源類型 |
MetricAlertResourcePatch
補丁操作的指標警示資源。
| 名稱 | 類型 | Description |
|---|---|---|
| identity |
資源的身分識別。 |
|
| properties.actionProperties |
object |
動作屬性的屬性。 |
| properties.actions |
警示規則變成作用中,以及解決警示條件時所執行的動作陣列。 |
|
| properties.autoMitigate |
boolean |
指出是否應自動解決警示的旗標。 默認值為 true。 |
| properties.criteria | MetricAlertCriteria: |
定義特定的警示準則資訊。 |
| properties.customProperties |
object |
警示承載的屬性。 |
| properties.description |
string |
將包含在警示電子郵件中的計量警示描述。 |
| properties.enabled |
boolean |
指出是否已啟用度量警示的旗標。 |
| properties.evaluationFrequency |
string (duration) |
評估度量警示的頻率,以 ISO 8601 持續時間格式表示。 |
| properties.isMigrated |
boolean |
該值指示該警報規則是否已被遷移。 |
| properties.lastUpdatedTime |
string (date-time) |
上次規則更新為ISO8601格式。 |
| properties.resolveConfiguration |
如何解決警示的設定。 適用於PromQLCriteria。 |
|
| properties.scopes |
string[] |
此計量警示的範圍為的資源識別碼清單。 |
| properties.severity |
integer (int32) |
警示嚴重性 {0, 1, 2, 3, 4} |
| properties.targetResourceRegion |
string |
建立/更新警示的目標資源區域。 多資源多重衡量標準的強制要求。 |
| properties.targetResourceType |
string |
建立/更新警示的目標資源的資源類型。 多資源多重衡量標準的強制要求。 |
| properties.windowSize |
string (duration) |
用來根據臨界值監視警示活動的時間段 (ISO 8601 持續時間格式)。 |
| tags |
object |
資源標籤 |
MetricAlertSingleResourceMultipleMetricCriteria
指定單一資源的指標警示標準,該資源具有多個指標條件。
| 名稱 | 類型 | Description |
|---|---|---|
| allOf |
此「所有」作業的計量準則清單。 |
|
| odata.type |
string:
Microsoft. |
指定警示準則的類型。 先前未記載的值可能會傳回 |
MetricCriteria
篩選指標的標準。
| 名稱 | 類型 | Description |
|---|---|---|
| criterionType |
string:
Static |
指定臨界值準則的類型。 先前未記載的值可能會傳回 |
| dimensions |
維度條件的清單。 |
|
| metricName |
string |
計量的名稱。 |
| metricNamespace |
string |
計量Namespace。 |
| name |
string |
準則的名稱。 |
| operator |
criteria 運算子。 先前未記載的值可能會傳回 |
|
| skipMetricValidation |
boolean |
允許在尚未發出的自定義計量上建立警示規則,方法是略過計量驗證。 |
| threshold |
number (double) |
啟動警示的準則臨界值。 |
| timeAggregation |
準則時間彙總類型。 先前未記載的值可能會傳回 |
MetricDimension
指定一個公制維度。
| 名稱 | 類型 | Description |
|---|---|---|
| name |
string |
維度的名稱。 |
| operator |
string |
維度運算子。 僅支援 'Include' 和 'Exclude' |
| values |
string[] |
維度值清單。 |
Operator
criteria 運算子。 先前未記載的值可能會傳回
| 值 | Description |
|---|---|
| Equals | |
| GreaterThan | |
| GreaterThanOrEqual | |
| LessThan | |
| LessThanOrEqual |
PromQLCriteria
指定 PromQL 對度量警示資源的標準。
| 名稱 | 類型 | Description |
|---|---|---|
| allOf | MultiPromQLCriteria[]: |
promQL 標準清單。 當滿足所有條件時,將發出警報。 |
| failingPeriods |
查詢型警示中失敗期間的設定。 |
|
| odata.type |
string:
Microsoft. |
指定警示準則的類型。 先前未記載的值可能會傳回 |
QueryFailingPeriods
查詢型警示中失敗期間的設定。
| 名稱 | 類型 | Description |
|---|---|---|
| for |
string (duration) |
觸發前必須啟用的時間量(以 ISO 8601 持續時間格式)警示。 |
ResolveConfiguration
| 名稱 | 類型 | Description |
|---|---|---|
| autoResolved |
boolean |
指出是否應自動解決警示 |
| timeToResolve |
string (duration) |
應自動解決警示的時間 (以 ISO 8601 持續時間格式) |
StaticPromQLCriteria
靜態舞會查詢的標準。
| 名稱 | 類型 | Description |
|---|---|---|
| criterionType |
string:
Static |
指定臨界值準則的類型。 先前未記載的值可能會傳回 |
| name |
string |
準則的名稱。 |
| query |
string |
用來評估警示規則的查詢 |
UserIdentityProperties
使用者指派身份的屬性。
| 名稱 | 類型 | Description |
|---|---|---|
| clientId |
string |
資源識別碼的客戶端ID。 |
| principalId |
string |
資源識別的主要標識碼。 |
WebtestLocationAvailabilityCriteria
指定網路測試資源的指標警示規則標準。
| 名稱 | 類型 | Description |
|---|---|---|
| componentId |
string |
Application Insights 資源標識符。 |
| failedLocationCount |
number |
失敗的位置數目。 |
| odata.type |
string:
Microsoft. |
指定警示準則的類型。 先前未記載的值可能會傳回 |
| webTestId |
string |
Application Insights Web 測試標識符。 |