Alerts - Get All

Referência

Serviço:: Monitor

Versão da API:: 2023-07-12-preview

Liste todos os alertas existentes, onde os resultados podem ser filtrados com base em vários parâmetros (por exemplo, intervalo de tempo). Em seguida, os resultados podem ser ordenados nos campos específicos de base, sendo a predefinição lastModifiedDateTime.

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

Com parâmetros opcionais:

GET https://management.azure.com/{scope}/providers/Microsoft.AlertsManagement/alerts?targetResource={targetResource}&targetResourceType={targetResourceType}&targetResourceGroup={targetResourceGroup}&monitorService={monitorService}&monitorCondition={monitorCondition}&severity={severity}&alertState={alertState}&alertRule={alertRule}&smartGroupId={smartGroupId}&includeContext={includeContext}&includeEgressConfig={includeEgressConfig}&pageCount={pageCount}&sortBy={sortBy}&sortOrder={sortOrder}&select={select}&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.
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.
includeContext	query		boolean	Inclua o contexto que tem dados contextuais específicos do serviço de monitorização. O valor predefinido é falso"
includeEgressConfig	query		boolean	Inclua a configuração de saída que seria utilizada para apresentar o conteúdo no portal. 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.
pageCount	query		integer int64	Determina o número de alertas devolvidos por página em resposta. O valor permitido está entre 1 e 250. Quando o filtro "includeContent" estiver selecionado, o valor máximo permitido é 25. O valor predefinido é 25.
select	query		string	Este filtro permite a seleção dos campos (separados por vírgulas) que fariam parte da secção essencial. Isto permitiria projetar apenas os campos necessários em vez de obter todo o conteúdo. A predefinição é obter todos os campos na secção essentials.
severity	query		Severity	Filtrar por gravidade. O valor predefinido é selecionar tudo.
smartGroupId	query		string	Filtre a lista de alertas pelo ID do Grupo Inteligente. O valor predefinido não é nenhum.
sortBy	query		AlertsSortByFields	Ordene os resultados da consulta por campo de entrada. O valor predefinido é "lastModifiedDateTime".
sortOrder	query		SortOrder	Ordene a ordem dos resultados da consulta em ordem ascendente ou descendente. O valor predefinido é "desc" para campos de tempo e "asc" para outras pessoas.
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	alertsList	OK. Objetos de alerta listados com êxito.
Other Status Codes	errorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

ListAlerts

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "nextLink": "https://management.azure.com:443/subscriptions/1e3ff1c0-771a-4119-a03b-be82a51e232d/providers/Microsoft.AlertsManagement/alerts?api-version=2018-05-05-preview&timeRange=1d&ctoken=%2bRID%3aPlwOAPHEGwB9UwEAAAAgCw%3d%3d%23RT%3a2%23TRC%3a500%23RTD%3aqtQyMDE4LTA2LTEyVDE1OjEyOjE1",
  "value": [
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "Acknowledged",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight",
          "targetResourceName": "servicedeskappinsight",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "23d6b2ce-8c54-468f-aff0-sd32aebb7e56",
          "smartGroupingReason": "Occurred frequently with other alerts",
          "alertRule": "https://servisdffsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    },
    {
      "properties": {
        "essentials": {
          "severity": "Sev3",
          "signalType": "Log",
          "alertState": "New",
          "monitorCondition": "Fired",
          "monitorService": "Application Insights",
          "targetResource": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus",
          "targetResourceName": "servicedeskwcus",
          "targetResourceGroup": "servicedeskresourcegroup",
          "targetResourceType": "components",
          "sourceCreatedId": "6cd6b2ce-8c54-468f-aff0-9d12aebb7e49",
          "smartGroupId": "d1c49c89-ea95-4697-a299-c0f5ebac62f1",
          "smartGroupingReason": "Alerts that frequently occur together have been grouped.",
          "alertRule": "https://servicsdfsdf.portal.mms.microsoft.com/#Workspace/overview/settings/details/Edit Alert Rule/details/index?savedSearchId=&scheduleId=",
          "startDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedDateTime": "2018-09-13T15:51:02Z",
          "lastModifiedUserName": "System",
          "monitorConditionResolvedDateTime": "2018-09-13T15:51:02Z",
          "actionStatus": {
            "isSuppressed": false
          },
          "description": "description of the alert"
        },
        "egressConfig": {},
        "context": {}
      },
      "id": "/subscriptions/9e261de7-c804-4b9d-9ebf-6f50fe350a9a/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100",
      "type": "Microsoft.AlertsManagement/alerts",
      "name": "cpu alert"
    }
  ]
}

Definições

