Microsoft.Insights scheduledQueryRules

發行項
09/21/2023

Bicep 資源定義

scheduledQueryRules 資源類型可以使用目標為的作業進行部署：

資源群組 - 請參閱資源群組部署命令

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

備註

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

資源格式

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2023-03-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      actionProperties: {}
      customProperties: {}
    }
    autoMitigate: bool
    checkWorkspaceAlertsStorageConfigured: bool
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          metricName: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    ruleResolveConfiguration: {
      autoResolved: bool
      timeToResolve: 'string'
    }
    scopes: [
      'string'
    ]
    severity: int
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

屬性值

scheduledQueryRules

名稱	描述	值
NAME	資源名稱	字串 (必要) 字元限制：1-260 有效字元：不能使用： `*<>%{}&:\\?/#` 或控制字元不能以空格或句號結尾。
location	資源所在的地理位置	字串 (必要)
tags	資源標籤。	標記名稱和值的字典。請參閱範本中的標記
kind	指出已排程查詢規則的類型。預設值為 LogAlert。	'LogAlert' 'LogToMetric'
身分識別	資源的身分識別。	身分識別
properties	資源的規則屬性。	ScheduledQueryRuleProperties (必要)

Identity

名称	描述	值
類型	受控服務識別的類型。	'None' 'SystemAssigned' 'UserAssigned' (必要)
userAssignedIdentities	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	object

ScheduledQueryRuleProperties

名稱	描述	值
動作	警示引發時要叫用的動作。	動作
autoMitigate	旗標，指出是否應該自動解決警示。預設值是 true。僅適用于 LogAlert 類型的規則。	bool
checkWorkspaceAlertsStorageConfigured	旗標，指出此排程的查詢規則是否應該儲存在客戶的儲存體中。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
準則	定義排程查詢規則條件的規則準則。	ScheduledQueryRuleCriteria
description	排程查詢規則的描述。	字串
displayName	警示規則的顯示名稱	字串
已啟用	指出是否啟用此排程查詢規則的旗標。值應為 true 或 false	bool
evaluationFrequency	排程查詢規則的評估頻率是以 ISO 8601 持續時間格式表示。只有 LogAlert 類型的規則才相關且必要。	字串
muteActionsDuration	在引發警示之後) ，以 ISO 8601 持續時間格式將所選時段的動作設為靜音 (。僅適用于 LogAlert 類型的規則。	字串
overrideQueryTimeRange	如果指定，則會覆寫查詢時間範圍， (預設值為 WindowSize*NumberOfEvaluationPeriods) 。僅適用于 LogAlert 類型的規則。	字串
ruleResolveConfiguration	定義用來解析引發警示的組態。僅適用于 LogAlert 類型的規則。	RuleResolveConfiguration
範圍	此排程查詢規則的範圍是資源識別碼的清單。	string[]
嚴重程度	警示的嚴重性。應該是介於 [0-4] 之間的整數。值為 0 最嚴重。只有 LogAlert 類型的規則才相關且必要。	int
skipQueryValidation	旗標，指出是否應該驗證提供的查詢。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
targetResourceTypes	建立/更新警示的目標資源 () 的資源類型清單。例如，如果範圍是資源群組，且 targetResourceTypes 是 Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機器引發不同的警示。僅適用于 LogAlert 類型的規則	string[]
windowSize	ISO 8601 持續時間格式 (期間) ，警示查詢 (將在間隔大小) 執行。只有 LogAlert 類型的規則才相關且必要。	字串

[動作]

名稱	描述	值
actionGroups	警示引發時要叫用的動作群組資源識別碼。	string[]
actionProperties	動作屬性的屬性。	object
customProperties	警示承載的屬性。	object

ScheduledQueryRuleCriteria

名稱	描述	值
allOf	要根據指定範圍評估的條件清單	Condition[]

條件

名稱	描述	值
dimensions	維度條件清單	Dimension[]
failingPeriods	在引發警示所需的所選回溯時間範圍內，所需的違規次數下限。僅適用于 LogAlert 類型的規則。	ConditionFailingPeriods
metricMeasureColumn	包含計量量值編號的資料行。僅適用于 LogAlert 類型的規則。	字串
metricName	要傳送之計量的名稱。只有 LogToMetric 類型的規則才相關且必要。	字串
! 運算子之後	criteria 運算子。只有 LogAlert 類型的規則才相關且必要。	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual'
查詢	記錄查詢警示	字串
resourceIdColumn	包含資源識別碼的資料行。資料行的內容必須是格式化為資源識別碼的 URI。僅適用于 LogAlert 類型的規則。	字串
threshold	啟動警示的準則閾值。只有 LogAlert 類型的規則才相關且必要。	int
timeAggregation	匯總類型。只有 LogAlert 類型的規則才相關且必要。	'Average' 'Count' 'Maximum' 'Minimum' 'Total'

尺寸

名稱	描述	值
NAME	維度的名稱	需要字串 ()
! 運算子之後	維度值的運算子	'Exclude' 需要 'Include' ()
值	維度值清單	string[] (必要)

ConditionFailingPeriods

名稱	描述	值
minFailingPeriodsToAlert	觸發警示的違規次數。應小於或等於 numberOfEvaluationPeriods。預設值為 1	int
numberOfEvaluationPeriods	匯總回溯點的數目。回溯時間範圍是根據匯總資料細微性計算， (windowSize) 和選取的匯總點數目。預設值為 1	int

RuleResolveConfiguration

名稱	描述	值
autoResolved	旗標，指出是否要自動解決引發的警示。	bool
timeToResolve	規則必須評估為狀況良好的持續時間，才會自動解析引發的警示，以 ISO 8601 持續時間格式表示。	字串

ARM 範本資源定義

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

資源群組 - 請參閱資源群組部署命令

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

備註

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

資源格式

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2023-03-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "actionProperties": {},
      "customProperties": {}
    },
    "autoMitigate": "bool",
    "checkWorkspaceAlertsStorageConfigured": "bool",
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "metricName": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "ruleResolveConfiguration": {
      "autoResolved": "bool",
      "timeToResolve": "string"
    },
    "scopes": [ "string" ],
    "severity": "int",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

