共用方式為


Metric Alerts - Get

擷取警示規則定義。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}?api-version=2018-03-01

URI 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

ruleName
path True

string

規則的名稱。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

要用於這項作業的 API 版本。

回應

名稱 類型 Description
200 OK

MetricAlertResource

計量警示清單的成功要求

Other Status Codes

ErrorResponse

BadRequest

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Get a dynamic alert rule for multiple resources
Get a dynamic alert rule for single resource
Get a web test alert rule
Get an alert rule for multiple resources
Get an alert rule for single resource
Get an alert rule on resource group(s)
Get an alert rule on subscription

Get a dynamic alert rule for multiple resources

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertOnMultipleResources?api-version=2018-03-01

範例回覆

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertOnMultipleResources",
  "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/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme1",
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme2"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "targetResourceRegion": "southcentralus",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "DynamicThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterOrLessThan",
          "timeAggregation": "Average",
          "dimensions": [],
          "alertSensitivity": "Medium",
          "failingPeriods": {
            "numberOfEvaluationPeriods": 4,
            "minFailingPeriodsToAlert": 4
          }
        }
      ]
    },
    "autoMitigate": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Get a dynamic alert rule for single resource

範例要求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01

範例回覆

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "DynamicThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "operator": "GreaterOrLessThan",
          "timeAggregation": "Average",
          "dimensions": [],
          "alertSensitivity": "Medium",
          "failingPeriods": {
            "numberOfEvaluationPeriods": 4,
            "minFailingPeriodsToAlert": 4
          },
          "ignoreDataBefore": null
        }
      ]
    },
    "autoMitigate": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Get a web test alert rule

範例要求

GET https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789101/resourceGroups/rg-example/providers/Microsoft.Insights/metricAlerts/webtest-name-example?api-version=2018-03-01

範例回覆

{
  "location": "global",
  "type": "Microsoft.Insights/metricAlerts",
  "name": "webtest-name-example",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/metricalerts/webtest-name-example",
  "tags": {
    "hidden-link:/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example": "Resource",
    "hidden-link:/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example": "Resource"
  },
  "properties": {
    "description": "Automatically created alert rule for availability test \"webtest-name-example\"",
    "severity": 4,
    "enabled": true,
    "scopes": [
      "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example",
      "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "criteria": {
      "webTestId": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/webtests/webtest-name-example",
      "componentId": "/subscriptions/12345678-1234-1234-1234-123456789101/resourcegroups/rg-example/providers/microsoft.insights/components/component-example",
      "failedLocationCount": 2,
      "odata.type": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"
    },
    "actions": []
  }
}

Get an alert rule for multiple resources

範例要求

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertOnMultipleResources?api-version=2018-03-01

範例回覆

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertOnMultipleResources",
  "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/gigwadme1",
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Compute/virtualMachines/gigwadme2"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "targetResourceRegion": "southcentralus",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Get an alert rule for single resource

範例要求

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/chiricutin?api-version=2018-03-01

範例回覆

{
  "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": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Get an alert rule on resource group(s)

範例要求

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest1/providers/Microsoft.Insights/metricAlerts/MetricAlertAtResourceGroupLevel?api-version=2018-03-01

範例回覆

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest1/providers/providers/microsoft.insights/metricalerts/MetricAlertAtResourceGroupLevel",
  "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/gigtest1",
      "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest2"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "targetResourceRegion": "southcentralus",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

Get an alert rule on subscription

範例要求

GET https://management.azure.com/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/Microsoft.Insights/metricAlerts/MetricAlertAtSubscriptionLevel?api-version=2018-03-01

範例回覆

{
  "id": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourceGroups/gigtest/providers/providers/microsoft.insights/metricalerts/MetricAlertAtSubscriptionLevel",
  "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"
    ],
    "evaluationFrequency": "PT1M",
    "windowSize": "PT15M",
    "targetResourceType": "Microsoft.Compute/virtualMachines",
    "targetResourceRegion": "southcentralus",
    "criteria": {
      "odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
      "allOf": [
        {
          "criterionType": "StaticThresholdCriterion",
          "name": "High_CPU_80",
          "metricName": "Percentage CPU",
          "metricNamespace": "microsoft.compute/virtualmachines",
          "dimensions": [],
          "operator": "GreaterThan",
          "threshold": 80.5,
          "timeAggregation": "Average"
        }
      ]
    },
    "autoMitigate": false,
    "actions": [
      {
        "actionGroupId": "/subscriptions/14ddf0c5-77c5-4b53-84f6-e1fa43ad68f7/resourcegroups/gigtest/providers/microsoft.insights/actiongroups/group2",
        "webHookProperties": {
          "key11": "value11",
          "key12": "value12"
        }
      }
    ]
  }
}

