Alerts - Get Summary

Referência

Service:: Monitor

API Version:: 2023-07-12-preview

Obtenha uma contagem resumida dos alertas agrupados por vários parâmetros (por exemplo, o agrupamento por "Gravidade" devolve 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 do URI

Name	Em	Necessário	Tipo	Description
scope	path	True	string	o âmbito aqui é resourceId para o qual o alerta é criado.
api-version	query	True	string	A versão da API a utilizar para esta operação.
groupby	query	True	AlertsSummaryGroupByFields	Este parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (Máximo de 2 campos separados por vírgulas suportados). Por exemplo, groupby=severidade ou groupby=gravidade,alertstate.
alertRule	query		string	Filtrar por regra de alerta específica. O valor predefinido é selecionar tudo.
alertState	query		AlertState	Filtrar por estado da instância de alerta. O valor predefinido é selecionar tudo.
customTimeRange	query		string	Filtre por intervalo de tempo personalizado no formato /em que o tempo está no (formato ISO-8601)". Os valores permitidos estão dentro de 30 dias a partir do tempo de consulta. TimeRange ou customTimeRange podem ser utilizados, mas não ambos. A predefinição é nenhum.
includeSmartGroupsCount	query		boolean	Inclua a contagem dos SmartGroups como parte do resumo. O valor predefinido é "falso".
monitorCondition	query		MonitorCondition	Filtrar por condição de monitor que é "Acionado" ou "Resolvido". O valor predefinido é selecionar tudo.
monitorService	query		MonitorService	Filtrar por serviço de monitorização que gera a instância de alerta. O valor predefinido é selecionar tudo.
severity	query		Severity	Filtrar por gravidade. O valor predefinido é selecionar tudo.
targetResource	query		string	Filtrar por recurso de destino( que é ID do ARM completo) O valor predefinido está selecionado.
targetResourceGroup	query		string	Filtrar por nome do grupo de recursos de destino. O valor predefinido é selecionar tudo.
targetResourceType	query		string	Filtrar por tipo de recurso de destino. O valor predefinido é selecionar tudo.
timeRange	query		TimeRange	Filtre por intervalo de tempo por valores listados abaixo. O valor predefinido é 1 dia.

Respostas

Name	Tipo	Description
200 OK	alertsSummary	OK. Resumo do alerta devolvido.
Other Status Codes	errorResponse	Resposta de erro que descreve a razão pela qual 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

Name	Description
alertsSummary	Resumo dos alertas com base nos filtros de entrada e nos parâmetros "groupby".
alertsSummaryGroup	Agrupe o conjunto de resultados.
AlertsSummaryGroupByFields	Este parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (Máximo de 2 campos separados por vírgulas suportados). Por exemplo, groupby=severidade ou groupby=gravidade,alertstate.
alertsSummaryGroupItem	Item de grupo de resumo de alertas
AlertState	Estado do objeto de alerta, que pode ser modificado pelo utilizador.
errorResponse	Uma resposta de erro do serviço.
errorResponseBody	Detalhes da resposta ao erro.
MonitorCondition	Condição da regra no serviço de monitorização. Representa se as condições subjacentes ultrapassaram os limiares de regra de alerta definidos.
MonitorService	Monitorize o serviço no qual a regra(monitor) está definida.
Severity	A gravidade do alerta Sev0 é a mais alta e a sev4 é a mais baixa.
TimeRange	Filtre por intervalo de tempo por valores listados abaixo. O valor predefinido é 1 dia.

alertsSummary

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

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

Name	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

Este parâmetro permite que o conjunto de resultados seja agrupado por campos de entrada (Máximo de 2 campos separados por vírgulas suportados). Por exemplo, groupby=severidade ou groupby=gravidade,alertstate.

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

alertsSummaryGroupItem

Item de grupo de resumo de alertas

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

Name	Tipo	Description
Acknowledged	string
Closed	string
New	string

errorResponse

Uma resposta de erro do serviço.

Name	Tipo	Description
error	errorResponseBody	Detalhes da resposta ao erro.

errorResponseBody

Detalhes da resposta ao erro.

Name	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 a ser apresentado na interface de utilizador.
target	string	Destino do erro específico, por exemplo, o nome da propriedade.

MonitorCondition

Condição da regra no serviço de monitorização. Representa se as condições subjacentes ultrapassaram os limiares de regra de alerta definidos.

Name	Tipo	Description
Fired	string
Resolved	string

MonitorService

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

Name	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

A gravidade do alerta Sev0 é a mais alta e a sev4 é a mais baixa.

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

TimeRange

Filtre por intervalo de tempo por valores listados abaixo. O valor predefinido é 1 dia.

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