屬性值

scheduledQueryRules

名稱	描述	值
類型	資源類型	'Microsoft.Insights/scheduledQueryRules'
apiVersion	資源 API 版本	'2023-03-15-preview'
NAME	資源名稱	需要字串 () 字元限制：1-260 有效字元：不能使用： `*<>%{}&:\\?/#` 或控制字元不能以空格或句號結尾。
location	資源所在的地理位置	需要字串 ()
tags	資源標籤。	標記名稱和值的字典。請參閱範本中的標籤
kind	指出排程查詢規則的類型。預設值為 LogAlert。	'LogAlert' 'LogToMetric'
身分識別	資源的身分識別。	身分識別
properties	資源的規則屬性。	ScheduledQueryRuleProperties (必要)

Identity

名称	描述	值
類型	受控服務識別的類型。	'None' 'SystemAssigned' 'UserAssigned' (必要)
userAssignedIdentities	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	object

ScheduledQueryRuleProperties

名稱	描述	值
動作	警示引發時要叫用的動作。	動作
autoMitigate	旗標，指出是否應該自動解決警示。預設值是 true。僅適用于 LogAlert 類型的規則。	bool
checkWorkspaceAlertsStorageConfigured	旗標，指出是否應該將此排程查詢規則儲存在客戶的儲存體中。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
準則	定義排程查詢規則條件的規則準則。	ScheduledQueryRuleCriteria
description	排程查詢規則的描述。	字串
displayName	警示規則的顯示名稱	字串
已啟用	旗標，指出是否啟用此排程查詢規則。值應為 true 或 false	bool
evaluationFrequency	以 ISO 8601 持續時間格式來評估排程查詢規則的頻率。只有 LogAlert 類型的規則才相關且必要。	字串
muteActionsDuration	在引發警示之後，以 ISO 8601 持續時間格式 (將所選時段的動作設為靜音) 。僅適用于 LogAlert 類型的規則。	字串
overrideQueryTimeRange	如果指定，則會覆寫查詢時間範圍， (預設值為 WindowSize*NumberOfEvaluationPeriods) 。僅適用于 LogAlert 類型的規則。	字串
ruleResolveConfiguration	定義用來解析引發警示的組態。僅適用于 LogAlert 類型的規則。	RuleResolveConfiguration
範圍	此排程查詢規則的範圍是資源識別碼的清單。	string[]
嚴重程度	警示的嚴重性。應該是介於 [0-4] 之間的整數。值為 0 最嚴重。只有 LogAlert 類型的規則才相關且必要。	int
skipQueryValidation	旗標，指出是否應該驗證提供的查詢。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
targetResourceTypes	建立/更新警示的目標資源 () 的資源類型清單。例如，如果範圍是資源群組，且 targetResourceTypes 是 Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機器引發不同的警示。僅適用于 LogAlert 類型的規則	string[]
windowSize	ISO 8601 持續時間格式 (期間) ，警示查詢 (將在間隔大小) 執行。只有 LogAlert 類型的規則才相關且必要。	字串

