Activity Log Alerts - List By Subscription Id

Obtenha uma lista de todas as regras de Alerta do Log de Atividades em uma assinatura.

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

Parâmetros de URI

Name In Required Type Description
subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

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

Respostas

Name Type Description
200 OK

Solicitação com êxito.

Other Status Codes

Erro e não foi possível recuperar a lista de regras de Alerta do Log de Atividades.

Segurança

azure_auth

Flow Azure Active Directory OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

Get list of all Activity Log Alert rules under a subscription

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup1/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule1",
      "type": "Microsoft.Insights/ActivityLogAlerts",
      "name": "SampleActivityLogAlertRule1",
      "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/MyResourceGroup1/providers/microsoft.insights/actionGroups/SampleActionGroup",
              "webhookProperties": {
                "sampleWebhookProperty": "SamplePropertyValue"
              }
            }
          ]
        },
        "enabled": true,
        "description": "Description of sample Activity Log Alert rule."
      }
    },
    {
      "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule2",
      "type": "Microsoft.Insights/ActivityLogAlerts",
      "name": "SampleActivityLogAlertRule2",
      "location": "Global",
      "tags": {},
      "properties": {
        "scopes": [
          "subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2"
        ],
        "condition": {
          "allOf": [
            {
              "field": "category",
              "equals": "Administrative"
            },
            {
              "field": "status",
              "equals": "Succeeded"
            }
          ]
        },
        "actions": {
          "actionGroups": [
            {
              "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup2/providers/microsoft.insights/actionGroups/SampleActionGroup",
              "webhookProperties": {}
            }
          ]
        },
        "enabled": true,
        "description": "Description of sample Activity Log Alert rule."
      }
    }
  ]
}

Definições

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 diferentes tipos 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.
  • AnyOf Condition - 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'.

AlertRuleList

Uma lista de regras de alerta do Log de Atividades.

ErrorResponse

A resposta de erro.

ActionGroup

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

Name Type 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.

Name Type Description
actionGroups

A lista dos Grupos de Ações.

ActivityLogAlertResource

Um recurso de regra de Alerta do Log de Atividades.

Name Type Default Value Description
id
  • string

A ID do recurso.

location
  • string
global

A localização do recurso. Como os Alertas do Log de Atividades do Azure são um serviço global, o local das regras deve ser sempre "global".

name
  • string

O nome do recurso.

properties.actions

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

properties.condition

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

properties.description
  • string

Uma descrição dessa 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.

Name Type Description
allOf

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 diferentes tipos 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.
  • AnyOf Condition - 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.
Name Type Description
anyOf

Uma condição 'anyOf' da regra de alerta do Log de Atividades.
Uma condição de regra de Alerta do Log 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 (não diferencia maiúsculas de minúsculas) para determinar se a condição foi atendida.

equals
  • string

O valor do campo do evento será comparado a esse valor (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 (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'.

Name Type Description
containsAny
  • string[]

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

equals
  • string

O valor do campo do evento será comparado a esse valor (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 (diferencia maiúsculas de minúsculas): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' ou qualquer coisa que comece com 'properties'.

AlertRuleList

Uma lista de regras de alerta do Log de Atividades.

Name Type Description
nextLink
  • string

Fornece o link para recuperar o próximo conjunto de elementos.

value

A lista de regras de Alerta do Log de Atividades.

ErrorResponse

A resposta de erro.

Name Type Description
code
  • string

O código de erro.

message
  • string

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