Microsoft。Insights scheduledQueryRules 2022-08-01-preview

Bicep リソース定義

scheduledQueryRules リソースの種類は、次のようにデプロイできます。

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

注釈

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

リソース形式

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

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2022-08-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    actions: {
      actionGroups: [
        'string'
      ]
      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'
    publicNetworkAccess: 'string'
    ruleResolveConfiguration: {
      autoResolved: bool
      timeToResolve: 'string'
    }
    scopes: [
      'string'
    ]
    severity: int
    skipQueryValidation: bool
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
}

プロパティの値

scheduledQueryRules

名前 説明
name リソース名 string (必須)

文字数制限: 1 から 260

有効な文字:
次は使用できません:
`:<>+/&%\?` または制御文字

末尾をスペースまたはピリオドにすることはできません。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。 'LogAlert'
'LogToMetric'
identity リソースの ID。 ID
properties リソースのルール プロパティ。 ScheduledQueryRuleProperties (必須)

ID

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft の形式の ARM リソース ID になります。ManagedIdentity/userAssignedIdentities/{identityName}' object

ScheduledQueryRuleProperties

名前 説明
actions アラートが発生したときに呼び出すアクション。 アクション
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。 LogAlert の種類のルールにのみ関連します。 [bool]
checkWorkspaceAlertsStorageConfigured このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
条件 スケジュールされたクエリ ルールの条件を定義するルールの条件。 ScheduledQueryRuleCriteria
description スケジュールされたクエリ ルールの説明。 string
displayName アラート ルールの表示名 string
enabled このスケジュールされたクエリ ルールが有効になっているかどうかを示すフラグ。 値は true または false にする必要があります [bool]
evaluationFrequency スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 LogAlert の種類のルールにのみ関連し、必須です。 string
muteActionsDuration アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 LogAlert の種類のルールにのみ関連します。 string
overrideQueryTimeRange 指定した場合は、クエリの時間範囲をオーバーライドします (既定値は WindowSize*NumberOfEvaluationPeriods)。 LogAlert の種類のルールにのみ関連します。 string
publicNetworkAccess これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 'Disabled'
'Enabled'
'SecuredByPerimeter'
ruleResolveConfiguration 発生したアラートを解決するための構成を定義します。 LogAlert の種類のルールにのみ関連します。 RuleResolveConfiguration
スコープ このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 string[]
severity アラートの重大度。 [0 から 4] の間の整数である必要があります。 値 0 は最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。 INT
skipQueryValidation 指定されたクエリを検証する必要があるかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
targetResourceTypes アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループで、targetResourceTypes がMicrosoft場合などです。Compute/virtualMachines では、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 LogAlert の種類のルールにのみ関連します string[]
windowSize アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 LogAlert の種類のルールにのみ関連し、必須です。 string

操作

名前 説明
actionGroups アラートが発生したときに呼び出すアクション グループ リソース ID。 string[]
customProperties アラート ペイロードのプロパティ。 object

ScheduledQueryRuleCriteria

名前 説明
allOf 指定したスコープに対して評価する条件の一覧 Condition[]

条件

名前 説明
dimensions ディメンション条件の一覧 Dimension[]
failingPeriods アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。 ConditionFailingPeriods
metricMeasureColumn メトリックメジャー番号を含む列。 LogAlert の種類のルールにのみ関連します。 string
metricName 送信するメトリックの名前。 LogToMetric の種類のルールにのみ関連し、必須です。 string
operator criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。 'Equals'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'
query ログ クエリ アラート string
resourceIdColumn リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります。LogAlert の種類のルールにのみ関連します。 string
threshold アラートをアクティブにする条件しきい値。 LogAlert の種類のルールにのみ関連し、必須です。 INT
timeAggregation 集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。 'Average'
'Count'
'Maximum'
'Minimum'
'Total'

Dimension

名前 説明
name ディメンションの名前 string (必須)
operator ディメンション値の演算子 'Exclude'
'Include' (必須)
ディメンション値の一覧 string[] (必須)

ConditionFailingPeriods

名前 説明
minFailingPeriodsToAlert アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 既定値は 1。 INT
numberOfEvaluationPeriods 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 既定値は 1。 INT

RuleResolveConfiguration

名前 説明
autoResolved 発生したアラートを自動解決するかどうかを示すフラグ。 [bool]
timeToResolve 発生したアラートが ISO 8601 期間形式で自動的に解決される前に、ルールが正常と評価する必要がある期間。 string

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

scheduledQueryRules リソースの種類は、次のようにデプロイできます。

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

注釈

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

リソース形式

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

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2022-08-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "actions": {
      "actionGroups": [ "string" ],
      "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",
    "publicNetworkAccess": "string",
    "ruleResolveConfiguration": {
      "autoResolved": "bool",
      "timeToResolve": "string"
    },
    "scopes": [ "string" ],
    "severity": "int",
    "skipQueryValidation": "bool",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  }
}

