Microsoft.Insights scheduledQueryRules 2018-04-16

Bicep リソース定義

scheduledQueryRules リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

備考

監視ソリューションのデプロイに関するガイダンスについては、「Bicepを使用した監視リソースの作成 」を参照してください。

リソースの形式

Microsoft.Insights/scheduledQueryRules リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2018-04-16' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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: 'ResultCount'
    }
  }
}

アクション オブジェクト

オブジェクトの型を指定するには、odata.type プロパティを設定します。

Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingActionの場合は、次のコマンドを使用します。

  'odata.type': 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction'
  aznsAction: {
    actionGroup: [
      'string'
    ]
    customWebhookPayload: 'string'
    emailSubject: 'string'
  }
  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の場合は、次を使用します。

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

プロパティ値

scheduledQueryRules

名前 形容 価値
名前 リソース名 string (必須)

文字制限: 1 ~ 260

有効な文字:
使用できません:
*<>%{}&:\\?/#| または制御文字

スペースまたはピリオドで終えることはできません。
場所 リソースの場所 string (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
プロパティ リソースのルール プロパティ。 LogSearchRule (必須)

LogSearchRule

名前 形容 価値
アクション ルールの実行に対してアクションを実行する必要があります。 アクション (必須)
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は false です。 bool
形容 ログ検索ルールの説明。
displayName アラート ルールの表示名
有効 ログ検索ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります 'false'
'true'
計画 ルールのスケジュール (頻度、時間枠)。 アクションの種類に必須 - AlertingAction スケジュール の
データのクエリを実行するルールに対するデータ ソース ソース (必須)

アクション

名前 形容 価値
odata.type オブジェクトの種類を設定する 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

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (必須)
aznsAction Azure アクション グループリファレンス。 AzNsActionGroup の
過酷 アラートの重大度 '0'
'1'
'2'
'3'
'4' (必須)
throttlingInMin アラートを調整または抑制する必要がある時間 (分単位)。 int
トリガー アラート ルールが発生するトリガー条件。 TriggerCondition (必須)

AzNsActionGroup

名前 形容 価値
actionGroup Azure アクション グループ リファレンス。 string[]
customWebhookPayload Azure アクション グループ内のすべての webhook URI に対して送信されるカスタム ペイロード
emailSubject Azure アクション グループ内のすべての電子メール ID のカスタム件名のオーバーライド

TriggerCondition

名前 形容 価値
metricTrigger メトリック クエリ ルールのトリガー条件 LogMetricTrigger の
トリガーする必要があるルールに基づく結果またはカウントのしきい値。 int (必須)
thresholdOperator ルールの評価操作 - 'GreaterThan' または 'LessThan。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (必須)

LogMetricTrigger

名前 形容 価値
metricColumn 特定の列のメトリックの評価
metricTriggerType メトリック トリガーの種類 - "連続" または "合計" 'Consecutive'
'Total'
メトリック トリガーのしきい値。 int
thresholdOperator Metric -'GreaterThan' または 'LessThan' または 'Equal' の評価操作。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必須)
条件 メトリックの基準 条件[] (必須)

条件

名前 形容 価値
寸法 メトリックを作成するためのディメンションの一覧 ディメンション[]
metricName メトリックの名前 string (必須)

次元

名前 形容 価値
名前 ディメンションの名前 string (必須)
演算子 ディメンション値の演算子 'Include' (必須)
価値観 ディメンション値の一覧 string[] (必須)

計画

名前 形容 価値
frequencyInMinutes ルールの条件を評価する頻度 (分単位)。 int (必須)
timeWindowInMinutes クエリ用にデータをフェッチする必要がある時間枠 (frequencyInMinutes 以上にする必要があります)。 int (必須)

名前 形容 価値
authorizedResources クエリに参照されるリソースの一覧 string[]
dataSourceId ログ検索クエリを実行するリソース URI。 string (必須)
クエリ ログ検索クエリ。 アクションの種類に必須 - AlertingAction
queryType 値を 'ResultCount' に設定します。 'ResultCount'

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
Azure ビジネス継続性項目のアラート ルールを作成

