Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Description de l’API
Lancer Microsoft Defender analyse antivirus sur un appareil.
Une analyse antivirus Microsoft Defender peut s’exécuter avec d’autres solutions antivirus, que Microsoft Defender Antivirus soit la solution antivirus active ou non. Microsoft Defender antivirus peut être en mode passif. Pour plus d’informations, consultez compatibilité Microsoft Defender antivirus.
Limitations
Les limitations de débit pour cette API sont de 100 appels par minute et de 1 500 appels par heure.
Configuration requise
Systèmes d’exploitation pris en charge
- Windows 10, version 1709 ou ultérieure, et sur Windows 11.
- serveurs Linux. Consultez Distributions Linux prises en charge
- Macos. Voir Microsoft Defender pour point de terminaison sur macOS
Autorisations
Lors de l’obtention d’un jeton à l’aide des informations d’identification de l’utilisateur :
- L’utilisateur doit disposer au moins de l’autorisation de rôle suivante : « Actions de correction actives ». Pour plus d’informations, consultez : Créer et gérer des rôles.
- L’utilisateur doit avoir accès à l’appareil, en fonction des paramètres du groupe d’appareils. Pour plus d’informations, consultez Créer et gérer des groupes d’appareils.
L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour en savoir plus, notamment sur le choix des autorisations, consultez Utiliser des API Microsoft Defender pour point de terminaison.
| Type d’autorisation | Autorisation | Nom complet de l’autorisation |
|---|---|---|
| Application | Machine.Scan | 'Analyser la machine' |
| Déléguée (compte professionnel ou scolaire) | Machine.Scan | 'Analyser la machine' |
Requête HTTP
POST https://api.security.microsoft.com/api/machines/{id}/runAntiVirusScan
En-têtes de demande
| Nom | Type | Description |
|---|---|---|
| Autorisation | Chaîne | Porteur {token}. Obligatoire. |
| Content-Type | string | application/json |
Corps de la demande
Dans le corps de la demande, fournissez un objet JSON avec les paramètres suivants :
| Paramètre | Type | Description |
|---|---|---|
| Commentaire | Chaîne | Commentaire à associer à l’action. Obligatoire. |
| ScanType | String | Définit le type de l’analyse. Obligatoire. |
ScanType contrôle le type d’analyse à effectuer et peut être l’un des éléments suivants :
- Rapide : effectuer une analyse rapide sur l’appareil
- Complet : effectuer une analyse complète sur l’appareil
Réponse
Si elle réussit, cette méthode renvoie le code de réponse 201, Created et l’objet MachineAction dans le corps de la réponse.
Si vous envoyez plusieurs appels d’API pour exécuter une analyse antivirus pour le même appareil, elle retourne « action de machine en attente » ou HTTP 400 avec le message « L’action est déjà en cours ».
Exemple
Demande
Voici un exemple de demande.
POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/runAntiVirusScan
{
"Comment": "Check machine for viruses due to alert 3212",
"ScanType": "Full"
}