共用方式為


Microsoft.Insights scheduledQueryRules 2018-04-16

言論

如需部署監視解決方案的指引,請參閱 使用 Bicep建立監視資源。

Bicep 資源定義

scheduledQueryRules 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Insights/scheduledQueryRules 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  location: 'string'
  name: 'string'
  properties: {
    action: {
      odata.type: 'string'
      // For remaining properties, see Action objects
    }
    autoMitigate: bool
    description: 'string'
    displayName: 'string'
    enabled: 'string'
    schedule: {
      frequencyInMinutes: int
      timeWindowInMinutes: int
    }
    source: {
      authorizedResources: [
        'string'
      ]
      dataSourceId: 'string'
      query: 'string'
      queryType: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

動作物件

設定 odata.type 屬性,以指定對象的類型。

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction,請使用:

{
  aznsAction: {
    actionGroup: [
      'string'
    ]
    customWebhookPayload: 'string'
    emailSubject: 'string'
  }
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
  severity: 'string'
  throttlingInMin: int
  trigger: {
    metricTrigger: {
      metricColumn: 'string'
      metricTriggerType: 'string'
      threshold: int
      thresholdOperator: 'string'
    }
    threshold: int
    thresholdOperator: 'string'
  }
}

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction,請使用:

{
  criteria: [
    {
      dimensions: [
        {
          name: 'string'
          operator: 'string'
          values: [
            'string'
          ]
        }
      ]
      metricName: 'string'
    }
  ]
  odata.type: 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'
}

屬性值

行動

名字 描述 價值
odata.type 針對 AlertingAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'。 針對 logToMetricAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'。 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

AlertingAction

名字 描述 價值
aznsAction Azure 動作群組參考。 AzNsActionGroup
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (必要)
嚴厲 警示的嚴重性 '0'
'1'
'2'
'3'
'4' (必要)
throttlingInMin 警示應進行節流或隱藏的時間(以分鐘為單位)。 int
觸發 導致警示規則的觸發條件。 TriggerCondition (必要)

AzNsActionGroup

名字 描述 價值
actionGroup Azure 動作群組參考。 string[]
customWebhookPayload 要針對 Azure 動作群組中所有 Webhook URI 傳送的自定義承載 字串
emailSubject Azure 動作群組中所有電子郵件標識碼的自定義主旨覆寫 字串

標準

名字 描述 價值
尺寸 用於建立計量的維度清單 維度[]
metricName 計量的名稱 字串 (必要)

尺寸

名字 描述 價值
名字 維度的名稱 字串 (必要)
算子 維度值的運算符 'Include' (必要)
維度值清單 string[] (必要)

LogMetricTrigger

名字 描述 價值
metricColumn 評估特定數據行上的計量 字串
metricTriggerType 計量觸發程序類型 - 'Consecutive' 或 'Total' 'Consecutive'
'Total'
門檻 計量觸發程式的臨界值。 int
thresholdOperator 計量 -'GreaterThan' 或 'LessThan' 或 'Equal' 的評估作業。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogSearchRule

名字 描述 價值
行動 必須在規則執行時採取動作。 行動(必要)
autoMitigate 指出是否應該自動解決警示的旗標。 默認值為 false。 bool
描述 記錄搜尋規則的描述。 字串
displayName 警示規則的顯示名稱 字串
啟用 指出是否啟用記錄搜尋規則的旗標。 值應該是 true 或 false 'false'
'true'
附表 規則的排程(頻率、時間範圍)。 動作類型的必要專案 - AlertingAction 排程
數據源會根據哪個規則查詢數據 來源(必要)

LogToMetricAction

名字 描述 價值
標準 計量準則 準則[] (必要)
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

Microsoft.Insights/scheduledQueryRules

名字 描述 價值
位置 資源位置 字串 (必要)
名字 資源名稱 字串 (必要)
性能 資源的規則屬性。 LogSearchRule (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

ResourceTags

名字 描述 價值

附表

名字 描述 價值
frequencyInMinutes 應該評估規則條件的頻率(以分鐘為單位)。 int (必要)
timeWindowInMinutes 需要擷取查詢數據的時間範圍(應大於或等於 frequencyInMinutes)。 int (必要)

名字 描述 價值
authorizedResources 查詢中參考的資源清單 string[]
dataSourceId 要執行記錄搜尋查詢的資源 URI。 字串 (必要)
查詢 記錄搜尋查詢。 動作類型的必要專案 - AlertingAction 字串
queryType 將值設定為 'ResultCount' 。 'ResultCount'

TriggerCondition

名字 描述 價值
metricTrigger 計量查詢規則的觸發條件 LogMetricTrigger
門檻 應根據應觸發規則的結果或計數臨界值。 int (必要)
thresholdOperator 規則的評估作業 - 'GreaterThan' 或 'LessThan。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (必要)

ARM 樣本資源定義

scheduledQueryRules 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Insights/scheduledQueryRules 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2018-04-16",
  "name": "string",
  "location": "string",
  "properties": {
    "action": {
      "odata.type": "string"
      // For remaining properties, see Action objects
    },
    "autoMitigate": "bool",
    "description": "string",
    "displayName": "string",
    "enabled": "string",
    "schedule": {
      "frequencyInMinutes": "int",
      "timeWindowInMinutes": "int"
    },
    "source": {
      "authorizedResources": [ "string" ],
      "dataSourceId": "string",
      "query": "string",
      "queryType": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

動作物件

設定 odata.type 屬性,以指定對象的類型。

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction,請使用:

{
  "aznsAction": {
    "actionGroup": [ "string" ],
    "customWebhookPayload": "string",
    "emailSubject": "string"
  },
  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
  "severity": "string",
  "throttlingInMin": "int",
  "trigger": {
    "metricTrigger": {
      "metricColumn": "string",
      "metricTriggerType": "string",
      "threshold": "int",
      "thresholdOperator": "string"
    },
    "threshold": "int",
    "thresholdOperator": "string"
  }
}

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction,請使用:

{
  "criteria": [
    {
      "dimensions": [
        {
          "name": "string",
          "operator": "string",
          "values": [ "string" ]
        }
      ],
      "metricName": "string"
    }
  ],
  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}

屬性值

行動

名字 描述 價值
odata.type 針對 AlertingAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'。 針對 logToMetricAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'。 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

AlertingAction

名字 描述 價值
aznsAction Azure 動作群組參考。 AzNsActionGroup
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (必要)
嚴厲 警示的嚴重性 '0'
'1'
'2'
'3'
'4' (必要)
throttlingInMin 警示應進行節流或隱藏的時間(以分鐘為單位)。 int
觸發 導致警示規則的觸發條件。 TriggerCondition (必要)

AzNsActionGroup

名字 描述 價值
actionGroup Azure 動作群組參考。 string[]
customWebhookPayload 要針對 Azure 動作群組中所有 Webhook URI 傳送的自定義承載 字串
emailSubject Azure 動作群組中所有電子郵件標識碼的自定義主旨覆寫 字串

標準

名字 描述 價值
尺寸 用於建立計量的維度清單 維度[]
metricName 計量的名稱 字串 (必要)

尺寸

名字 描述 價值
名字 維度的名稱 字串 (必要)
算子 維度值的運算符 'Include' (必要)
維度值清單 string[] (必要)

LogMetricTrigger

名字 描述 價值
metricColumn 評估特定數據行上的計量 字串
metricTriggerType 計量觸發程序類型 - 'Consecutive' 或 'Total' 'Consecutive'
'Total'
門檻 計量觸發程式的臨界值。 int
thresholdOperator 計量 -'GreaterThan' 或 'LessThan' 或 'Equal' 的評估作業。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogSearchRule

名字 描述 價值
行動 必須在規則執行時採取動作。 行動(必要)
autoMitigate 指出是否應該自動解決警示的旗標。 默認值為 false。 bool
描述 記錄搜尋規則的描述。 字串
displayName 警示規則的顯示名稱 字串
啟用 指出是否啟用記錄搜尋規則的旗標。 值應該是 true 或 false 'false'
'true'
附表 規則的排程(頻率、時間範圍)。 動作類型的必要專案 - AlertingAction 排程
數據源會根據哪個規則查詢數據 來源(必要)

LogToMetricAction

名字 描述 價值
標準 計量準則 準則[] (必要)
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

Microsoft.Insights/scheduledQueryRules

名字 描述 價值
apiVersion API 版本 '2018-04-16'
位置 資源位置 字串 (必要)
名字 資源名稱 字串 (必要)
性能 資源的規則屬性。 LogSearchRule (必要)
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.Insights/scheduledQueryRules'

ResourceTags

名字 描述 價值

附表

名字 描述 價值
frequencyInMinutes 應該評估規則條件的頻率(以分鐘為單位)。 int (必要)
timeWindowInMinutes 需要擷取查詢數據的時間範圍(應大於或等於 frequencyInMinutes)。 int (必要)

名字 描述 價值
authorizedResources 查詢中參考的資源清單 string[]
dataSourceId 要執行記錄搜尋查詢的資源 URI。 字串 (必要)
查詢 記錄搜尋查詢。 動作類型的必要專案 - AlertingAction 字串
queryType 將值設定為 'ResultCount' 。 'ResultCount'

TriggerCondition

名字 描述 價值
metricTrigger 計量查詢規則的觸發條件 LogMetricTrigger
門檻 應根據應觸發規則的結果或計數臨界值。 int (必要)
thresholdOperator 規則的評估作業 - 'GreaterThan' 或 'LessThan。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (必要)

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
為 azure 商務持續性專案建立警示規則

部署至 Azure
此範本會建立警示規則和使用者指派的 MSI。 它也會將 MSI 讀取器存取權指派給訂用帳戶,讓警示規則能夠存取查詢所需的受保護專案和最新的恢復點詳細數據。

Terraform (AzAPI 提供者) 資源定義

scheduledQueryRules 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.Insights/scheduledQueryRules 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2018-04-16"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      action = {
        odata.type = "string"
        // For remaining properties, see Action objects
      }
      autoMitigate = bool
      description = "string"
      displayName = "string"
      enabled = "string"
      schedule = {
        frequencyInMinutes = int
        timeWindowInMinutes = int
      }
      source = {
        authorizedResources = [
          "string"
        ]
        dataSourceId = "string"
        query = "string"
        queryType = "string"
      }
    }
  })
}

