Share via

Ejecución de la API de examen antivirus

  • Artículo

Se aplica a:

¿Quiere experimentar Microsoft Defender para punto de conexión? Regístrese para obtener una prueba gratuita.

Nota:

Si es cliente del Gobierno de EE. UU., use los URI que aparecen en Microsoft Defender para punto de conexión para los clientes del Gobierno de EE. UU.

Sugerencia

Para mejorar el rendimiento, puede usar el servidor más cercano a la ubicación 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

Descripción de la API

Inicie Microsoft Defender examen antivirus en un dispositivo.

Limitaciones

  1. Las limitaciones de velocidad de esta API son 100 llamadas por minuto y 1500 llamadas por hora.

Nota:

Esta página se centra en realizar una acción de máquina a través de la API. Consulte Realizar acciones de respuesta en una máquina para obtener más información sobre la funcionalidad de las acciones de respuesta a través de Microsoft Defender para punto de conexión.

Importante

  • Esta acción está disponible para dispositivos en Windows 10, versión 1709 o posterior, y en Windows 11.
  • Un examen Microsoft Defender Antivirus puede ejecutarse junto con otras soluciones antivirus, tanto si Microsoft Defender Antivirus es la solución antivirus activa como si no. Microsoft Defender Antivirus puede estar en modo pasivo. Para obtener más información, consulte compatibilidad con Microsoft Defender Antivirus.

Permisos

Se requiere uno de los siguientes permisos para llamar a esta API. Para más información, incluido cómo elegir permisos, consulte Uso de api de Microsoft Defender para punto de conexión

Tipo de permiso Permiso Nombre para mostrar del permiso
Aplicación Machine.Scan "Máquina de examen"
Delegado (cuenta profesional o educativa) Machine.Scan "Máquina de examen"

Nota:

Al obtener un token con credenciales de usuario:

  • El usuario debe tener al menos el siguiente permiso de rol: "Acciones de corrección activas" (vea Create y administrar roles para obtener más información).
  • El usuario debe tener acceso al dispositivo en función de la configuración del grupo de dispositivos (consulte Create y administrar grupos de dispositivos para obtener más información).

La creación de grupos de dispositivos se admite en El plan 1 y el plan 2 de Defender para punto de conexión.

Solicitud HTTP

POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan

Encabezados de solicitud

Nombre Tipo Descripción
Authorization Cadena {token} de portador. Necesario.
Content-Type string application/json

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione un objeto JSON con los parámetros siguientes:

Parámetro Tipo Descripción
Comentario Cadena Comentario que se va a asociar a la acción. Necesario.
ScanType Cadena Define el tipo de examen. Necesario.

ScanType controla el tipo de examen que se va a realizar y puede ser uno de los siguientes:

  • Rápido: Realizar un examen rápido en el dispositivo
  • Completo: realizar un examen completo en el dispositivo

Respuesta

Si se ejecuta correctamente, este método devuelve 201, Código de respuesta creado y objeto MachineAction en el cuerpo de la respuesta.

Si envía varias llamadas API para ejecutar un examen antivirus para el mismo dispositivo, devuelve "acción de máquina pendiente" o HTTP 400 con el mensaje "La acción ya está en curso".

Ejemplo

Solicitud

Aquí tiene un ejemplo de la solicitud.

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan 

{
  "Comment": "Check machine for viruses due to alert 3212",
  "ScanType": "Full"
}

Sugerencia

¿Desea obtener más información? Engage con la comunidad de seguridad de Microsoft en nuestra comunidad tecnológica: Microsoft Defender para punto de conexión Tech Community.