Поделиться через


Microsoft.AlertsManagement actionRules

Определение ресурса Bicep

Тип ресурса actionRules можно развернуть в:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AlertsManagement/actionRules, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.AlertsManagement/actionRules@2021-08-08' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    actions: [
      {
        actionType: 'string'
        // For remaining properties, see Action objects
      }
    ]
    conditions: [
      {
        field: 'string'
        operator: 'string'
        values: [
          'string'
        ]
      }
    ]
    description: 'string'
    enabled: bool
    schedule: {
      effectiveFrom: 'string'
      effectiveUntil: 'string'
      recurrences: [
        {
          endTime: 'string'
          startTime: 'string'
          recurrenceType: 'string'
          // For remaining properties, see Recurrence objects
        }
      ]
      timeZone: 'string'
    }
    scopes: [
      'string'
    ]
  }
}

Объекты action

Задайте свойство actionType , чтобы указать тип объекта .

Для AddActionGroups используйте:

  actionType: 'AddActionGroups'
  actionGroupIds: [
    'string'
  ]

Для RemoveAllActionGroups используйте:

  actionType: 'RemoveAllActionGroups'

Объекты Recurrence

Задайте свойство recurrenceType , чтобы указать тип объекта.

Для daily используйте:

  recurrenceType: 'Daily'

Для ежемесячного использования используйте:

  recurrenceType: 'Monthly'
  daysOfMonth: [
    int
  ]

Для еженедельно используйте:

  recurrenceType: 'Weekly'
  daysOfWeek: [
    'string'
  ]

Значения свойств

actionRules

Имя Описание Значение
name имя ресурса. строка (обязательно)
location Расположение ресурса строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Свойства правила обработки оповещений. AlertProcessingRuleProperties

AlertProcessingRuleProperties

Имя Описание Значение
actions Применяемые действия. Action[] (обязательно)
условия Условия фильтрации оповещений. Условие[]
description Описание правила обработки оповещений. строка
Включено Указывает, включено или отключено заданное правило обработки оповещений. bool
schedule Планирование правила обработки оповещений. Расписание
Области Области, к которым будет применяться правило обработки оповещений. string[] (обязательно)

Действие

Имя Описание Значение
actionType Установка типа объекта AddActionGroups
RemoveAllActionGroups (обязательно)

AddActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. AddActionGroups (обязательно)
actionGroupIds Список идентификаторов группы действий, добавляемых в правило обработки оповещений. string[] (обязательно)

RemoveAllActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. RemoveAllActionGroups (обязательно)

Условие

Имя Описание Значение
поле Поле для заданного условия. AlertContext
AlertRuleId
AlertRuleName
"Описание"
MonitorCondition
MonitorService
"Серьезность"
"SignalType"
"TargetResource"
TargetResourceGroup
TargetResourceType
оператор Оператор для заданного условия. "Contains"
'DoesNotContain'
"Equals"
'NotEquals'
значения Список значений, которые должны соответствовать заданному условию. string[]

Расписание

Имя Описание Значение
effectiveFrom Планирование, действующее от времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
effectiveUntil Планирование действует до времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
Рецидивов Список повторений. Повторение[]
timeZone Планирование часового пояса. строка

Периодичность

Имя Описание Значение
endTime Время окончания повторения. строка
startTime Время начала повторения. строка
recurrenceType Установка типа объекта Ежедневно
Ежемесячно
Еженедельно (обязательно)

DailyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Daily" (обязательно)

MonthlyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Monthly" (обязательно)
daysOfMonth Задает значения для шаблона ежемесячного повторения. int[] (обязательно)

WeeklyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Еженедельно" (обязательно)
daysOfWeek Задает значения для еженедельного шаблона повторения. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
'Суббота'
'Воскресенье'
"Четверг"
"Вторник"
"Среда" (обязательно)

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Настройка уведомлений для оповещений о резервном копировании с помощью Azure Monitor

Развертывание в Azure
Этот шаблон позволяет настроить уведомления по электронной почте для хранилищ Служб восстановления с помощью Azure Monitor, развернув правило обработки оповещений и группу действий.

Определение ресурса шаблона ARM

