Obter o histórico de análises por definiçã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 como se inscrever numa 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 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 definições.

Suporta operações OData.
Operadores suportados pelo OData:
- $top com o valor máximo de 4096. Devolve o número de sessões especificadas no pedido.
- $skip com um valor predefinido de 0. Ignora o número de sessões especificadas no pedido.

Para obter um exemplo de utilização da operação OData, veja exemplo $top pedido.

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" (Consulte Criar e gerir 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 do pedido, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Descrição
ScanDefinitionIds	Cadeia de caracteres	O ID da análise. 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 por definição.

Exemplo de solicitação

Eis um exemplo do pedido.

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"
    },
   ]
}

Exemplo $top pedido

Eis um exemplo de um pedido que devolve apenas 1 sessão.

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

exemplo de Resposta $top

{
"@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