Obter o histórico de análises por sessão

Artigo
08/14/2024

Aplica-se a:

Deseja experimentar o Microsoft Defender para Ponto de Extremidade? Inscreva-se para uma avaliação gratuita.

Quer experimentar a Gestão de Vulnerabilidades do Microsoft Defender? Saiba mais sobre como se pode inscrever na versão de avaliação de pré-visualização pública da Gestão de Vulnerabilidades do Microsoft Defender.

Importante

Algumas informações neste artigo estão relacionadas ao produto pré-lançado que pode ser modificado substancialmente antes de ser lançado comercialmente. A Microsoft não oferece garantias, expressas ou implícitas, com relação às informações aqui fornecidas.

Observação

Se for um cliente do Us Government, utilize os URIs listados no Microsoft Defender para Endpoint para clientes do Us Government.

Dica

Para um melhor desempenho, pode utilizar o servidor mais próximo da localização geográfica:

us.api.security.microsoft.com
eu.api.security.microsoft.com
uk.api.security.microsoft.com
au.api.security.microsoft.com
swa.api.security.microsoft.com
ina.api.security.microsoft.com

Descrição da API

Obtém uma lista do histórico de análises por sessão.

Limitações

As limitações de taxa para esta API são 100 chamadas por minuto e 1500 chamadas por hora.

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, consulte Utilizar as APIs do Microsoft Defender para Endpoint.

Tipo de permissão	Permissão	Nome a apresentar da permissão
Application	Machine.Read.All	Leia todas as informações de análise.
Delegado (conta corporativa ou de estudante)	Machine.Read.All	Leia todas as informações de análise.

Observação

Ao obter um token com credenciais de utilizador:

Para ver os dados, o utilizador tem de ter, pelo menos, a seguinte permissão de função: ViewData ou TvmViewData. Para obter mais informações, veja Criar e gerir funções.

Solicitação HTTP

POST /api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId

Cabeçalhos de solicitação

Nome	Tipo	Descrição
Autorização	string	{token} de portador. Obrigatório.
Content-Type	string	application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Descrição
SessionIds	Cadeia de caracteres	O ID da sessão. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve o código de resposta 200 - OK com uma lista do histórico de análise de uma sessão.

Exemplo de solicitação

Eis um exemplo do pedido.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId

{
    "SessionIds": ["01decc497f4b4ec49a5fc4e12597f8c8"]
}

Exemplo de resposta

{
 "@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryBySessionId",
    "value": [
    {
     "orgId": "asdf781a0c-792d-46d3-bbea-a93dbc0bfcaa",
     "ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
     "SessionIds": "01decc497f4b4ec49a5fc4e12597f8c8",
     "NumberOfSuccessfullyScannedTargets": 3,
     "NumberOfTargets": 3,
     "ScanStatus": "Success",
     "LastScanned": "2022-12-19T15:14:24.5561791Z",
     "ListScannedTargets": {
         "Ip": "127.0.0.1",
         "Hostname": "DESKTOP-Test",
         "ScannedDeviceDescription": "Network device",
         "ErrorMessage": "",
         "ScanStatus": "Success",
         "ScanDuration": "00:08:30",
        },
        {
         "Ip": "127.0.0.2",
         "Hostname": "DESKTOP-Test2",
         "ScannedDeviceDescription": "Network device 2",
         "ErrorMessage": "",
         "ScanStatus": "Success",
         "ScanDuration": "00:08:00",
        },
{
         "Ip": "127.0.0.3",
         "Hostname": "DESKTOP-Test3",
         "ScannedDeviceDescription": "Network device 3",
         "ErrorMessage": "",
         "ScanStatus": "Success",
         "ScanDuration": "00:08:50",
        },
    }
  ]
}