[動作]

名稱	描述	值
actionGroups	警示引發時要叫用的動作群組資源識別碼。	string[]
actionProperties	動作屬性的屬性。	object
customProperties	警示承載的屬性。	object

ScheduledQueryRuleCriteria

名稱	描述	值
allOf	要根據指定範圍評估的條件清單	Condition[]

條件

名稱	描述	值
dimensions	維度條件清單	Dimension[]
failingPeriods	在引發警示所需的所選回溯時間範圍內，所需的違規次數下限。僅適用于 LogAlert 類型的規則。	ConditionFailingPeriods
metricMeasureColumn	包含計量量值編號的資料行。僅適用于 LogAlert 類型的規則。	字串
metricName	要傳送之計量的名稱。只有 LogToMetric 類型的規則才相關且必要。	字串
! 運算子之後	criteria 運算子。只有 LogAlert 類型的規則才相關且必要。	'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual'
查詢	記錄查詢警示	字串
resourceIdColumn	包含資源識別碼的資料行。資料行的內容必須是格式化為資源識別碼的 URI。僅適用于 LogAlert 類型的規則。	字串
threshold	啟動警示的準則閾值。只有 LogAlert 類型的規則才相關且必要。	int
timeAggregation	匯總類型。只有 LogAlert 類型的規則才相關且必要。	'Average' 'Count' 'Maximum' 'Minimum' 'Total'

尺寸

名稱	描述	值
NAME	維度的名稱	需要字串 ()
! 運算子之後	維度值的運算子	'Exclude' 需要 'Include' ()
值	維度值清單	string[] (必要)

ConditionFailingPeriods

名稱	描述	值
minFailingPeriodsToAlert	觸發警示的違規次數。應小於或等於 numberOfEvaluationPeriods。預設值為 1	int
numberOfEvaluationPeriods	匯總回溯點的數目。回溯時間範圍是根據匯總資料細微性計算， (windowSize) 和選取的匯總點數目。預設值為 1	int

RuleResolveConfiguration

名稱	描述	值
autoResolved	旗標，指出是否要自動解決引發的警示。	bool
timeToResolve	規則必須評估為狀況良好的持續時間，才會自動解析引發的警示，以 ISO 8601 持續時間格式表示。	字串

Terraform (AzAPI 提供者) 資源定義

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

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2023-03-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        actionProperties = {}
        customProperties = {}
      }
      autoMitigate = bool
      checkWorkspaceAlertsStorageConfigured = bool
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            metricName = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      ruleResolveConfiguration = {
        autoResolved = bool
        timeToResolve = "string"
      }
      scopes = [
        "string"
      ]
      severity = int
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
    kind = "string"
  })
}

屬性值

scheduledQueryRules

名稱	描述	值
類型	資源類型	「Microsoft.Insights/scheduledQueryRules@2023-03-15-preview」
NAME	資源名稱	需要字串 () 字元限制：1-260 有效字元：不能使用： `*<>%{}&:\\?/#` 或控制字元不能以空格或句號結尾。
location	資源所在的地理位置	需要字串 ()
parent_id	若要部署至資源群組，請使用該資源群組的識別碼。	需要字串 ()
tags	資源標籤。	標記名稱和值的字典。
kind	指出排程查詢規則的類型。預設值為 LogAlert。	「LogAlert」「LogToMetric」
身分識別	資源的身分識別。	身分識別
properties	資源的規則屬性。	ScheduledQueryRuleProperties (必要)

Identity