プロパティの値

scheduledQueryRules

名前 説明
type リソースの種類 'Microsoft。Insights/scheduledQueryRules'
apiVersion リソース API のバージョン '2022-08-01-preview'
name リソース名 string (必須)

文字数制限: 1 から 260

有効な文字:
次は使用できません:
`:<>+/&%\?` または制御文字

末尾をスペースまたはピリオドにすることはできません。
location リソースが保存されている地理的な場所 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。 'LogAlert'
'LogToMetric'
identity リソースの ID。 ID
properties リソースのルール プロパティ。 ScheduledQueryRuleProperties (必須)

ID

名前 説明
type マネージド サービス ID の種類。 'None'
'SystemAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft の形式の ARM リソース ID になります。ManagedIdentity/userAssignedIdentities/{identityName}' object

ScheduledQueryRuleProperties

名前 説明
actions アラートが発生したときに呼び出すアクション。 アクション
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。 LogAlert の種類のルールにのみ関連します。 [bool]
checkWorkspaceAlertsStorageConfigured このスケジュールされたクエリ ルールを顧客のストレージに格納する必要があるかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
条件 スケジュールされたクエリ ルールの条件を定義するルールの条件。 ScheduledQueryRuleCriteria
description スケジュールされたクエリ ルールの説明。 string
displayName アラート ルールの表示名 string
enabled このスケジュールされたクエリ ルールが有効になっているかどうかを示すフラグ。 値は true または false にする必要があります [bool]
evaluationFrequency スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 LogAlert の種類のルールにのみ関連し、必須です。 string
muteActionsDuration アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 LogAlert の種類のルールにのみ関連します。 string
overrideQueryTimeRange 指定した場合、クエリの時間範囲がオーバーライドされます (既定値は WindowSize*NumberOfEvaluationPeriods です)。 LogAlert の種類のルールにのみ関連します。 string
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。 'Disabled'
'Enabled'
'SecuredByPerimeter'
ruleResolveConfiguration 発生したアラートを解決するための構成を定義します。 LogAlert の種類のルールにのみ関連します。 RuleResolveConfiguration
スコープ このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 string[]
severity アラートの重大度。 [0 から 4] の整数にする必要があります。 値 0 が最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。 INT
skipQueryValidation 指定されたクエリを検証する必要があるかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
targetResourceTypes アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループで、targetResourceTypes がMicrosoft場合などです。Compute/virtualMachines では、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 LogAlert の種類のルールにのみ関連します string[]
windowSize アラート クエリが実行される期間 (ISO 8601 期間形式)。 LogAlert の種類のルールにのみ関連し、必須です。 string

操作

名前 説明
actionGroups アラートが発生したときに呼び出すアクション グループ リソース ID。 string[]
customProperties アラート ペイロードのプロパティ。 object

ScheduledQueryRuleCriteria

名前 説明
allOf 指定したスコープに対して評価する条件の一覧 Condition[]

条件

名前 説明
dimensions ディメンション条件の一覧 Dimension[]
failingPeriods アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。 ConditionFailingPeriods
metricMeasureColumn メトリックメジャー番号を含む列。 LogAlert の種類のルールにのみ関連します。 string
metricName 送信するメトリックの名前。 LogToMetric の種類のルールにのみ関連し、必須です。 string
operator criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。 'Equals'
'GreaterThan'
'GreaterThanOrEqual'
'LessThan'
'LessThanOrEqual'
query ログ クエリ アラート string
resourceIdColumn リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります。LogAlert の種類のルールにのみ関連します。 string
threshold アラートをアクティブにする条件しきい値。 LogAlert の種類のルールにのみ関連し、必須です。 INT
timeAggregation 集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。 'Average'
'Count'
'Maximum'
'Minimum'
'Total'

Dimension

名前 説明
name ディメンションの名前 string (必須)
operator ディメンション値の演算子 'Exclude'
'Include' (必須)
ディメンション値の一覧 string[] (必須)

ConditionFailingPeriods

名前 説明
minFailingPeriodsToAlert アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 既定値は 1。 INT
numberOfEvaluationPeriods 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 既定値は 1。 INT

RuleResolveConfiguration

名前 説明
autoResolved 発生したアラートを自動解決するかどうかを示すフラグ。 [bool]
timeToResolve 発生したアラートが ISO 8601 期間形式で自動的に解決される前に、ルールが正常と評価する必要がある期間。 string

Terraform (AzAPI プロバイダー) リソース定義

scheduledQueryRules リソースの種類は、次のようにデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2022-08-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      actions = {
        actionGroups = [
          "string"
        ]
        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"
      publicNetworkAccess = "string"
      ruleResolveConfiguration = {
        autoResolved = bool
        timeToResolve = "string"
      }
      scopes = [
        "string"
      ]
      severity = int
      skipQueryValidation = bool
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
    kind = "string"
  })
}