動作物件

設定 odata.type 屬性,以指定對象的類型。

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction,請使用:

{
  aznsAction = {
    actionGroup = [
      "string"
    ]
    customWebhookPayload = "string"
    emailSubject = "string"
  }
  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
  severity = "string"
  throttlingInMin = int
  trigger = {
    metricTrigger = {
      metricColumn = "string"
      metricTriggerType = "string"
      threshold = int
      thresholdOperator = "string"
    }
    threshold = int
    thresholdOperator = "string"
  }
}

針對 Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction,請使用:

{
  criteria = [
    {
      dimensions = [
        {
          name = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      ]
      metricName = "string"
    }
  ]
  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction"
}

屬性值

行動

名字 描述 價值
odata.type 針對 AlertingAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'。 針對 logToMetricAction 類型,設定為 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction'。 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

AlertingAction

名字 描述 價值
aznsAction Azure 動作群組參考。 AzNsActionGroup
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (必要)
嚴厲 警示的嚴重性 '0'
'1'
'2'
'3'
'4' (必要)
throttlingInMin 警示應進行節流或隱藏的時間(以分鐘為單位)。 int
觸發 導致警示規則的觸發條件。 TriggerCondition (必要)

AzNsActionGroup

名字 描述 價值
actionGroup Azure 動作群組參考。 string[]
customWebhookPayload 要針對 Azure 動作群組中所有 Webhook URI 傳送的自定義承載 字串
emailSubject Azure 動作群組中所有電子郵件標識碼的自定義主旨覆寫 字串

標準

名字 描述 價值
尺寸 用於建立計量的維度清單 維度[]
metricName 計量的名稱 字串 (必要)

尺寸

名字 描述 價值
名字 維度的名稱 字串 (必要)
算子 維度值的運算符 'Include' (必要)
維度值清單 string[] (必要)

LogMetricTrigger

名字 描述 價值
metricColumn 評估特定數據行上的計量 字串
metricTriggerType 計量觸發程序類型 - 'Consecutive' 或 'Total' 'Consecutive'
'Total'
門檻 計量觸發程式的臨界值。 int
thresholdOperator 計量 -'GreaterThan' 或 'LessThan' 或 'Equal' 的評估作業。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogSearchRule

名字 描述 價值
行動 必須在規則執行時採取動作。 行動(必要)
autoMitigate 指出是否應該自動解決警示的旗標。 默認值為 false。 bool
描述 記錄搜尋規則的描述。 字串
displayName 警示規則的顯示名稱 字串
啟用 指出是否啟用記錄搜尋規則的旗標。 值應該是 true 或 false 'false'
'true'
附表 規則的排程(頻率、時間範圍)。 動作類型的必要專案 - AlertingAction 排程
數據源會根據哪個規則查詢數據 來源(必要)

LogToMetricAction

名字 描述 價值
標準 計量準則 準則[] (必要)
odata.type 指定動作。 支援的值 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必要)

Microsoft.Insights/scheduledQueryRules

名字 描述 價值
位置 資源位置 字串 (必要)
名字 資源名稱 字串 (必要)
性能 資源的規則屬性。 LogSearchRule (必要)
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.Insights/scheduledQueryRules@2018-04-16”

ResourceTags

名字 描述 價值

附表

名字 描述 價值
frequencyInMinutes 應該評估規則條件的頻率(以分鐘為單位)。 int (必要)
timeWindowInMinutes 需要擷取查詢數據的時間範圍(應大於或等於 frequencyInMinutes)。 int (必要)

名字 描述 價值
authorizedResources 查詢中參考的資源清單 string[]
dataSourceId 要執行記錄搜尋查詢的資源 URI。 字串 (必要)
查詢 記錄搜尋查詢。 動作類型的必要專案 - AlertingAction 字串
queryType 將值設定為 'ResultCount' 。 'ResultCount'

TriggerCondition

名字 描述 價值
metricTrigger 計量查詢規則的觸發條件 LogMetricTrigger
門檻 應根據應觸發規則的結果或計數臨界值。 int (必要)
thresholdOperator 規則的評估作業 - 'GreaterThan' 或 'LessThan。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (必要)