Compartilhar via

Activity Log Alerts - Create Or Update

  • Referência
Serviço:
Monitor
Versão da API:
2020-10-01

Crie uma nova regra de Alerta do Log de Atividades ou atualize uma existente.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
activityLogAlertName
 path True

string

O nome da regra de Alerta do Log de Atividades.
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
subscriptionId
 path True

string

A ID da assinatura de destino.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.actions True

ActionList

As ações que serão ativadas quando a condição for atendida.
properties.condition True

AlertRuleAllOfCondition

A condição que fará com que esse alerta seja ativado.
properties.scopes True

string[]

Uma lista de IDs de recurso que serão usadas como prefixos. O alerta só se aplicará a eventos do Log de Atividades com IDs de recurso que se enquadram em um desses prefixos. Essa lista deve incluir pelo menos um item.
location

string

A localização do recurso. As regras de Alerta do Log de Atividades do Azure têm suporte nas regiões Global, Oeste da Europa e Norte da Europa.
properties.description

string

Uma descrição desta regra de Alerta do Log de Atividades.
properties.enabled

boolean

Indica se essa regra de Alerta do Log de Atividades está habilitada. Se uma regra de Alerta do Log de Atividades não estiver habilitada, nenhuma de suas ações será ativada.
tags

object

As marcas do recurso.

Respostas

Nome Tipo Description
200 OK

ActivityLogAlertResource

Uma regra de Alerta do Log de Atividades existente foi atualizada com êxito.
201 Created

ActivityLogAlertResource

Uma nova regra de Alerta do Log de Atividades foi criada com êxito.
Other Status Codes

ErrorResponse

Ocorreu um erro e não foi possível criar nem atualizar a regra de Alerta do Log de Atividades.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Create or update an Activity Log Alert rule
Create or update an Activity Log Alert rule with 'anyOf' condition
Create or update an Activity Log Alert rule with 'containsAny'

Create or update an Activity Log Alert rule

Solicitação de exemplo

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

{
  "location": "Global",
  "tags": {},
  "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": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "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": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}
Código de status:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "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": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

Create or update an Activity Log Alert rule with 'anyOf' condition

Solicitação de exemplo

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

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}
Código de status:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'anyOf' condition."
  }
}

Create or update an Activity Log Alert rule with 'containsAny'

Solicitação de exemplo

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

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Resposta de exemplo

Código de status:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}
Código de status:
201 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule with 'containsAny'."
  }
}

Definições

Nome Description
ActionGroup

Um ponteiro para um Grupo de Ações do Azure.
ActionList

Uma lista de ações de regra de alerta do log de atividades.
ActivityLogAlertResource

Um recurso de regra de alerta do log de atividades.
AlertRuleAllOfCondition

Uma condição de regra de alerta do Log de Atividades que é atendida quando todas as suas condições de membro são atendidas.
AlertRuleAnyOfOrLeafCondition

Uma condição de regra de alerta do Log de Atividades que é atendida quando todas as suas condições de membro são atendidas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem seu subconjunto exclusivo de propriedades. Propriedades de tipos diferentes NÃO podem existir em uma condição.

  • Condição folha – deve conter 'field' e 'equals' ou 'containsAny'. Observe que 'anyOf' não deve ser definido em uma Condição folha.
  • Condição AnyOf – deve conter apenas 'anyOf' (que é uma matriz de condições folha). Observe que 'field', 'equals' e 'containsAny' não devem ser definidos em uma condição AnyOf.
AlertRuleLeafCondition

Uma condição de regra de alerta do log de atividades que é atendida comparando o campo e o valor de um evento do Log de Atividades. Essa condição deve conter 'field' e 'equals' ou 'containsAny'.
ErrorResponse

A resposta de erro.

ActionGroup

Um ponteiro para um Grupo de Ações do Azure.

Nome Tipo Description
actionGroupId

string

A ID do recurso do Grupo de Ações. Isso não pode ser nulo ou vazio.
webhookProperties

object

