Executar a API de análise de antivírus
Aplica-se a:
Quer experimentar o Microsoft Defender para Ponto Final? Inscrever-se para uma avaliação gratuita.
Nota
Se for um cliente do Us Government, utilize os URIs listados no Microsoft Defender para Endpoint para clientes do Us Government.
Sugestão
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
Inicie a análise do Antivírus do Microsoft Defender num dispositivo.
Limitações
- As limitações de taxa para esta API são 100 chamadas por minuto e 1500 chamadas por hora.
Nota
Esta página centra-se na execução de uma ação de computador através da API. Veja tomar medidas de resposta num computador para obter mais informações sobre a funcionalidade de ações de resposta através do Microsoft Defender para Endpoint.
Importante
- Esta ação está disponível para dispositivos com o Windows 10, versão 1709 ou posterior e no Windows 11.
- Uma análise do Antivírus do Microsoft Defender pode ser executada juntamente com outras soluções antivírus, quer o Antivírus do Microsoft Defender seja ou não a solução antivírus ativa. O Antivírus do Microsoft Defender pode estar no modo Passivo. Para obter mais informações, consulte Compatibilidade do Antivírus do Microsoft Defender.
Permissões
É necessária uma das seguintes permissões 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 |
|---|---|---|
| Aplicação | Machine.Scan | "Máquina de digitalização" |
| Delegado (conta escolar ou profissional) | Machine.Scan | "Máquina de digitalização" |
Nota
Ao obter um token com credenciais de utilizador:
- O utilizador tem de ter, pelo menos, a seguinte permissão de função: "Ações de remediação ativas" (consulte Criar e gerir funções para obter mais informações)
- O utilizador precisa de ter acesso ao dispositivo, com base nas definições do grupo de dispositivos (consulte Criar e gerir grupos de dispositivos para obter mais informações)
A criação de grupos de dispositivos é suportada no Defender para Endpoint Plano 1 e Plano 2.
Pedido HTTP
POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan
Cabeçalhos de pedido
| Name | Tipo | Descrição |
|---|---|---|
| Autorização | Cadeia | Portador {token}. Obrigatório. |
| Tipo de Conteúdo | cadeia | aplicação/json |
Corpo do pedido
No corpo do pedido, forneça um objeto JSON com os seguintes parâmetros:
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Comentar | Cadeia | Comentário a associar à ação. Obrigatório. |
| ScanType | Cadeia | Define o tipo de Análise. Obrigatório. |
ScanType controla o tipo de análise a executar e pode ser um dos seguintes:
- Rápido: efetuar uma análise rápida no dispositivo
- Completo: efetuar a análise completa no dispositivo
Resposta
Se for bem-sucedido, este método devolve 201, Código de resposta criado e objeto MachineAction no corpo da resposta.
Se enviar várias chamadas à API para executar uma análise antivírus para o mesmo dispositivo, devolve "ação do computador pendente" ou HTTP 400 com a mensagem "A ação já está em curso".
Exemplos:
Pedido
Eis um exemplo do pedido.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan
{
"Comment": "Check machine for viruses due to alert 3212",
"ScanType": "Full"
}
Sugestão
Quer saber mais? Contacte a comunidade de Segurança da Microsoft na nossa Comunidade Tecnológica: Microsoft Defender para Endpoint Tech Community.