名称	描述	值
類型	受控服務識別的類型。	「SystemAssigned」 ) 所需的「UserAssigned」 (
identity_ids	與資源相關聯的使用者身分識別清單。使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。	使用者身分識別識別碼的陣列。

ScheduledQueryRuleProperties

名稱	描述	值
動作	警示引發時要叫用的動作。	動作
autoMitigate	旗標，指出是否應該自動解決警示。預設值是 true。僅適用于 LogAlert 類型的規則。	bool
checkWorkspaceAlertsStorageConfigured	旗標，指出此排程的查詢規則是否應該儲存在客戶的儲存體中。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
準則	定義排程查詢規則條件的規則準則。	ScheduledQueryRuleCriteria
description	排程查詢規則的描述。	字串
displayName	警示規則的顯示名稱	字串
已啟用	指出是否啟用此排程查詢規則的旗標。值應為 true 或 false	bool
evaluationFrequency	排程查詢規則的評估頻率是以 ISO 8601 持續時間格式表示。只有 LogAlert 類型的規則才相關且必要。	字串
muteActionsDuration	在引發警示之後) ，以 ISO 8601 持續時間格式將所選時段的動作設為靜音 (。僅適用于 LogAlert 類型的規則。	字串
overrideQueryTimeRange	如果指定，則會覆寫查詢時間範圍 (預設值為 WindowSize*NumberOfEvaluationPeriods) 。僅適用于 LogAlert 類型的規則。	字串
ruleResolveConfiguration	定義解決引發警示的組態。僅適用于 LogAlert 類型的規則。	RuleResolveConfiguration
範圍	此排程查詢規則的範圍為的資源識別碼清單。	string[]
嚴重程度	警示的嚴重性。應該是介於 [0-4] 之間的整數。值為 0 最嚴重。只有 LogAlert 類型的規則才相關且必要。	int
skipQueryValidation	旗標，指出是否應該驗證提供的查詢。預設值為 false。僅適用于 LogAlert 類型的規則。	bool
targetResourceTypes	建立/更新警示的目標資源 () 的資源類型清單。例如，如果範圍是資源群組，而 targetResourceTypes 是 Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機器引發不同的警示。僅與 LogAlert 類型的規則相關	string[]
windowSize	ISO 8601 持續時間格式 (期間) ，警示查詢將會執行 (間隔大小) 。只有 LogAlert 類型的規則才相關且必要。	字串

[動作]

名稱	描述	值
actionGroups	動作群組資源識別碼，以在警示引發時叫用。	string[]
actionProperties	動作屬性的屬性。	object
customProperties	警示承載的屬性。	object

ScheduledQueryRuleCriteria

名稱	描述	值
allOf	要根據指定範圍評估的條件清單	Condition[]

條件

名稱	描述	值
dimensions	維度條件清單	Dimension[]
failingPeriods	引發警示所需的所選回溯時間範圍內所需的違規數目下限。僅適用于 LogAlert 類型的規則。	ConditionFailingPeriods
metricMeasureColumn	包含計量量值編號的資料行。僅適用于 LogAlert 類型的規則。	字串
metricName	要傳送的計量名稱。只有 LogToMetric 類型的規則才相關且必要。	字串
! 運算子之後	criteria 運算子。只有 LogAlert 類型的規則才相關且必要。	「Equals」「GreaterThan」「GreaterThanOrEqual」「LessThan」「LessThanOrEqual」
查詢	記錄查詢警示	字串
resourceIdColumn	包含資源識別碼的資料行。資料行的內容必須是格式化為資源識別碼的 URI。僅適用于 LogAlert 類型的規則。	字串
threshold	啟動警示的準則臨界值。只有 LogAlert 類型的規則才相關且必要。	int
timeAggregation	匯總類型。只有 LogAlert 類型的規則才相關且必要。	「Average」「Count」「最大值」「Minimum」「Total」

尺寸

名稱	描述	值
NAME	維度的名稱	字串 (必要)
! 運算子之後	維度值的運算子	「Exclude」「包含」 (必要)
值	維度值清單	string[] (必要)

ConditionFailingPeriods

名稱	描述	值
minFailingPeriodsToAlert	觸發警示的違規次數。應小於或等於 numberOfEvaluationPeriods。預設值為 1	int
numberOfEvaluationPeriods	匯總回溯點的數目。回溯時間範圍是根據匯總資料細微性計算， (windowSize) 和選取的匯總點數目。預設值為 1	int

RuleResolveConfiguration

名稱	描述	值
autoResolved	旗標，指出是否要自動解決引發的警示。	bool
timeToResolve	規則必須在引發的警示自動解決以 ISO 8601 持續時間格式表示之前，評估為狀況良好的持續時間。	字串

Microsoft.Insights scheduledQueryRules

Bicep 資源定義

備註

資源格式

屬性值

scheduledQueryRules

Identity

ScheduledQueryRuleProperties

[動作]

ScheduledQueryRuleCriteria

條件

尺寸

ConditionFailingPeriods

RuleResolveConfiguration

ARM 範本資源定義

備註

資源格式

屬性值

scheduledQueryRules

Identity

ScheduledQueryRuleProperties

[動作]

ScheduledQueryRuleCriteria

條件

尺寸

ConditionFailingPeriods

RuleResolveConfiguration

Terraform (AzAPI 提供者) 資源定義

資源格式

屬性值

scheduledQueryRules

Identity

ScheduledQueryRuleProperties

[動作]

ScheduledQueryRuleCriteria

條件

尺寸

ConditionFailingPeriods

RuleResolveConfiguration

意見反應

意見反應

其他資源