プロパティの値

scheduledQueryRules

名前 説明
type リソースの種類 "Microsoft。Insights/scheduledQueryRules@2022-08-01-preview"
name リソース名 string (必須)

文字数制限: 1 から 260

有効な文字:
次は使用できません:
`:<>+/&%\?` または制御文字

末尾をスペースまたはピリオドにすることはできません。
location リソースが保存されている地理的な場所 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
kind スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。 "LogAlert"
"LogToMetric"
identity リソースの ID。 ID
properties リソースのルール プロパティ。 ScheduledQueryRuleProperties (必須)

ID

名前 説明
type マネージド サービス ID の種類。 "SystemAssigned"
"UserAssigned" (必須)
identity_ids リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft の形式の ARM リソース ID になります。ManagedIdentity/userAssignedIdentities/{identityName}' ユーザー ID ID の配列。

ScheduledQueryRuleProperties

名前 説明
actions アラートが発生したときに呼び出すアクション。 アクション
autoMitigate アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。 LogAlert の種類のルールにのみ関連します。 [bool]
checkWorkspaceAlertsStorageConfigured このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
条件 スケジュールされたクエリ ルールの条件を定義するルールの条件。 ScheduledQueryRuleCriteria
description スケジュールされたクエリ ルールの説明。 string
displayName アラート ルールの表示名 string
enabled このスケジュールされたクエリ ルールが有効になっているかどうかを示すフラグ。 値は true または false にする必要があります [bool]
evaluationFrequency スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 LogAlert の種類のルールにのみ関連し、必須です。 string
muteActionsDuration アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 LogAlert の種類のルールにのみ関連します。 string
overrideQueryTimeRange 指定した場合は、クエリの時間範囲をオーバーライドします (既定値は WindowSize*NumberOfEvaluationPeriods)。 LogAlert の種類のルールにのみ関連します。 string
publicNetworkAccess これにより、トラフィックがパブリック ネットワーク経由で許可されるかどうかが決まります。 既定では有効になっています。 "無効"
"有効"
"SecuredByPerimeter"
ruleResolveConfiguration 発生したアラートを解決するための構成を定義します。 LogAlert の種類のルールにのみ関連します。 RuleResolveConfiguration
スコープ このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。 string[]
severity アラートの重大度。 [0 から 4] の間の整数である必要があります。 値 0 は最も厳しいです。 LogAlert の種類のルールにのみ関連し、必須です。 INT
skipQueryValidation 指定されたクエリを検証する必要があるかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。 [bool]
targetResourceTypes アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループで、targetResourceTypes がMicrosoft場合などです。Compute/virtualMachines では、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 LogAlert の種類のルールにのみ関連します string[]
windowSize アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 LogAlert の種類のルールにのみ関連し、必須です。 string

操作

名前 説明
actionGroups アラートが発生したときに呼び出すアクション グループ リソース ID。 string[]
customProperties アラート ペイロードのプロパティ。 object

ScheduledQueryRuleCriteria

名前 説明
allOf 指定したスコープに対して評価する条件の一覧 Condition[]

条件

名前 説明
dimensions ディメンション条件の一覧 Dimension[]
failingPeriods アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 LogAlert の種類のルールにのみ関連します。 ConditionFailingPeriods
metricMeasureColumn メトリックメジャー番号を含む列。 LogAlert の種類のルールにのみ関連します。 string
metricName 送信するメトリックの名前。 LogToMetric の種類のルールにのみ関連し、必須です。 string
operator criteria 演算子。 LogAlert の種類のルールにのみ関連し、必須です。 "Equals"
"GreaterThan"
"GreaterThanOrEqual"
"LessThan"
"LessThanOrEqual"
query ログ クエリ アラート string
resourceIdColumn リソース ID を含む列。列の内容は、リソース ID として書式設定された URI である必要があります。LogAlert の種類のルールにのみ関連します。 string
threshold アラートをアクティブにする条件しきい値。 LogAlert の種類のルールにのみ関連し、必須です。 INT
timeAggregation 集計の種類。 LogAlert の種類のルールにのみ関連し、必須です。 "Average"
"Count"
"Maximum"
"最小"
"Total"

Dimension

名前 説明
name ディメンションの名前 string (必須)
operator ディメンション値の演算子 "除外"
"Include" (必須)
ディメンション値の一覧 string[] (必須)

ConditionFailingPeriods

名前 説明
minFailingPeriodsToAlert アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 既定値は 1。 INT
numberOfEvaluationPeriods 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 既定値は 1。 INT

RuleResolveConfiguration

名前 説明
autoResolved 発生したアラートを自動解決するかどうかを示すフラグ。 [bool]
timeToResolve 発生したアラートが ISO 8601 期間形式で自動的に解決される前に、ルールが正常と評価する必要がある期間。 string