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 do Registo 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 Registo de Atividades.
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

O ID da subscrição de destino.
api-version
 query True

string

A versão da API a utilizar 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 cumprida.
properties.condition True

AlertRuleAllOfCondition

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

string[]

Uma lista de IDs de recursos que serão utilizados como prefixos. O alerta só se aplicará a eventos do Registo de Atividades com IDs de recursos que se enquadram num destes prefixos. Esta lista tem de incluir, pelo menos, um item.
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 esta regra de Alerta do Registo de Atividades está ativada. Se uma regra de Alerta do Registo de Atividades não estiver ativada, nenhuma das ações será ativada.
tags

object

As etiquetas do recurso.

Respostas

Name Tipo Description
200 OK

ActivityLogAlertResource

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

ActivityLogAlertResource

Foi criada com êxito uma nova regra de Alerta do Registo de Atividades.
Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Âmbitos

Name Description
user_impersonation representar 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ções do Azure.
ActionList

Uma lista de ações de regras de Alerta do Registo de Atividades.
ActivityLogAlertResource

Um recurso de regra de Alerta do Registo de Atividades.
AlertRuleAllOfCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas.
AlertRuleAnyOfOrLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem o seu subconjunto exclusivo de propriedades. Não é possível existir propriedades de diferentes tipos numa condição.

  • Condição de Folha - tem de conter "campo" e "igual" ou "containsAny". Tenha em atenção que "anyOf" não deve ser definido numa Condição de Folha.
  • AnyOf Condition - tem de conter apenas "anyOf" (que é uma matriz de Condições de Folha). Tenha em atenção que "campo", "igual a" e "containsAny" não devem ser definidos numa Condição AnyOf.
AlertRuleLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida ao comparar o campo e o valor de um evento do Registo de Atividades. Esta condição tem de conter "campo" e "igual" ou "containsAny".
ErrorResponse

A resposta do erro.

ActionGroup

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

Name Tipo Description
actionGroupId

string

O ID do recurso do Grupo de Ações. Não pode ser nulo ou estar vazio.
webhookProperties

object

o dicionário de propriedades personalizadas a incluir com a operação de publicação. Estes dados são anexados ao payload do webhook.

ActionList

Uma lista de ações de regras de Alerta do Registo de Atividades.

Name Tipo Description
actionGroups

ActionGroup[]

A lista dos Grupos de Ações.

ActivityLogAlertResource

Um recurso de regra de Alerta do Registo de Atividades.

Name Tipo Default value Description
id

string

O 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 cumprida.
properties.condition

AlertRuleAllOfCondition

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

string

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

boolean

True

Indica se esta regra de Alerta do Registo de Atividades está ativada. Se uma regra de Alerta do Registo de Atividades não estiver ativada, nenhuma das ações será ativada.
properties.scopes

string[]

Uma lista de IDs de recursos que serão utilizados como prefixos. O alerta só se aplicará a eventos do Registo de Atividades com IDs de recursos que se enquadram num destes prefixos. Esta lista tem de incluir, pelo menos, um item.
tags

object

As etiquetas do recurso.
type

string

O tipo do recurso.

AlertRuleAllOfCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas.

Name Tipo Description
allOf

AlertRuleAnyOfOrLeafCondition[]

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

AlertRuleAnyOfOrLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando todas as condições dos membros são cumpridas. Cada condição pode ser de um dos seguintes tipos: Importante: cada tipo tem o seu subconjunto exclusivo de propriedades. Não é possível existir propriedades de diferentes tipos numa condição.

  • Condição de Folha - tem de conter "campo" e "igual" ou "containsAny". Tenha em atenção que "anyOf" não deve ser definido numa Condição de Folha.
  • AnyOf Condition - tem de conter apenas "anyOf" (que é uma matriz de Condições de Folha). Tenha em atenção que "campo", "igual a" e "containsAny" não devem ser definidos numa Condição AnyOf.
Name Tipo Description
anyOf

AlertRuleLeafCondition[]

Uma condição "anyOf" da regra de Alerta do Registo de Atividades.
Uma condição de regra de Alerta do Registo de Atividades que é cumprida quando pelo menos uma das condições de folha membro é cumprida.
containsAny

string[]

O valor do campo do evento será comparado com os valores nesta matriz (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
equals

string

O valor do campo do evento será comparado a este valor (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
field

string

O nome do campo do evento do Registo de Atividades que esta condição irá examinar. Os valores possíveis para este campo são (não sensíveis a maiúsculas e minúsculas): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" ou qualquer coisa que comece com "propriedades".

AlertRuleLeafCondition

Uma condição de regra de Alerta do Registo de Atividades que é cumprida ao comparar o campo e o valor de um evento do Registo de Atividades. Esta condição tem de conter "campo" e "igual" ou "containsAny".

Name Tipo Description
containsAny

string[]

O valor do campo do evento será comparado com os valores nesta matriz (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
equals

string

O valor do campo do evento será comparado a este valor (não sensível a maiúsculas e minúsculas) para determinar se a condição é cumprida.
field

string

O nome do campo do evento do Registo de Atividades que esta condição irá examinar. Os valores possíveis para este campo são (não sensíveis a maiúsculas e minúsculas): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" ou qualquer coisa que comece com "propriedades".

ErrorResponse

A resposta do erro.

Name Tipo Description
code

string

O código de erro.
message

string

A mensagem de erro que indica a razão pela qual a operação falhou.