定義

名稱 Description
AdditionalInfo

具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的,且相依於 'type' 字串。

AggregationTypeEnum

準則時間匯總類型。

DynamicMetricCriteria

動態閾值的準則。

DynamicThresholdFailingPeriods

引發警示所需的所選回溯時間範圍內所需的違規數目下限。

DynamicThresholdOperator

運算子,用來比較計量值與臨界值。

DynamicThresholdSensitivity

觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。

Error
ErrorDetail

描述錯誤回應的詳細數據。

ErrorResponse

描述錯誤回應的格式。

MetricAlertAction

警示動作。

MetricAlertMultipleResourceMultipleMetricCriteria

指定具有多個計量準則之多個資源的計量警示準則。

MetricAlertResource

計量警示資源。

MetricAlertSingleResourceMultipleMetricCriteria

指定具有多個計量準則之單一資源的計量警示準則。

MetricCriteria

篩選計量的準則。

MetricDimension

指定計量維度。

Operator

criteria 運算子。

WebtestLocationAvailabilityCriteria

指定 Web 測試資源的計量警示規則準則。

AdditionalInfo

具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的,且相依於 'type' 字串。

名稱 類型 Description
info

object

類型特有的其他資訊。

type

string

其他信息的類型。

AggregationTypeEnum

準則時間匯總類型。

名稱 類型 Description
Average

string

Count

string

Maximum

string

Minimum

string

Total

string

DynamicMetricCriteria

動態閾值的準則。

名稱 類型 Description
alertSensitivity

DynamicThresholdSensitivity

觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。

criterionType string:

DynamicThresholdCriterion

指定臨界值準則的類型

dimensions

MetricDimension[]

維度條件的清單。

failingPeriods

DynamicThresholdFailingPeriods

引發警示所需的所選回溯時間範圍內所需的違規數目下限。

ignoreDataBefore

string

使用此選項可設定開始學習計量歷程記錄資料的日期,並計算動態閾值(以ISO8601格式)

metricName

string

計量的名稱。

metricNamespace

string

計量的命名空間。

name

string

準則的名稱。

operator

DynamicThresholdOperator

運算子,用來比較計量值與臨界值。

skipMetricValidation

boolean

允許在尚未發出的自定義計量上建立警示規則,方法是略過計量驗證。

timeAggregation

AggregationTypeEnum

準則時間匯總類型。

DynamicThresholdFailingPeriods

引發警示所需的所選回溯時間範圍內所需的違規數目下限。

名稱 類型 Description
minFailingPeriodsToAlert

number

觸發警示的違規次數。 應小於或等於 numberOfEvaluationPeriods。

numberOfEvaluationPeriods

number

匯總回溯點的數目。 回溯時間範圍是根據匯總數據粒度 (windowSize) 和選取的匯總點數目來計算。

DynamicThresholdOperator

運算子,用來比較計量值與臨界值。

名稱 類型 Description
GreaterOrLessThan

string

GreaterThan

string

LessThan

string

DynamicThresholdSensitivity

觸發警示所需的偏差範圍。 這會影響臨界值與計量數列模式的緊密程度。

名稱 類型 Description
High

string

Low

string

Medium

string

Error

名稱 類型 Description
additionalInfo

AdditionalInfo[]

具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的,且相依於 'type' 字串。

code

string

未設定字串,可用來以程式設計方式識別錯誤。

details

ErrorDetail[]

其他巢狀錯誤回應資訊對象的陣列,如此合約所述。

message

string

詳細說明錯誤並提供偵錯資訊。 如果在要求中設定 Accept-Language,則必須將其當地語系化為該語言。

target

string

特定錯誤的目標(例如,錯誤中的屬性名稱)。