Name	Description
actionStatus	Estado da ação
alert	Um alerta criado no serviço de gestão de alertas.
alertProperties	Saco de propriedades de alerta
alertsList	Liste os alertas.
AlertsSortByFields	Ordene os resultados da consulta por campo de entrada. O valor predefinido é "lastModifiedDateTime".
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.
essentials	Este objeto contém campos consistentes em diferentes serviços de monitorização.
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.
SignalType	O tipo de sinal em que o alerta se baseia, que pode ser métricas, registos ou registos de atividades.
SortOrder	Ordene a ordem dos resultados da consulta em ordem ascendente ou descendente. O valor predefinido é "desc" para campos de tempo e "asc" para outras pessoas.
TimeRange	Filtre por intervalo de tempo por valores listados abaixo. O valor predefinido é 1 dia.

actionStatus

Estado da ação

Name	Tipo	Description
isSuppressed	boolean	Valor que indica se o alerta é suprimido.

alert

Um alerta criado no serviço de gestão de alertas.

Name	Tipo	Description
id	string	ID do recurso do Azure
name	string	Nome do recurso do Azure
properties	alertProperties	Saco de propriedades de alerta
type	string	Tipo de recurso do Azure

alertProperties

Saco de propriedades de alerta

Name	Tipo	Description
context	object	Informações específicas do serviço de monitorização que fornecem detalhes mais contextuais sobre o alerta.
egressConfig	object	Configuração que seria utilizada para apresentar os dados no portal.
essentials	essentials	Este objeto contém campos consistentes em diferentes serviços de monitorização.

alertsList

Liste os alertas.

Name	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de alertas.
value	alert[]	Lista de alertas

AlertsSortByFields

Ordene os resultados da consulta por campo de entrada. O valor predefinido é "lastModifiedDateTime".

Name	Tipo	Description
alertState	string
lastModifiedDateTime	string
monitorCondition	string
name	string
severity	string
startDateTime	string
targetResource	string
targetResourceGroup	string
targetResourceName	string
targetResourceType	string

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.

essentials

Este objeto contém campos consistentes em diferentes serviços de monitorização.

Name	Tipo	Description
actionStatus	actionStatus	Estado da ação
alertRule	string	Regra(monitor) que acionou a instância de alerta. Dependendo do serviço de monitorização, este seria o ID do ARM ou o nome da regra.
alertState	AlertState	Estado do objeto de alerta, que pode ser modificado pelo utilizador.
description	string	Descrição do alerta.
lastModifiedDateTime	string	Hora da última modificação (formato ISO-8601) da instância de alerta.
lastModifiedUserName	string	O utilizador que modificou o alerta pela última vez, no caso de monitorizar as atualizações do serviço, o utilizador seria "sistema", caso contrário, o nome do utilizador.
monitorCondition	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.
monitorConditionResolvedDateTime	string	Tempo resolvido (formato ISO-8601) da instância de alerta. Esta ação será atualizada quando o serviço de monitorização resolver a instância de alerta porque a condição de regra já não é cumprida.
monitorService	MonitorService	Monitorize o serviço no qual a regra(monitor) está definida.
severity	Severity	A gravidade do alerta Sev0 é a mais alta e a sev4 é a mais baixa.
signalType	SignalType	O tipo de sinal em que o alerta se baseia, que pode ser métricas, registos ou registos de atividades.
smartGroupId	string	ID exclusivo do grupo inteligente
smartGroupingReason	string	Razão verbosa que descreve o motivo pelo qual esta instância de alerta é adicionada a um grupo inteligente
sourceCreatedId	string	ID exclusivo criado pelo serviço de monitorização para cada instância de alerta. Isto pode ser utilizado para controlar o problema no serviço de monitorização, no caso de Nagios, Zabbix, SCOM, etc.
startDateTime	string	Tempo de criação (formato ISO-8601) da instância de alerta.
targetResource	string	Recurso arm de destino, no qual o alerta foi criado.
targetResourceGroup	string	Grupo de recursos do recurso ARM de destino, no qual o alerta foi criado.
targetResourceName	string	Nome do nome do recurso arm de destino, no qual o alerta foi criado.
targetResourceType	string	Tipo de recurso do recurso arm de destino, no qual o alerta foi criado.

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

SignalType

O tipo de sinal em que o alerta se baseia, que pode ser métricas, registos ou registos de atividades.

Name	Tipo	Description
Log	string
Metric	string
Unknown	string

SortOrder

Ordene a ordem dos resultados da consulta em ordem ascendente ou descendente. O valor predefinido é "desc" para campos de tempo e "asc" para outras pessoas.

Name	Tipo	Description
asc	string
desc	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

Partilhar via