Microsoft.Insights scheduledQueryRules 2020-05-01-preview
Bicep リソース定義
scheduledQueryRules リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
備考
監視ソリューションのデプロイに関するガイダンスについては、「Bicepを使用した監視リソースの作成
リソースの形式
Microsoft.Insights/scheduledQueryRules リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
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'
}
}
プロパティ値
scheduledQueryRules
名前 | 形容 | 価値 |
---|---|---|
名前 | リソース名 | string (必須) 文字制限: 1 ~ 260 有効な文字: 使用できません: *<>%{}&:\\?/#| または制御文字スペースまたはピリオドで終えることはできません。 |
場所 | リソースが存在する地理的な場所 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
プロパティ | リソースのルール プロパティ。 | ScheduledQueryRuleProperties の |
ScheduledQueryRuleProperties
名前 | 形容 | 価値 |
---|---|---|
アクション | アクション[] | |
条件 | スケジュールされたクエリ ルールの条件を定義するルール条件。 | ScheduledQueryRuleCriteria の |
形容 | スケジュールされたクエリ ルールの説明。 | 糸 |
displayName | アラート ルールの表示名 | 糸 |
有効 | このスケジュールされたクエリ ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります | bool |
evaluationFrequency | スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 | 糸 |
muteActionsDuration | アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 | 糸 |
overrideQueryTimeRange | 指定した場合、クエリ時間範囲がオーバーライドされます (既定値は WindowSize*NumberOfEvaluationPeriods) | 糸 |
スコープ | このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 | string[] |
過酷 | アラートの重大度。 [0- 4] の整数にする必要があります。 値 0 が最も厳しい | int |
targetResourceTypes | アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループであり、targetResourceTypes が Microsoft.Compute/virtualMachines の場合、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 | string[] |
windowSize | アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 | 糸 |
アクション
名前 | 形容 | 価値 |
---|---|---|
actionGroupId | アラートが発生したときに呼び出すアクション グループ リソース ID。 | 糸 |
webHookProperties | webhook オブジェクトのプロパティ。 | ActionWebHookProperties |
ActionWebHookProperties
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | 糸 |
ScheduledQueryRuleCriteria
名前 | 形容 | 価値 |
---|---|---|
allOf | 指定したスコープに対して評価する条件の一覧 | 条件[] |
条件
名前 | 形容 | 価値 |
---|---|---|
寸法 | ディメンション条件の一覧 | ディメンション[] |
failingPeriods | アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 | ConditionFailingPeriods |
metricMeasureColumn | メトリック メジャー番号を含む列。 | 糸 |
演算子 | 条件演算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (必須) |
クエリ | ログ クエリ アラート | 糸 |
resourceIdColumn | リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります | 糸 |
閾 | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 集計の種類 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
次元
名前 | 形容 | 価値 |
---|---|---|
名前 | ディメンションの名前 | string (必須) |
演算子 | ディメンション値の演算子 | 'Exclude' 'Include' (必須) |
価値観 | ディメンション値の一覧 | string[] (必須) |
ConditionFailingPeriods
名前 | 形容 | 価値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods より小さいか等しい必要があります。 既定値は 1 です | int |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と選択した集計ポイント数に基づいて計算されます。 既定値は 1 です | int |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
Azure ビジネス継続性項目のアラート ルールを作成 Azure にデプロイする |
このテンプレートでは、アラート ルールとユーザー割り当て MSI が作成されます。 また、MSI リーダーアクセス権をサブスクリプションに割り当てて、アラート ルールが必要な保護された項目と最新の復旧ポイントの詳細を照会するアクセス権を持つようにします。 |
ARM テンプレート リソース定義
scheduledQueryRules リソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
備考
監視ソリューションのデプロイに関するガイダンスについては、「Bicepを使用した監視リソースの作成
リソースの形式
Microsoft.Insights/scheduledQueryRules リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Insights/scheduledQueryRules",
"apiVersion": "2020-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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"
}
}
プロパティ値
scheduledQueryRules
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | 'Microsoft.Insights/scheduledQueryRules' |
apiVersion | リソース API のバージョン | '2020-05-01-preview' |
名前 | リソース名 | string (必須) 文字制限: 1 ~ 260 有効な文字: 使用できません: *<>%{}&:\\?/#| または制御文字スペースまたはピリオドで終えることはできません。 |
場所 | リソースが存在する地理的な場所 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 テンプレート の |
プロパティ | リソースのルール プロパティ。 | ScheduledQueryRuleProperties の |
ScheduledQueryRuleProperties
名前 | 形容 | 価値 |
---|---|---|
アクション | アクション[] | |
条件 | スケジュールされたクエリ ルールの条件を定義するルール条件。 | ScheduledQueryRuleCriteria の |
形容 | スケジュールされたクエリ ルールの説明。 | 糸 |
displayName | アラート ルールの表示名 | 糸 |
有効 | このスケジュールされたクエリ ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります | bool |
evaluationFrequency | スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 | 糸 |
muteActionsDuration | アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 | 糸 |
overrideQueryTimeRange | 指定した場合、クエリ時間範囲がオーバーライドされます (既定値は WindowSize*NumberOfEvaluationPeriods) | 糸 |
スコープ | このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 | string[] |
過酷 | アラートの重大度。 [0- 4] の整数にする必要があります。 値 0 が最も厳しい | int |
targetResourceTypes | アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループであり、targetResourceTypes が Microsoft.Compute/virtualMachines の場合、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 | string[] |
windowSize | アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 | 糸 |
アクション
名前 | 形容 | 価値 |
---|---|---|
actionGroupId | アラートが発生したときに呼び出すアクション グループ リソース ID。 | 糸 |
webHookProperties | webhook オブジェクトのプロパティ。 | ActionWebHookProperties |
ActionWebHookProperties
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | 糸 |
ScheduledQueryRuleCriteria
名前 | 形容 | 価値 |
---|---|---|
allOf | 指定したスコープに対して評価する条件の一覧 | 条件[] |
条件
名前 | 形容 | 価値 |
---|---|---|
寸法 | ディメンション条件の一覧 | ディメンション[] |
failingPeriods | アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 | ConditionFailingPeriods |
metricMeasureColumn | メトリック メジャー番号を含む列。 | 糸 |
演算子 | 条件演算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (必須) |
クエリ | ログ クエリ アラート | 糸 |
resourceIdColumn | リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります | 糸 |
閾 | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 集計の種類 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
次元
名前 | 形容 | 価値 |
---|---|---|
名前 | ディメンションの名前 | string (必須) |
演算子 | ディメンション値の演算子 | 'Exclude' 'Include' (必須) |
価値観 | ディメンション値の一覧 | string[] (必須) |
ConditionFailingPeriods
名前 | 形容 | 価値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods より小さいか等しい必要があります。 既定値は 1 です | int |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と選択した集計ポイント数に基づいて計算されます。 既定値は 1 です | int |
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
テンプレート | 形容 |
---|---|
Azure ビジネス継続性項目のアラート ルールを作成 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"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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"
}
})
}
プロパティ値
scheduledQueryRules
名前 | 形容 | 価値 |
---|---|---|
種類 | リソースの種類 | "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview" |
名前 | リソース名 | string (必須) 文字制限: 1 ~ 260 有効な文字: 使用できません: *<>%{}&:\\?/#| または制御文字スペースまたはピリオドで終えることはできません。 |
場所 | リソースが存在する地理的な場所 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
タグ | リソース タグ。 | タグ名と値のディクショナリ。 |
プロパティ | リソースのルール プロパティ。 | ScheduledQueryRuleProperties の |
ScheduledQueryRuleProperties
名前 | 形容 | 価値 |
---|---|---|
アクション | アクション[] | |
条件 | スケジュールされたクエリ ルールの条件を定義するルール条件。 | ScheduledQueryRuleCriteria の |
形容 | スケジュールされたクエリ ルールの説明。 | 糸 |
displayName | アラート ルールの表示名 | 糸 |
有効 | このスケジュールされたクエリ ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります | bool |
evaluationFrequency | スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 | 糸 |
muteActionsDuration | アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 | 糸 |
overrideQueryTimeRange | 指定した場合、クエリ時間範囲がオーバーライドされます (既定値は WindowSize*NumberOfEvaluationPeriods) | 糸 |
スコープ | このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 | string[] |
過酷 | アラートの重大度。 [0- 4] の整数にする必要があります。 値 0 が最も厳しい | int |
targetResourceTypes | アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループであり、targetResourceTypes が Microsoft.Compute/virtualMachines の場合、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 | string[] |
windowSize | アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 | 糸 |
アクション
名前 | 形容 | 価値 |
---|---|---|
actionGroupId | アラートが発生したときに呼び出すアクション グループ リソース ID。 | 糸 |
webHookProperties | webhook オブジェクトのプロパティ。 | ActionWebHookProperties |
ActionWebHookProperties
名前 | 形容 | 価値 |
---|---|---|
{カスタマイズされたプロパティ} | 糸 |
ScheduledQueryRuleCriteria
名前 | 形容 | 価値 |
---|---|---|
allOf | 指定したスコープに対して評価する条件の一覧 | 条件[] |
条件
名前 | 形容 | 価値 |
---|---|---|
寸法 | ディメンション条件の一覧 | ディメンション[] |
failingPeriods | アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 | ConditionFailingPeriods |
metricMeasureColumn | メトリック メジャー番号を含む列。 | 糸 |
演算子 | 条件演算子。 | "Equals" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (必須) |
クエリ | ログ クエリ アラート | 糸 |
resourceIdColumn | リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります | 糸 |
閾 | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 集計の種類 | "Average" "Count" "Maximum" "最小" "Total" (必須) |
次元
名前 | 形容 | 価値 |
---|---|---|
名前 | ディメンションの名前 | string (必須) |
演算子 | ディメンション値の演算子 | "除外" "含める" (必須) |
価値観 | ディメンション値の一覧 | string[] (必須) |
ConditionFailingPeriods
名前 | 形容 | 価値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods より小さいか等しい必要があります。 既定値は 1 です | int |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と選択した集計ポイント数に基づいて計算されます。 既定値は 1 です | int |