ErrorDetail

描述錯誤回應的詳細數據。

名稱 類型 Description
additionalInfo

AdditionalInfo[]

具有 'type' 和 'info' 屬性的物件陣列。 'info' 的架構是服務特定的,且相依於 'type' 字串。

code

string

未設定字串,可用來以程式設計方式識別錯誤。

message

string

詳細說明錯誤並提供偵錯資訊。

target

string

特定錯誤的目標(例如,錯誤中的屬性名稱)。

ErrorResponse

描述錯誤回應的格式。

名稱 類型 Description
error

Error

MetricAlertAction

警示動作。

名稱 類型 Description
actionGroupId

string

要使用的動作群組標識碼。

webHookProperties

object

此欄位允許指定自定義屬性,這會附加至傳送為 Webhook 輸入的警示承載。

MetricAlertMultipleResourceMultipleMetricCriteria

指定具有多個計量準則之多個資源的計量警示準則。

名稱 類型 Description
allOf MultiMetricCriteria[]:

此「所有」作業的多個計量準則清單。

odata.type string:

Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria

指定警示準則的類型。

MetricAlertResource

計量警示資源。

名稱 類型 Description
id

string

Azure 資源標識碼

location

string

資源位置

name

string

Azure 資源名稱

properties.actions

MetricAlertAction[]

當警示規則變成作用中,以及解決警示條件時所執行的動作陣列。

properties.autoMitigate

boolean

指出是否應該自動解決警示的旗標。 默認值為 true。

properties.criteria MetricAlertCriteria:

定義特定的警示準則資訊。

properties.description

string

將包含在警示電子郵件中的計量警示描述。

properties.enabled

boolean

指出是否啟用計量警示的旗標。

properties.evaluationFrequency

string

以 ISO 8601 持續時間格式來評估計量警示的頻率。

properties.isMigrated

boolean

值,指出是否已移轉此警示規則。

properties.lastUpdatedTime

string

上次以ISO8601格式更新規則的時間。

properties.scopes

string[]

資源標識碼的清單是此計量警示的範圍。

properties.severity

integer

警示嚴重性 {0, 1, 2, 3, 4}

properties.targetResourceRegion

string

建立/更新警示的目標資源區域。 如果範圍包含訂用帳戶、資源群組或多個資源,則為必要專案。

properties.targetResourceType

string

建立/更新警示的目標資源資源類型。 如果範圍包含訂用帳戶、資源群組或多個資源,則為必要專案。

properties.windowSize

string

以 ISO 8601 持續時間格式,用來根據閾值監視警示活動的時間週期。

tags

object

資源標籤

type

string

Azure 資源類型

MetricAlertSingleResourceMultipleMetricCriteria

指定具有多個計量準則之單一資源的計量警示準則。

名稱 類型 Description
allOf

MetricCriteria[]

此「所有」作業的計量準則清單。

odata.type string:

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria

指定警示準則的類型。

MetricCriteria

篩選計量的準則。

名稱 類型 Description
criterionType string:

StaticThresholdCriterion

指定臨界值準則的類型

dimensions

MetricDimension[]

維度條件的清單。

metricName

string

計量的名稱。

metricNamespace

string

計量的命名空間。

name

string

準則的名稱。

operator

Operator

criteria 運算子。

skipMetricValidation

boolean

允許在尚未發出的自定義計量上建立警示規則,方法是略過計量驗證。

threshold

number

啟動警示的準則臨界值。

timeAggregation

AggregationTypeEnum

準則時間匯總類型。

MetricDimension

指定計量維度。

名稱 類型 Description
name

string

維度的名稱。

operator

string

維度運算子。 僅支援 'Include' 和 'Exclude'

values

string[]

維度值的清單。

Operator

criteria 運算子。

名稱 類型 Description
Equals

string

GreaterThan

string

GreaterThanOrEqual

string

LessThan

string

LessThanOrEqual

string

WebtestLocationAvailabilityCriteria

指定 Web 測試資源的計量警示規則準則。

名稱 類型 Description
componentId

string

Application Insights 資源標識符。

failedLocationCount

number

失敗的位置數目。

odata.type string:

Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria

指定警示準則的類型。

webTestId

string

Application Insights Web 測試標識符。