Alerts - Get Summary

Referência

Service:: Monitor

API Version:: 2023-07-12-preview

Obter uma contagem resumida de seus alertas agrupados por vários parâmetros (por exemplo, agrupamento por 'Severidade' retorna a contagem de alertas para cada gravidade).

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&api-version=2023-07-12-preview

With optional parameters:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alertsSummary?groupby={groupby}&includeSmartGroupsCount={includeSmartGroupsCount}&targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&timeRange={timeRange}&customTimeRange={customTimeRange}&api-version=2023-07-12-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
scope	path	True	string	aqui está resourceId para o qual o alerta é criado.
api-version	query	True	string	A versão da API a ser usada para esta operação.
groupby	query	True	AlertsSummaryGroupByFields	Esse parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (máximo de dois campos separados por vírgula com suporte). Por exemplo, groupby=severity ou groupby=severity,alertstate.
alertRule	query		string	Filtrar por regra de alerta específica. O valor padrão é selecionar todos.
alertState	query		AlertState	Filtrar por estado da instância de alerta. O valor padrão é selecionar todos.
customTimeRange	query		string	Filtre por intervalo de tempo personalizado no formato /em que o tempo está (formato ISO-8601)'. Os valores permitidos estão dentro de 30 dias a partir do tempo de consulta. TimeRange ou customTimeRange podem ser usados, mas não ambos. O padrão é nenhum.
includeSmartGroupsCount	query		boolean	Inclua a contagem dos SmartGroups como parte do resumo. O valor padrão é 'false'.
monitorCondition	query		MonitorCondition	Filtre por condição de monitor, que é "Acionado" ou "Resolvido". O valor padrão é selecionar todos.
monitorService	query		MonitorService	Filtrar pelo serviço monitor que gera a instância de alerta. O valor padrão é selecionar todos.
severity	query		Severity	Filtrar por gravidade. O valor padrão é selecionar todos.
targetResource	query		string	Filtrar por recurso de destino( que é a ID completa do ARM) O valor padrão é selecionar todos.
targetResourceGroup	query		string	Filtrar pelo nome do grupo de recursos de destino. O valor padrão é selecionar todos.
targetResourceType	query		string	Filtrar por tipo de recurso de destino. O valor padrão é selecionar todos.
timeRange	query		TimeRange	Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

Respostas

Nome	Tipo	Description
200 OK	alertsSummary	OK. Resumo do alerta retornado.
Other Status Codes	errorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

Summary

Sample Request

HTTP

GET https://management.azure.com/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary?groupby=severity,alertState&api-version=2023-07-12-preview

Sample Response

Status code:: 200

{
  "properties": {
    "groupedby": "severity",
    "smartGroupsCount": 100,
    "total": 14189,
    "values": [
      {
        "name": "Sev0",
        "count": 6517,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 6517
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev1",
        "count": 3175,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 3175
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev2",
        "count": 1120,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1120
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev3",
        "count": 1902,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1902
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      },
      {
        "name": "Sev4",
        "count": 1475,
        "groupedby": "alertState",
        "values": [
          {
            "name": "New",
            "count": 1475
          },
          {
            "name": "Acknowledged",
            "count": 0
          },
          {
            "name": "Closed",
            "count": 0
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alertsSummary/current",
  "type": "Microsoft.AlertsManagement/alertsSummary",
  "name": "current"
}

Definições

Nome	Description
alertsSummary	Resumo dos alertas com base nos filtros de entrada e nos parâmetros 'groupby'.
alertsSummaryGroup	Agrupe o conjunto de resultados.
AlertsSummaryGroupByFields	Esse parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (máximo de dois campos separados por vírgula com suporte). Por exemplo, groupby=severity ou groupby=severity,alertstate.
alertsSummaryGroupItem	Item de grupo de resumo de alertas
AlertState	Estado do objeto de alerta, que pode ser modificado pelo usuário.
errorResponse	Uma resposta de erro do serviço.
errorResponseBody	Detalhes da resposta de erro.
MonitorCondition	Condição da regra no serviço monitor. Ele representa se as condições subjacentes ultrapassaram os limites de regra de alerta definidos.
MonitorService	Monitore o serviço no qual a regra(monitor) está definida.
Severity	Gravidade do alerta Sev0 sendo mais alto e Sev4 sendo mais baixo.
TimeRange	Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

alertsSummary

Resumo dos alertas com base nos filtros de entrada e nos parâmetros 'groupby'.

Nome	Tipo	Description
id	string	ID do recurso do Azure
name	string	Nome do recurso do Azure
properties	alertsSummaryGroup	Agrupe o conjunto de resultados.
type	string	Tipo de recurso do Azure

alertsSummaryGroup

Agrupe o conjunto de resultados.

Nome	Tipo	Description
groupedby	string	Nome do campo agregado
smartGroupsCount	integer	Contagem total dos grupos inteligentes.
total	integer	Contagem total do conjunto de resultados.
values	alertsSummaryGroupItem[]	Lista dos itens

AlertsSummaryGroupByFields

Esse parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (máximo de dois campos separados por vírgula com suporte). Por exemplo, groupby=severity ou groupby=severity,alertstate.

Nome	Tipo	Description
alertRule	string
alertState	string
monitorCondition	string
monitorService	string
severity	string
signalType	string

alertsSummaryGroupItem

Item de grupo de resumo de alertas

Nome	Tipo	Description
count	integer	Contagem do campo agregado
groupedby	string	Nome do campo agregado
name	string	Valor do campo agregado
values	alertsSummaryGroupItem[]	Lista dos itens

AlertState

Estado do objeto de alerta, que pode ser modificado pelo usuário.

Nome	Tipo	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	errorResponseBody	Detalhes da resposta de erro.

errorResponseBody

Detalhes da resposta de erro.

Nome	Tipo	Description
code	string	Código de erro, destinado a ser consumido programaticamente.
details	errorResponseBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Descrição do erro, destinado à exibição na interface do usuário.
target	string	Destino do erro específico, por exemplo, o nome da propriedade.

MonitorCondition

Condição da regra no serviço monitor. Ele representa se as condições subjacentes ultrapassaram os limites de regra de alerta definidos.

Nome	Tipo	Description
Fired	string
Resolved	string

MonitorService

Monitore o serviço no qual a regra(monitor) está definida.

Nome	Tipo	Description
ActivityLog Administrative	string
ActivityLog Autoscale	string
ActivityLog Policy	string
ActivityLog Recommendation	string
ActivityLog Security	string
Application Insights	string
Log Analytics	string
Nagios	string
Platform	string
Resource Health	string
SCOM	string
ServiceHealth	string
SmartDetector	string
VM Insights	string
Zabbix	string

Severity

Gravidade do alerta Sev0 sendo mais alto e Sev4 sendo mais baixo.

Nome	Tipo	Description
Sev0	string
Sev1	string
Sev2	string
Sev3	string
Sev4	string

TimeRange

Filtre por intervalo de tempo pelos valores listados abaixo. O valor padrão é 1 dia.

Nome	Tipo	Description
1d	string
1h	string
30d	string
7d	string