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


Activity Log Alerts - Update

Обновляет поля "теги" и "включено" в существующем правиле генерации оповещений. Этот метод используется для обновления тегов правил генерации оповещений и включения или отключения правила генерации оповещений. Чтобы обновить другие поля, используйте операцию CreateOrUpdate.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

Параметры URI

Имя В Обязательно Тип Описание
activityLogAlertName
path True

string

Имя правила генерации оповещений журнала действий.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.

subscriptionId
path True

string

minLength: 1

Идентификатор целевой подписки.

api-version
query True

string

minLength: 1

Версия API, используемая для этой операции.

Текст запроса

Имя Тип Описание
properties.enabled

boolean

Указывает, включено ли это правило генерации оповещений журнала действий. Если правило генерации оповещений журнала действий не включено, то ни одно из его действий не будет активировано.

tags

object

Теги ресурсов

Ответы

Имя Тип Описание
200 OK

ActivityLogAlertResource

Существующее правило генерации оповещений журнала действий было успешно обновлено.

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

Patch an Activity Log Alert rule

Образец запроса

PATCH https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

{
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "enabled": false
  }
}

Пример ответа

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "scopes": [
      "/subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": false,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Определения

Имя Описание
ActionGroup

Указатель на группу действий Azure.

ActionList

Список действий правила генерации оповещений журнала действий.

ActivityLogAlertResource

Ресурс правила генерации оповещений журнала действий.

AlertRuleAllOfCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов.

AlertRuleAnyOfOrLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов. Каждое условие может быть одним из следующих типов: Важное: каждый тип имеет свое уникальное подмножество свойств. Свойства из разных типов НЕ МОГУТ существовать в одном условии.

  • конечное условие — должны содержать поле, а также "равно" или "containsAny". обратите внимание, что "anyOf" должен не быть задан в конечном условии.
  • условий AnyOf — должны содержать только anyOf (это массив условий листа). обратите внимание, что "field", "equals" и "containsAny" должны не быть заданы в условии AnyOf.
AlertRuleLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется путем сравнения поля и значения события журнала действий. Это условие должно содержать "поле" и "равно" или "containsAny".

AlertRulePatchObject

Объект правила генерации оповещений журнала действий для текста операций исправления.

ErrorResponse

Ответ на ошибку.

ActionGroup

Указатель на группу действий Azure.

Имя Тип Описание
actionGroupId

string

Идентификатор ресурса группы действий. Это не может быть пустым или пустым.

webhookProperties

object

словарь настраиваемых свойств для включения в операцию после операции. Эти данные добавляются в полезные данные веб-перехватчика.

ActionList

Список действий правила генерации оповещений журнала действий.

Имя Тип Описание
actionGroups

ActionGroup[]

Список групп действий.

ActivityLogAlertResource

Ресурс правила генерации оповещений журнала действий.

Имя Тип Default value Описание
id

string

Идентификатор ресурса.

location

string

global

Расположение ресурса. Правила генерации оповещений журнала действий Azure поддерживаются в регионах Глобальной, Западной Европы и Северной Европы.

name

string

Имя ресурса.

properties.actions

ActionList

Действия, которые активируются при выполнении условия.

properties.condition

AlertRuleAllOfCondition

Условие, которое приведет к активации этого оповещения.

properties.description

string

Описание этого правила генерации оповещений журнала действий.

properties.enabled

boolean

True

Указывает, включено ли это правило генерации оповещений журнала действий. Если правило генерации оповещений журнала действий не включено, то ни одно из его действий не будет активировано.

properties.scopes

string[]

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

tags

object

Теги ресурса.

type

string

Тип ресурса.

AlertRuleAllOfCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов.

Имя Тип Описание
allOf

AlertRuleAnyOfOrLeafCondition[]

Список условий правила генерации оповещений журнала действий.

AlertRuleAnyOfOrLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется при выполнении всех условий его членов. Каждое условие может быть одним из следующих типов: Важное: каждый тип имеет свое уникальное подмножество свойств. Свойства из разных типов НЕ МОГУТ существовать в одном условии.

  • конечное условие — должны содержать поле, а также "равно" или "containsAny". обратите внимание, что "anyOf" должен не быть задан в конечном условии.
  • условий AnyOf — должны содержать только anyOf (это массив условий листа). обратите внимание, что "field", "equals" и "containsAny" должны не быть заданы в условии AnyOf.
Имя Тип Описание
anyOf

AlertRuleLeafCondition[]

Условие "AnyOf" правила генерации оповещений журнала действий.
Условие правила генерации оповещений журнала действий, которое выполняется по крайней мере при выполнении одного из условий конечного элемента.

containsAny

string[]

Значение поля события будет сравниваться со значениями в этом массиве (без учета регистра), чтобы определить, соответствует ли условие.

equals

string

Значение поля события будет сравниваться с этим значением (без учета регистра), чтобы определить, соответствует ли условие.

field

string

Имя поля события журнала действий, которое будет проверять это условие. Возможные значения этого поля : (без учета регистра): resourceId, "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" или все, что начинается с "properties".

AlertRuleLeafCondition

Условие правила генерации оповещений журнала действий, которое выполняется путем сравнения поля и значения события журнала действий. Это условие должно содержать "поле" и "равно" или "containsAny".

Имя Тип Описание
containsAny

string[]

Значение поля события будет сравниваться со значениями в этом массиве (без учета регистра), чтобы определить, соответствует ли условие.

equals

string

Значение поля события будет сравниваться с этим значением (без учета регистра), чтобы определить, соответствует ли условие.

field

string

Имя поля события журнала действий, которое будет проверять это условие. Возможные значения этого поля : (без учета регистра): resourceId, "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" или все, что начинается с "properties".

AlertRulePatchObject

Объект правила генерации оповещений журнала действий для текста операций исправления.

Имя Тип Default value Описание
properties.enabled

boolean

True

Указывает, включено ли это правило генерации оповещений журнала действий. Если правило генерации оповещений журнала действий не включено, то ни одно из его действий не будет активировано.

tags

object

Теги ресурсов

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
code

string

Код ошибки.

message

string

Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.