Тип ресурса actionRules можно развернуть в следующих объектах:

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AlertsManagement/actionRules, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.AlertsManagement/actionRules",
  "apiVersion": "2021-08-08",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "actions": [
      {
        "actionType": "string"
        // For remaining properties, see Action objects
      }
    ],
    "conditions": [
      {
        "field": "string",
        "operator": "string",
        "values": [ "string" ]
      }
    ],
    "description": "string",
    "enabled": "bool",
    "schedule": {
      "effectiveFrom": "string",
      "effectiveUntil": "string",
      "recurrences": [
        {
          "endTime": "string",
          "startTime": "string",
          "recurrenceType": "string"
          // For remaining properties, see Recurrence objects
        }
      ],
      "timeZone": "string"
    },
    "scopes": [ "string" ]
  }
}

Объекты action

Задайте свойство actionType , чтобы указать тип объекта .

Для AddActionGroups используйте:

  "actionType": "AddActionGroups",
  "actionGroupIds": [ "string" ]

Для RemoveAllActionGroups используйте:

  "actionType": "RemoveAllActionGroups"

Объекты повторения

Задайте свойство recurrenceType , чтобы указать тип объекта.

Для daily используйте:

  "recurrenceType": "Daily"

Для ежемесячного использования используйте:

  "recurrenceType": "Monthly",
  "daysOfMonth": [ "int" ]

Для еженедельно используйте:

  "recurrenceType": "Weekly",
  "daysOfWeek": [ "string" ]

Значения свойств

actionRules

Имя Описание Значение
тип Тип ресурса Microsoft.AlertsManagement/actionRules
версия_API Версия API ресурсов '2021-08-08'
name имя ресурса. строка (обязательно)
location Расположение ресурса строка (обязательно)
tags Теги ресурсов Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties Свойства правила обработки оповещений. AlertProcessingRuleProperties

AlertProcessingRuleProperties

Имя Описание Значение
actions Применяемые действия. Action[] (обязательно)
условия Условия фильтрации оповещений. Условие[]
description Описание правила обработки оповещений. строка
Включено Указывает, включено или отключено заданное правило обработки оповещений. bool
schedule Планирование правила обработки оповещений. Расписание
Области Области, к которым будет применяться правило обработки оповещений. string[] (обязательно)

Действие

Имя Описание Значение
actionType Установка типа объекта AddActionGroups
RemoveAllActionGroups (обязательно)

AddActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. AddActionGroups (обязательно)
actionGroupIds Список идентификаторов группы действий, добавляемых в правило обработки оповещений. string[] (обязательно)

RemoveAllActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. RemoveAllActionGroups (обязательно)

Условие

Имя Описание Значение
поле Поле для заданного условия. AlertContext
AlertRuleId
AlertRuleName
"Описание"
MonitorCondition
MonitorService
"Серьезность"
"SignalType"
TargetResource
TargetResourceGroup
TargetResourceType
оператор Оператор для заданного условия. "Contains"
'DoesNotContain'
"Равно"
NotEquals
значения Список значений, которые должны соответствовать заданному условию. string[]

Расписание

Имя Описание Значение
effectiveFrom Планирование, действующее со времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
effectiveUntil Планирование действия до времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
Рецидивов Список повторений. Повторение[]
timeZone Планирование часового пояса. строка

Периодичность

Имя Описание Значение
endTime Время окончания повторения. строка
startTime Время начала повторения. строка
recurrenceType Установка типа объекта Ежедневно
Ежемесячно
Еженедельно (обязательно)

DailyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Daily" (обязательно)

MonthlyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. Monthly (обязательно)
daysOfMonth Задает значения для шаблона ежемесячного повторения. int[] (обязательно)

WeeklyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Еженедельно" (обязательно)
daysOfWeek Задает значения для еженедельного шаблона повторения. Массив строк, содержащий любой из:
"Пятница"
"Понедельник"
"Суббота"
"Воскресенье"
"Четверг"
"Вторник"
"Среда" (обязательно)

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Настройка уведомлений для оповещений о резервном копировании с помощью Azure Monitor