o dicionário de propriedades personalizadas a serem incluídas com a operação pós-operação. Esses dados são acrescentados ao conteúdo do webhook.

ActionList

Uma lista de ações de regra de alerta do log de atividades.

Nome Tipo Description
actionGroups

ActionGroup[]

A lista dos Grupos de Ações.

ActivityLogAlertResource

Um recurso de regra de alerta do log de atividades.

Nome Tipo Valor padrão Description
id

string

A ID do recurso.
location

string

global

A localização do recurso. As regras de Alerta do Log de Atividades do Azure têm suporte nas regiões Global, Oeste da Europa e Norte da Europa.
name

string

O nome do recurso.
properties.actions

ActionList

As ações que serão ativadas quando a condição for atendida.
properties.condition

AlertRuleAllOfCondition

A condição que fará com que esse alerta seja ativado.
properties.description

string

Uma descrição desta regra de Alerta do Log de Atividades.
properties.enabled

boolean

True

Indica se essa regra de Alerta do Log de Atividades está habilitada. Se uma regra de Alerta do Log de Atividades não estiver habilitada, nenhuma de suas ações será ativada.
properties.scopes

string[]

Uma lista de IDs de recurso que serão usadas como prefixos. O alerta só se aplicará a eventos do Log de Atividades com IDs de recurso que se enquadram em um desses prefixos. Essa lista deve incluir pelo menos um item.
tags

object

As marcas do recurso.
type

string

Tipo do recurso.

AlertRuleAllOfCondition

Uma condição de regra de alerta do Log de Atividades que é atendida quando todas as suas condições de membro são atendidas.

Nome Tipo Description
allOf

AlertRuleAnyOfOrLeafCondition[]

A lista de condições de regra de alerta do log de atividades.

AlertRuleAnyOfOrLeafCondition

Uma condição de regra de alerta do Log de Atividades que é atendida quando todas as suas condições de membro são atendidas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem seu subconjunto exclusivo de propriedades. Propriedades de tipos diferentes NÃO podem existir em uma condição.

  • Condição folha – deve conter 'field' e 'equals' ou 'containsAny'. Observe que 'anyOf' não deve ser definido em uma Condição folha.
  • Condição AnyOf – deve conter apenas 'anyOf' (que é uma matriz de condições folha). Observe que 'field', 'equals' e 'containsAny' não devem ser definidos em uma condição AnyOf.
Nome Tipo Description
anyOf

AlertRuleLeafCondition[]

Uma condição de Alerta do Log de Atividades 'anyOf'.
Uma condição de regra de alerta do log de atividades que é atendida quando pelo menos uma de suas condições folha membro é atendida.
containsAny

string[]

O valor do campo do evento será comparado com os valores nessa matriz (que não diferencia maiúsculas de minúsculas) para determinar se a condição é atendida.
equals

string

O valor do campo do evento será comparado a esse valor (que não diferencia maiúsculas de minúsculas) para determinar se a condição foi atendida.
field

string

O nome do campo do evento log de atividades que essa condição examinará. Os valores possíveis para esse campo são (que não diferencia maiúsculas de minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

AlertRuleLeafCondition

Uma condição de regra de alerta do log de atividades que é atendida comparando o campo e o valor de um evento do Log de Atividades. Essa condição deve conter 'field' e 'equals' ou 'containsAny'.

Nome Tipo Description
containsAny

string[]

O valor do campo do evento será comparado com os valores nessa matriz (que não diferencia maiúsculas de minúsculas) para determinar se a condição é atendida.
equals

string

O valor do campo do evento será comparado a esse valor (que não diferencia maiúsculas de minúsculas) para determinar se a condição foi atendida.
field

string

O nome do campo do evento log de atividades que essa condição examinará. Os valores possíveis para esse campo são (que não diferencia maiúsculas de minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

ErrorResponse

A resposta de erro.

Nome Tipo Description
code

string

O código de erro.
message

string

A mensagem de erro que indica por que a operação falhou.