Azure にデプロイする
このテンプレートでは、アラート ルールとユーザー割り当て MSI が作成されます。 また、MSI リーダーアクセス権をサブスクリプションに割り当てて、アラート ルールが必要な保護された項目と最新の復旧ポイントの詳細を照会するアクセス権を持つようにします。

ARM テンプレート リソース定義

scheduledQueryRules リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

備考

監視ソリューションのデプロイに関するガイダンスについては、「Bicepを使用した監視リソースの作成 」を参照してください。

リソースの形式

Microsoft.Insights/scheduledQueryRules リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2018-04-16",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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": "ResultCount"
    }
  }
}

アクション オブジェクト

オブジェクトの型を指定するには、odata.type プロパティを設定します。

Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingActionの場合は、次のコマンドを使用します。

  "odata.type": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction",
  "aznsAction": {
    "actionGroup": [ "string" ],
    "customWebhookPayload": "string",
    "emailSubject": "string"
  },
  "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の場合は、次を使用します。

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

プロパティ値

scheduledQueryRules

名前 形容 価値
種類 リソースの種類 'Microsoft.Insights/scheduledQueryRules'
apiVersion リソース API のバージョン '2018-04-16'
名前 リソース名 string (必須)

文字制限: 1 ~ 260

有効な文字:
使用できません:
*<>%{}&:\\?/#| または制御文字

スペースまたはピリオドで終えることはできません。
場所 リソースの場所 string (必須)
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
プロパティ リソースのルール プロパティ。 LogSearchRule (必須)

LogSearchRule

名前 形容 価値
アクション ルールの実行に対してアクションを実行する必要があります。 アクション (必須)
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は false です。 bool
形容 ログ検索ルールの説明。
displayName アラート ルールの表示名
有効 ログ検索ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります 'false'
'true'
計画 ルールのスケジュール (頻度、時間枠)。 アクションの種類に必須 - AlertingAction スケジュール の
データのクエリを実行するルールに対するデータ ソース ソース (必須)

アクション

名前 形容 価値
odata.type オブジェクトの種類を設定する 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

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction' (必須)
aznsAction Azure アクション グループリファレンス。 AzNsActionGroup の
過酷 アラートの重大度 '0'
'1'
'2'
'3'
'4' (必須)
throttlingInMin アラートを調整または抑制する必要がある時間 (分単位)。 int
トリガー アラート ルールが発生するトリガー条件。 TriggerCondition (必須)

AzNsActionGroup

名前 形容 価値
actionGroup Azure アクション グループ リファレンス。 string[]
customWebhookPayload Azure アクション グループ内のすべての webhook URI に対して送信されるカスタム ペイロード
emailSubject Azure アクション グループ内のすべての電子メール ID のカスタム件名のオーバーライド

TriggerCondition

名前 形容 価値
metricTrigger メトリック クエリ ルールのトリガー条件 LogMetricTrigger の
トリガーする必要があるルールに基づく結果またはカウントのしきい値。 int (必須)
thresholdOperator ルールの評価操作 - 'GreaterThan' または 'LessThan。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual' (必須)

LogMetricTrigger

名前 形容 価値
metricColumn 特定の列のメトリックの評価
metricTriggerType メトリック トリガーの種類 - "連続" または "合計" 'Consecutive'
'Total'
メトリック トリガーのしきい値。 int
thresholdOperator Metric -'GreaterThan' または 'LessThan' または 'Equal' の評価操作。 'Equal'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'

LogToMetricAction

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction 'Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction' (必須)
条件 メトリックの基準 条件[] (必須)

条件

名前 形容 価値
寸法 メトリックを作成するためのディメンションの一覧 ディメンション[]
metricName メトリックの名前 string (必須)

次元

名前 形容 価値
名前 ディメンションの名前 string (必須)
演算子 ディメンション値の演算子 'Include' (必須)
価値観 ディメンション値の一覧 string[] (必須)

計画

名前 形容 価値
frequencyInMinutes ルールの条件を評価する頻度 (分単位)。 int (必須)
timeWindowInMinutes クエリ用にデータをフェッチする必要がある時間枠 (frequencyInMinutes 以上にする必要があります)。 int (必須)