Развертывание в Azure
Этот шаблон позволяет настроить уведомления по электронной почте для хранилищ Служб восстановления с помощью Azure Monitor, развернув правило обработки оповещений и группу действий.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса actionRules можно развернуть в:

  • Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.AlertsManagement/actionRules, добавьте в шаблон следующую terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/actionRules@2021-08-08"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionType = "string"
          // For remaining properties, see Action objects
        }
      ]
      conditions = [
        {
          field = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      ]
      description = "string"
      enabled = bool
      schedule = {
        effectiveFrom = "string"
        effectiveUntil = "string"
        recurrences = [
          {
            endTime = "string"
            startTime = "string"
            recurrenceType = "string"
            // For remaining properties, see Recurrence objects
          }
        ]
        timeZone = "string"
      }
      scopes = [
        "string"
      ]
    }
  })
}

Объекты action

Задайте свойство actionType , чтобы указать тип объекта .

Для AddActionGroups используйте:

  actionType = "AddActionGroups"
  actionGroupIds = [
    "string"
  ]

Для RemoveAllActionGroups используйте:

  actionType = "RemoveAllActionGroups"

Объекты Recurrence

Задайте свойство recurrenceType , чтобы указать тип объекта.

Для daily используйте:

  recurrenceType = "Daily"

Для ежемесячного использования используйте:

  recurrenceType = "Monthly"
  daysOfMonth = [
    int
  ]

Для еженедельно используйте:

  recurrenceType = "Weekly"
  daysOfWeek = [
    "string"
  ]

Значения свойств

actionRules

Имя Описание Значение
тип Тип ресурса "Microsoft.AlertsManagement/actionRules@2021-08-08"
name имя ресурса. строка (обязательно)
location Расположение ресурса string (обязательно)
parent_id Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов. string (обязательно)
tags Теги ресурсов Словарь имен и значений тегов.
properties Свойства правила обработки оповещений. AlertProcessingRuleProperties

AlertProcessingRuleProperties

Имя Описание Значение
actions Применяемые действия. Action[] (обязательно)
условия Условия фильтрации оповещений. Условие[]
description Описание правила обработки оповещений. строка
Включено Указывает, включено или отключено ли заданное правило обработки оповещений. bool
schedule Планирование правила обработки оповещений. Расписание
Области Области, к которым будет применяться правило обработки оповещений. string[] (обязательно)

Действие

Имя Описание Значение
actionType Установка типа объекта AddActionGroups
RemoveAllActionGroups (обязательно)

AddActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. "AddActionGroups" (обязательно)
actionGroupIds Список идентификаторов группы действий, добавляемых в правило обработки оповещений. string[] (обязательно)

RemoveAllActionGroups

Имя Описание Значение
actionType Действие, которое должно быть применено. RemoveAllActionGroups (обязательно)

Условие

Имя Описание Значение
поле Поле для заданного условия. AlertContext
AlertRuleId
AlertRuleName
"Описание"
"MonitorCondition"
"MonitorService"
"Серьезность"
"SignalType"
"TargetResource"
"TargetResourceGroup"
"TargetResourceType"
оператор Оператор для заданного условия. "Содержит"
"DoesNotContain"
"Equals"
"NotEquals"
значения Список значений, которые должны соответствовать заданному условию. string[]

Расписание

Имя Описание Значение
effectiveFrom Планирование, действующее от времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
effectiveUntil Планирование действует до времени. Date-Time в формате ISO-8601 без суффикса часового пояса. строка
Рецидивов Список повторений. Повторение[]
timeZone Планирование часового пояса. строка

Периодичность

Имя Описание Значение
endTime Время окончания повторения. строка
startTime Время начала повторения. строка
recurrenceType Установка типа объекта Ежедневно
Ежемесячно
Еженедельно (обязательно)

DailyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Daily" (обязательно)

MonthlyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Monthly" (обязательно)
daysOfMonth Задает значения для шаблона ежемесячного повторения. int[] (обязательно)

WeeklyRecurrence

Имя Описание Значение
recurrenceType Указывает, когда следует применить повторение. "Еженедельно" (обязательно)
daysOfWeek Задает значения для еженедельного шаблона повторения. Массив строк, содержащий любой из:
Пятница
Понедельник
Суббота
Воскресенье
Четверг
Вторник
"Среда" (обязательно)