Partilhar 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 de Registro 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 do URI

Name Em Necessário Tipo Description
activityLogAlertName
 path True

string

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

string

minLength: 1
maxLength: 90

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

string

minLength: 1

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

string

minLength: 1

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

Corpo do Pedido

Name Necessá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 recursos que serão usados como prefixos. O alerta só se aplicará a eventos do Log de Atividades com IDs de recursos que se enquadrem em um desses prefixos. Esta lista deve incluir pelo menos um elemento.
location

string

A localização do recurso. As regras de Alerta do Registo de Atividades do Azure são suportadas nas regiões Global, Europa Ocidental e Europa do Norte.
properties.description

string

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

boolean

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

object

As tags do recurso.

Respostas

Name Tipo Description
200 OK

ActivityLogAlertResource

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

ActivityLogAlertResource

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

ErrorResponse

Ocorreu um erro e a regra de Alerta do Registo de Atividades não pôde ser criada ou atualizada.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

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

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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'

Pedido de amostra

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 da amostra

Código de estado:
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 estado:
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

Name Description
ActionGroup

Um ponteiro para um Grupo de Ação do Azure.
ActionList

Uma lista de ações da regra de Alerta do Registro de Atividades.
ActivityLogAlertResource

Um recurso de regra de Alerta de Log de Atividades.
AlertRuleAllOfCondition

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas.
AlertRuleAnyOfOrLeafCondition

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as 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 diferentes tipos NÃO podem existir em uma condição.

  • Condição da folha - deve conter 'campo' e 'igual' ou 'contémQualquer'. Por favor, note que 'anyOf' não deve ser definido em uma condição de folha.
  • Condição AnyOf - deve conter apenas 'anyOf' (que é uma matriz de Condições Foliares). Por favor, note que 'campo', 'igual' e 'contémQualquer' 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 Registro de Atividades. Esta condição deve conter «campo» e «igual» ou «contémQualquer».
ErrorResponse

A resposta de erro.

ActionGroup

Object

Um ponteiro para um Grupo de Ação do Azure.

Name Tipo Description
actionGroupId

string

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

object

O dicionário de propriedades personalizadas a serem incluídas na operação POST. Esses dados são anexados à carga útil do webhook.

ActionList

Object

Uma lista de ações da regra de Alerta do Registro de Atividades.

Name Tipo Description
actionGroups

ActionGroup[]

A lista dos Grupos de Ação.

ActivityLogAlertResource

Object

Um recurso de regra de Alerta de Log de Atividades.

Name Tipo Default value Description
id

string

A ID do recurso.
location

string

global

A localização do recurso. As regras de Alerta do Registo de Atividades do Azure são suportadas nas regiões Global, Europa Ocidental e Europa do Norte.
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 Registo de Atividades.
properties.enabled

boolean

True

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

string[]

Uma lista de IDs de recursos que serão usados como prefixos. O alerta só se aplicará a eventos do Log de Atividades com IDs de recursos que se enquadrem em um desses prefixos. Esta lista deve incluir pelo menos um elemento.
tags

object

As tags do recurso.
type

string

O tipo do recurso.

AlertRuleAllOfCondition

Object

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as condições de membro são atendidas.

Name Tipo Description
allOf

AlertRuleAnyOfOrLeafCondition[]

A lista de condições da regra de Alerta do Log de Atividades.

AlertRuleAnyOfOrLeafCondition

Object

Uma condição de regra de Alerta de Registro de Atividades que é atendida quando todas as 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 diferentes tipos NÃO podem existir em uma condição.

  • Condição da folha - deve conter 'campo' e 'igual' ou 'contémQualquer'. Por favor, note que 'anyOf' não deve ser definido em uma condição de folha.
  • Condição AnyOf - deve conter apenas 'anyOf' (que é uma matriz de Condições Foliares). Por favor, note que 'campo', 'igual' e 'contémQualquer' não devem ser definidos em uma condição AnyOf.
Name Tipo Description
anyOf

AlertRuleLeafCondition[]

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

string[]

O valor do campo do evento será comparado com os valores nessa matriz (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
equals

string

O valor do campo do evento será comparado a esse valor (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
field

string

O nome do campo do evento Log de Atividades que essa condição examinará. Os valores possíveis para este campo são (sem distinção entre maiúsculas e minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

AlertRuleLeafCondition

Object

Uma condição de regra de Alerta do Log de Atividades que é atendida comparando o campo e o valor de um evento do Registro de Atividades. Esta condição deve conter «campo» e «igual» ou «contémQualquer».

Name Tipo Description
containsAny

string[]

O valor do campo do evento será comparado com os valores nessa matriz (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
equals

string

O valor do campo do evento será comparado a esse valor (sem distinção entre maiúsculas e minúsculas) para determinar se a condição é atendida.
field

string

O nome do campo do evento Log de Atividades que essa condição examinará. Os valores possíveis para este campo são (sem distinção entre maiúsculas e minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
code

string

O código de erro.
message

string

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