Obter histórico de verificação por definição

Artigo
05/03/2024

Aplica-se a:

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

Quer experimentar Gerenciamento de Vulnerabilidades do Microsoft Defender? Descubra como se inscrever para uma avaliação gratuita.

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 você for um cliente do governo dos EUA, use as URIs listadas em Microsoft Defender para Ponto de Extremidade para clientes do governo dos EUA.

Dica

Para obter um melhor desempenho, você pode usar 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

Descrição da API

Recupera uma lista do histórico de verificação por definições.

Dá suporte a operações OData.
Operadores com suporte do OData:
- $top com o valor máximo de 4096. Retorna o número de sessões especificadas na solicitação.
- $skip com um valor padrão de 0. Ignora o número de sessões especificadas na solicitação.

Para obter um exemplo de uso da operação OData, consulte exemplo $top solicitação.

Limitações

As limitações de taxa para essa 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 Usar APIs de Microsoft Defender para Ponto de Extremidade.

Tipo de permissão	Permissão	Nome da exibição de permissão
Application	Machine.Read.All	Leia todas as informações de verificação.
Delegado (conta corporativa ou de estudante)	Machine.Read.All	Leia todas as informações de verificação.

Observação

Ao obter um token usando credenciais de usuário:

Para exibir dados, o usuário precisa ter pelo menos a seguinte permissão de função: 'ViewData' ou 'TvmViewData' (consulte Create e gerencie funções para obter mais informações)

Solicitação HTTP

POST api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId

Cabeçalhos de solicitação

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

Corpo da solicitação

No corpo da solicitação, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Descrição
ScanDefinitionIds	Cadeia de caracteres	A ID de verificação. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará o código de resposta 200 – OK com uma lista do histórico de verificação por definição.

Exemplo de solicitação

Aqui está um exemplo da solicitação.

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

{
    "ScanDefinitionIds": ["4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae", "60c4aa57-c573-4488-8d18-230914792a92", "c6220f67-2cad-4ba3-a2fa-7ded6384da56"]
}

Exemplo de resposta

{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
    "value": [
    {
    "ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
    "LastScanned": "2022-12-20T11:14:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
    {
    "ScanDefinitionIds": "60c4aa57-c573-4488-8d18-230914792a92",
    "LastScanned": "2022-11-17T15:13:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
    {
    "ScanDefinitionIds": "c6220f67-2cad-4ba3-a2fa-7ded6384da56",
    "LastScanned": "2022-11-10T18:15:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
   ]
}

Solicitação de $top de exemplo

Aqui está um exemplo de uma solicitação que retorna apenas uma sessão.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId?$top=1

$top Exemplo de resposta

{
"@odata.context": "https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/GetScanHistoryByScanDefinitionId",
    "value": [
    {
    "ScanDefinitionIds": "4ad8d463-6b3a-4894-b42a-a2de9ea0a8ae",
    "LastScanned": "2022-12-20T11:14:24.5561791Z",
    "ScanStatus": "Partial Success",
    "ScannerId": "625431694b7d2ca9d07e77ca1b029ef216bebb6d"
    },
 ]
}

Compartilhar via