microsoft.alertsManagement smartDetectorAlertRules

Bicep リソース定義

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

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

解説

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

リソース形式

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

resource symbolicname 'microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actionGroups: {
      customEmailSubject: 'string'
      customWebhookPayload: 'string'
      groupIds: [
        'string'
      ]
    }
    description: 'string'
    detector: {
      id: 'string'
      parameters: {}
    }
    frequency: 'string'
    scope: [
      'string'
    ]
    severity: 'string'
    state: 'string'
    throttling: {
      duration: 'string'
    }
  }
}

プロパティの値

smartDetectorAlertRules

名前 説明
name リソース名 string (必須)
location リソースの場所。 string
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties アラート ルールのプロパティ。 AlertRuleProperties

AlertRuleProperties

名前 説明
actionGroups アラート ルールのアクション。 ActionGroupsInformation (必須)
description アラート ルールの説明。 string
検出 器 アラート ルールの検出機能。 検出器 (必須)
frequency ISO8601 形式のアラート ルールの頻度。 時間の細分性は分単位で、最小値は検出器に応じて 1 分である必要があります。 string (必須)
scope アラート ルール リソースのスコープ。 string[] (必須)
severity アラート ルールの重大度。 'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4' (必須)
state アラート ルールの状態。 'Disabled'
'Enabled' (必須)
調整 アラート ルールの調整情報。 ThrottlingInformation

ActionGroupsInformation

名前 説明
customEmailSubject メール通知で使用するオプションのカスタム メールの件名。 string
customWebhookPayload Web フック通知で使用するオプションのカスタム Web フック ペイロード。 string
groupIds アクション グループ リソース ID。 string[] (必須)

検出機能

名前 説明
id ディテクタ ID。 string (必須)
parameters ディテクタのパラメーター。 object

ThrottlingInformation

名前 説明
duration アラート ルールに再度通知する前に待機するために必要な期間 (ISO8601 形式)。 時間の細分性は分単位で、最小値は 0 分である必要があります string

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

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

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

解説

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

リソース形式

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

{
  "type": "microsoft.alertsManagement/smartDetectorAlertRules",
  "apiVersion": "2021-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actionGroups": {
      "customEmailSubject": "string",
      "customWebhookPayload": "string",
      "groupIds": [ "string" ]
    },
    "description": "string",
    "detector": {
      "id": "string",
      "parameters": {}
    },
    "frequency": "string",
    "scope": [ "string" ],
    "severity": "string",
    "state": "string",
    "throttling": {
      "duration": "string"
    }
  }
}

プロパティの値

smartDetectorAlertRules

名前 説明
type リソースの種類 'microsoft.alertsManagement/smartDetectorAlertRules'
apiVersion リソース API のバージョン '2021-04-01'
name リソース名 string (必須)
location リソースの場所。 string
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
properties アラート ルールのプロパティ。 AlertRuleProperties

AlertRuleProperties

名前 説明
actionGroups アラート ルールのアクション。 ActionGroupsInformation (必須)
description アラート ルールの説明。 string
検出 器 アラート ルールの検出機能。 Detector (必須)
frequency アラート ルールの頻度 (ISO8601 形式)。 時間の細分性は分単位で、最小値は検出器に応じて 1 分である必要があります。 string (必須)
scope アラート ルールリソースのスコープ。 string[] (必須)
severity アラート ルールの重大度。 'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4' (必須)
state アラート ルールの状態。 'Disabled'
'Enabled' (必須)
調整 アラート ルールの調整情報。 ThrottlingInformation

ActionGroupsInformation

名前 説明
customEmailSubject 電子メール通知で使用するオプションのカスタム 電子メールの件名。 string
customWebhookPayload Web フック通知で使用するオプションのカスタム Web フック ペイロード。 string
groupIds アクション グループ リソース ID。 string[] (必須)

検出機能

名前 説明
id ディテクタ ID。 string (必須)
parameters 検出機能のパラメーター。 object

ThrottlingInformation

名前 説明
duration アラート ルールに再度通知する前に待機するために必要な期間 (ISO8601 形式)。 時間の細分性は分単位で、最小値は 0 分である必要があります string

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

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

  • リソース グループ

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

リソース形式

microsoft.alertsManagement/smartDetectorAlertRules リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actionGroups = {
        customEmailSubject = "string"
        customWebhookPayload = "string"
        groupIds = [
          "string"
        ]
      }
      description = "string"
      detector = {
        id = "string"
        parameters = {}
      }
      frequency = "string"
      scope = [
        "string"
      ]
      severity = "string"
      state = "string"
      throttling = {
        duration = "string"
      }
    }
  })
}

プロパティの値

smartDetectorAlertRules

名前 説明
type リソースの種類 "microsoft.alertsManagement/smartDetectorAlertRules@2021-04-01"
name リソース名 string (必須)
location リソースの場所。 string
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。
properties アラート ルールのプロパティ。 AlertRuleProperties

AlertRuleProperties

名前 説明
actionGroups アラート ルールのアクション。 ActionGroupsInformation (必須)
description アラート ルールの説明。 string
検出 器 アラート ルールの検出機能。 検出器 (必須)
frequency ISO8601 形式のアラート ルールの頻度。 時間の細分性は分単位で、最小値は検出器に応じて 1 分である必要があります。 string (必須)
scope アラート ルール リソースのスコープ。 string[] (必須)
severity アラート ルールの重大度。 "Sev0"
"Sev1"
"Sev2"
"Sev3"
"Sev4" (必須)
state アラート ルールの状態。 "無効"
"有効" (必須)
調整 アラート ルールの調整情報。 ThrottlingInformation

ActionGroupsInformation

名前 説明
customEmailSubject メール通知で使用するオプションのカスタム メールの件名。 string
customWebhookPayload Web フック通知で使用するオプションのカスタム Web フック ペイロード。 string
groupIds アクション グループ リソース ID。 string[] (必須)

検出機能

名前 説明
id ディテクタ ID。 string (必須)
parameters ディテクタのパラメーター。 object

ThrottlingInformation

名前 説明
duration アラート ルールに再度通知する前に待機するために必要な期間 (ISO8601 形式)。 時間の細分性は分単位で、最小値は 0 分である必要があります string