名前 形容 価値
authorizedResources クエリに参照されるリソースの一覧 string[]
dataSourceId ログ検索クエリを実行するリソース URI。 string (必須)
クエリ ログ検索クエリ。 アクションの種類に必須 - AlertingAction
queryType 値を 'ResultCount' に設定します。 'ResultCount'

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
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"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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 = "ResultCount"
      }
    }
  })
}

アクション オブジェクト

オブジェクトの型を指定するには、odata.type プロパティを設定します。

Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingActionの場合は、次のコマンドを使用します。

  odata.type = "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction"
  aznsAction = {
    actionGroup = [
      "string"
    ]
    customWebhookPayload = "string"
    emailSubject = "string"
  }
  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の場合は、次を使用します。

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

プロパティ値

scheduledQueryRules

名前 形容 価値
種類 リソースの種類 "Microsoft.Insights/scheduledQueryRules@2018-04-16"
名前 リソース名 string (必須)

文字制限: 1 ~ 260

有効な文字:
使用できません:
*<>%{}&:\\?/#| または制御文字

スペースまたはピリオドで終えることはできません。
場所 リソースの場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
タグ リソース タグ タグ名と値のディクショナリ。
プロパティ リソースのルール プロパティ。 LogSearchRule (必須)

LogSearchRule

名前 形容 価値
アクション ルールの実行に対してアクションを実行する必要があります。 アクション (必須)
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は false です。 bool
形容 ログ検索ルールの説明。
displayName アラート ルールの表示名
有効 ログ検索ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります "false"
"true"
計画 ルールのスケジュール (頻度、時間枠)。 アクションの種類に必須 - AlertingAction スケジュール の
データのクエリを実行するルールに対するデータ ソース ソース (必須)

アクション

名前 形容 価値
odata.type オブジェクトの種類を設定する 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

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction" (必須)
aznsAction Azure アクション グループリファレンス。 AzNsActionGroup の
過酷 アラートの重大度 "0"
"1"
"2"
"3"
"4" (必須)
throttlingInMin アラートを調整または抑制する必要がある時間 (分単位)。 int
トリガー アラート ルールが発生するトリガー条件。 TriggerCondition (必須)

AzNsActionGroup

名前 形容 価値
actionGroup Azure アクション グループ リファレンス。 string[]
customWebhookPayload Azure アクション グループ内のすべての webhook URI に対して送信されるカスタム ペイロード
emailSubject Azure アクション グループ内のすべての電子メール ID のカスタム件名のオーバーライド

TriggerCondition

名前 形容 価値
metricTrigger メトリック クエリ ルールのトリガー条件 LogMetricTrigger の
トリガーする必要があるルールに基づく結果またはカウントのしきい値。 int (必須)
thresholdOperator ルールの評価操作 - 'GreaterThan' または 'LessThan。 "等しい"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual" (必須)

LogMetricTrigger

名前 形容 価値
metricColumn 特定の列のメトリックの評価
metricTriggerType メトリック トリガーの種類 - "連続" または "合計" "Consecutive"
"Total"
メトリック トリガーのしきい値。 int
thresholdOperator Metric -'GreaterThan' または 'LessThan' または 'Equal' の評価操作。 "等しい"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"

LogToMetricAction

名前 形容 価値
odata.type アクションを指定します。 サポートされている値 - AlertingAction、LogToMetricAction "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction" (必須)
条件 メトリックの基準 条件[] (必須)

条件

名前 形容 価値
寸法 メトリックを作成するためのディメンションの一覧 ディメンション[]
metricName メトリックの名前 string (必須)

次元

名前 形容 価値
名前 ディメンションの名前 string (必須)
演算子 ディメンション値の演算子 "含める" (必須)
価値観 ディメンション値の一覧 string[] (必須)

計画

名前 形容 価値
frequencyInMinutes ルールの条件を評価する頻度 (分単位)。 int (必須)
timeWindowInMinutes クエリ用にデータをフェッチする必要がある時間枠 (frequencyInMinutes 以上にする必要があります)。 int (必須)

名前 形容 価値
authorizedResources クエリに参照されるリソースの一覧 string[]
dataSourceId ログ検索クエリを実行するリソース URI。 string (必須)
クエリ ログ検索クエリ。 アクションの種類に必須 - AlertingAction
queryType 値を 'ResultCount' に設定します。 "ResultCount"