Microsoft.Insights scheduledQueryRules 2020-05-01-preview
言論
如需部署監視解決方案的指引，請參閱 使用 Bicep建立監視資源。
Bicep 資源定義
scheduledQueryRules 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/scheduledQueryRules 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
location: 'string'
name: 'string'
properties: {
actions: [
{
actionGroupId: 'string'
webHookProperties: {
{customized property}: 'string'
}
}
]
criteria: {
allOf: [
{
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
failingPeriods: {
minFailingPeriodsToAlert: int
numberOfEvaluationPeriods: int
}
metricMeasureColumn: 'string'
operator: 'string'
query: 'string'
resourceIdColumn: 'string'
threshold: int
timeAggregation: 'string'
}
]
}
description: 'string'
displayName: 'string'
enabled: bool
evaluationFrequency: 'string'
muteActionsDuration: 'string'
overrideQueryTimeRange: 'string'
scopes: [
'string'
]
severity: int
targetResourceTypes: [
'string'
]
windowSize: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
行動
| 名字 | 描述 | 價值 |
|---|---|---|
| actionGroupId | 警示引發時要叫用的動作群組資源標識碼。 | 字串 |
| webHookProperties | Webhook 對象的屬性。 | ActionWebHookProperties |
ActionWebHookProperties
| 名字 | 描述 | 價值 |
|---|
條件
| 名字 | 描述 | 價值 |
|---|---|---|
| 尺寸 | 維度條件清單 | 維度[] |
| failingPeriods | 引發警示所需的所選回溯時間範圍內所需的違規數目下限。 | ConditionFailingPeriods |
| metricMeasureColumn | 包含計量量值編號的數據行。 | 字串 |
| 算子 | criteria 運算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' （必要） |
| 查詢 | 記錄查詢警示 | 字串 |
| resourceIdColumn | 包含資源標識碼的數據行。數據行的內容必須是格式化為資源標識碼的 URI | 字串 |
| 門檻 | 啟動警示的準則臨界值。 | int （必要） |
| timeAggregation | 匯總類型 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' （必要） |
ConditionFailingPeriods
| 名字 | 描述 | 價值 |
|---|---|---|
| minFailingPeriodsToAlert | 觸發警示的違規次數。 應小於或等於 numberOfEvaluationPeriods。 預設值為 1 | int |
| numberOfEvaluationPeriods | 匯總回溯點的數目。 回溯時間範圍是根據匯總數據粒度 （windowSize） 和選取的匯總點數目來計算。 預設值為 1 | int |
尺寸
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 維度的名稱 | 字串 （必要） |
| 算子 | 維度值的運算符 | 'Exclude' 'Include' （必要） |
| 值 | 維度值清單 | string[] （必要） |
Microsoft.Insights/scheduledQueryRules
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^#<>%&:\?/{}*]{1,260}$ （必要） |
| 性能 | 資源的規則屬性。 | ScheduledQueryRuleProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
ScheduledQueryRuleCriteria
| 名字 | 描述 | 價值 |
|---|---|---|
| allOf | 要根據指定範圍評估的條件清單 | 條件[] |
ScheduledQueryRuleProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 動作[] | |
| 標準 | 定義排程查詢規則條件的規則準則。 | ScheduledQueryRuleCriteria |
| 描述 | 排程查詢規則的描述。 | 字串 |
| displayName | 警示規則的顯示名稱 | 字串 |
| 啟用 | 指出是否啟用此排程查詢規則的旗標。 值應該是 true 或 false | bool |
| evaluationFrequency | 以 ISO 8601 持續時間格式來評估排程查詢規則的頻率。 | 字串 |
| muteActionsDuration | 在引發警示之後，將所選期間（ISO 8601 持續時間格式）的動作設為靜音。 | 字串 |
| overrideQueryTimeRange | 如果指定，則會覆寫查詢時間範圍（預設值為 WindowSize*NumberOfEvaluationPeriods） | 字串 |
| 範圍 | 此排程查詢規則的範圍是資源標識碼的清單。 | string[] |
| 嚴厲 | 警示的嚴重性。 應該是介於 [0-4] 之間的整數。 值為 0 最嚴重 | int |
| targetResourceTypes | 建立/更新警示之目標資源的資源類型清單。 例如，如果範圍是資源群組，且 targetResourceTypes 是Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機引發不同的警示 | string[] |
| windowSize | 警示查詢將執行的時間週期（以 ISO 8601 持續時間格式表示）。 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
ARM 樣本資源定義
scheduledQueryRules 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/scheduledQueryRules 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Insights/scheduledQueryRules",
"apiVersion": "2020-05-01-preview",
"name": "string",
"location": "string",
"properties": {
"actions": [
{
"actionGroupId": "string",
"webHookProperties": {
"{customized property}": "string"
}
}
],
"criteria": {
"allOf": [
{
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"failingPeriods": {
"minFailingPeriodsToAlert": "int",
"numberOfEvaluationPeriods": "int"
},
"metricMeasureColumn": "string",
"operator": "string",
"query": "string",
"resourceIdColumn": "string",
"threshold": "int",
"timeAggregation": "string"
}
]
},
"description": "string",
"displayName": "string",
"enabled": "bool",
"evaluationFrequency": "string",
"muteActionsDuration": "string",
"overrideQueryTimeRange": "string",
"scopes": [ "string" ],
"severity": "int",
"targetResourceTypes": [ "string" ],
"windowSize": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
行動
| 名字 | 描述 | 價值 |
|---|---|---|
| actionGroupId | 警示引發時要叫用的動作群組資源標識碼。 | 字串 |
| webHookProperties | Webhook 對象的屬性。 | ActionWebHookProperties |
ActionWebHookProperties
| 名字 | 描述 | 價值 |
|---|
條件
| 名字 | 描述 | 價值 |
|---|---|---|
| 尺寸 | 維度條件清單 | 維度[] |
| failingPeriods | 引發警示所需的所選回溯時間範圍內所需的違規數目下限。 | ConditionFailingPeriods |
| metricMeasureColumn | 包含計量量值編號的數據行。 | 字串 |
| 算子 | criteria 運算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' （必要） |
| 查詢 | 記錄查詢警示 | 字串 |
| resourceIdColumn | 包含資源標識碼的數據行。數據行的內容必須是格式化為資源標識碼的 URI | 字串 |
| 門檻 | 啟動警示的準則臨界值。 | int （必要） |
| timeAggregation | 匯總類型 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' （必要） |
ConditionFailingPeriods
| 名字 | 描述 | 價值 |
|---|---|---|
| minFailingPeriodsToAlert | 觸發警示的違規次數。 應小於或等於 numberOfEvaluationPeriods。 預設值為 1 | int |
| numberOfEvaluationPeriods | 匯總回溯點的數目。 回溯時間範圍是根據匯總數據粒度 （windowSize） 和選取的匯總點數目來計算。 預設值為 1 | int |
尺寸
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 維度的名稱 | 字串 （必要） |
| 算子 | 維度值的運算符 | 'Exclude' 'Include' （必要） |
| 值 | 維度值清單 | string[] （必要） |
Microsoft.Insights/scheduledQueryRules
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2020-05-01-preview' |
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^#<>%&:\?/{}*]{1,260}$ （必要） |
| 性能 | 資源的規則屬性。 | ScheduledQueryRuleProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.Insights/scheduledQueryRules' |
ScheduledQueryRuleCriteria
| 名字 | 描述 | 價值 |
|---|---|---|
| allOf | 要根據指定範圍評估的條件清單 | 條件[] |
ScheduledQueryRuleProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 動作[] | |
| 標準 | 定義排程查詢規則條件的規則準則。 | ScheduledQueryRuleCriteria |
| 描述 | 排程查詢規則的描述。 | 字串 |
| displayName | 警示規則的顯示名稱 | 字串 |
| 啟用 | 指出是否啟用此排程查詢規則的旗標。 值應該是 true 或 false | bool |
| evaluationFrequency | 以 ISO 8601 持續時間格式來評估排程查詢規則的頻率。 | 字串 |
| muteActionsDuration | 在引發警示之後，將所選期間（ISO 8601 持續時間格式）的動作設為靜音。 | 字串 |
| overrideQueryTimeRange | 如果指定，則會覆寫查詢時間範圍（預設值為 WindowSize*NumberOfEvaluationPeriods） | 字串 |
| 範圍 | 此排程查詢規則的範圍是資源標識碼的清單。 | string[] |
| 嚴厲 | 警示的嚴重性。 應該是介於 [0-4] 之間的整數。 值為 0 最嚴重 | int |
| targetResourceTypes | 建立/更新警示之目標資源的資源類型清單。 例如，如果範圍是資源群組，且 targetResourceTypes 是Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機引發不同的警示 | string[] |
| windowSize | 警示查詢將執行的時間週期（以 ISO 8601 持續時間格式表示）。 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
為 azure 商務持續性專案建立警示規則
|
此範本會建立警示規則和使用者指派的 MSI。 它也會將 MSI 讀取器存取權指派給訂用帳戶，讓警示規則能夠存取查詢所需的受保護專案和最新的恢復點詳細數據。 |
Terraform （AzAPI 提供者） 資源定義
scheduledQueryRules 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/scheduledQueryRules 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
actions = [
{
actionGroupId = "string"
webHookProperties = {
{customized property} = "string"
}
}
]
criteria = {
allOf = [
{
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
failingPeriods = {
minFailingPeriodsToAlert = int
numberOfEvaluationPeriods = int
}
metricMeasureColumn = "string"
operator = "string"
query = "string"
resourceIdColumn = "string"
threshold = int
timeAggregation = "string"
}
]
}
description = "string"
displayName = "string"
enabled = bool
evaluationFrequency = "string"
muteActionsDuration = "string"
overrideQueryTimeRange = "string"
scopes = [
"string"
]
severity = int
targetResourceTypes = [
"string"
]
windowSize = "string"
}
})
}
屬性值
行動
| 名字 | 描述 | 價值 |
|---|---|---|
| actionGroupId | 警示引發時要叫用的動作群組資源標識碼。 | 字串 |
| webHookProperties | Webhook 對象的屬性。 | ActionWebHookProperties |
ActionWebHookProperties
| 名字 | 描述 | 價值 |
|---|
條件
| 名字 | 描述 | 價值 |
|---|---|---|
| 尺寸 | 維度條件清單 | 維度[] |
| failingPeriods | 引發警示所需的所選回溯時間範圍內所需的違規數目下限。 | ConditionFailingPeriods |
| metricMeasureColumn | 包含計量量值編號的數據行。 | 字串 |
| 算子 | criteria 運算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' （必要） |
| 查詢 | 記錄查詢警示 | 字串 |
| resourceIdColumn | 包含資源標識碼的數據行。數據行的內容必須是格式化為資源標識碼的 URI | 字串 |
| 門檻 | 啟動警示的準則臨界值。 | int （必要） |
| timeAggregation | 匯總類型 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' （必要） |
ConditionFailingPeriods
| 名字 | 描述 | 價值 |
|---|---|---|
| minFailingPeriodsToAlert | 觸發警示的違規次數。 應小於或等於 numberOfEvaluationPeriods。 預設值為 1 | int |
| numberOfEvaluationPeriods | 匯總回溯點的數目。 回溯時間範圍是根據匯總數據粒度 （windowSize） 和選取的匯總點數目來計算。 預設值為 1 | int |
尺寸
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 維度的名稱 | 字串 （必要） |
| 算子 | 維度值的運算符 | 'Exclude' 'Include' （必要） |
| 值 | 維度值清單 | string[] （必要） |
Microsoft.Insights/scheduledQueryRules
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 資源所在的地理位置 | 字串 （必要） |
| 名字 | 資源名稱 | 字串 約束： 模式 = ^[^#<>%&:\?/{}*]{1,260}$ （必要） |
| 性能 | 資源的規則屬性。 | ScheduledQueryRuleProperties （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.Insights/scheduledQueryRules@2020-05-01-preview” |
ScheduledQueryRuleCriteria
| 名字 | 描述 | 價值 |
|---|---|---|
| allOf | 要根據指定範圍評估的條件清單 | 條件[] |
ScheduledQueryRuleProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 行動 | 動作[] | |
| 標準 | 定義排程查詢規則條件的規則準則。 | ScheduledQueryRuleCriteria |
| 描述 | 排程查詢規則的描述。 | 字串 |
| displayName | 警示規則的顯示名稱 | 字串 |
| 啟用 | 指出是否啟用此排程查詢規則的旗標。 值應該是 true 或 false | bool |
| evaluationFrequency | 以 ISO 8601 持續時間格式來評估排程查詢規則的頻率。 | 字串 |
| muteActionsDuration | 在引發警示之後，將所選期間（ISO 8601 持續時間格式）的動作設為靜音。 | 字串 |
| overrideQueryTimeRange | 如果指定，則會覆寫查詢時間範圍（預設值為 WindowSize*NumberOfEvaluationPeriods） | 字串 |
| 範圍 | 此排程查詢規則的範圍是資源標識碼的清單。 | string[] |
| 嚴厲 | 警示的嚴重性。 應該是介於 [0-4] 之間的整數。 值為 0 最嚴重 | int |
| targetResourceTypes | 建立/更新警示之目標資源的資源類型清單。 例如，如果範圍是資源群組，且 targetResourceTypes 是Microsoft.Compute/virtualMachines，則會針對符合警示準則的資源群組中的每個虛擬機引發不同的警示 | string[] |
| windowSize | 警示查詢將執行的時間週期（以 ISO 8601 持續時間格式表示）。 | 字串 |
TrackedResourceTags
| 名字 | 描述 | 價值 |
|---|