Een scandefinitie toevoegen, bijwerken of verwijderen

Artikel
08/14/2024

Van toepassing op:

Wilt u Microsoft Defender voor Eindpunt ervaren? Meld u aan voor een gratis proefversie.

Wilt u microsoft Defender Vulnerability Management ervaren? Meer informatie over hoe u zich kunt registreren voor de openbare preview-proefversie van Microsoft Defender Vulnerability Management.

Belangrijk

Sommige informatie in dit artikel heeft betrekking op een vooraf uitgebracht product dat aanzienlijk kan worden gewijzigd voordat het commercieel wordt uitgebracht. Microsoft geeft geen garanties, expliciet of impliciet, met betrekking tot de informatie die hier wordt verstrekt.

Opmerking

Als u een klant van de Amerikaanse overheid bent, gebruikt u de URI's die worden vermeld in Microsoft Defender voor Eindpunt voor klanten van de Amerikaanse overheid.

Tip

Voor betere prestaties kunt u de server dichter bij uw geografische locatie gebruiken:

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

API-beschrijving

API voor het toevoegen, bijwerken of verwijderen van een geverifieerde scan.

Beperkingen

Frequentiebeperkingen voor deze API zijn 100 aanroepen per minuut en 1500 aanroepen per uur.

U kunt posten op machines die voor het laatst zijn gezien volgens de geconfigureerde bewaarperiode.

Machtigingen

Een van de volgende machtigingen is vereist om deze API aan te roepen. Zie Defender voor Eindpunt-API's gebruiken voor meer informatie, waaronder het kiezen van machtigingen.

Machtigingstype	Machtiging	Weergavenaam van machtiging
Toepassing	Machine.ReadWrite.All	Lees en schrijf alle scangegevens.
Gedelegeerd (werk- of schoolaccount)	Machine.Read.Write	Lees en schrijf alle scangegevens.

Opmerking

Bij het verkrijgen van een token met behulp van gebruikersreferenties:

Als u gegevens wilt weergeven, moet de gebruiker ten minste de volgende rolmachtigingen hebben: ViewData of TvmViewData (zie Rollen maken en beheren voor meer informatie)
Als u gegevens wilt bewerken, moet de gebruiker ten minste de volgende rolmachtigingen hebben: ManageSecurity (zie Rollen maken en beheren voor meer informatie)

HTTP-aanvraag

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

Aanvraagheaders

Naam	Type	Beschrijving
Machtiging	Tekenreeks	Bearer {token}. Vereist.
Content-Type	tekenreeks	application/json. Vereist.

Aanvraagtekst

Geef in de aanvraagtekst een JSON-object op met de volgende parameters:

Parameter	Type	Beschrijving
scanType	Opsomming	Het type scan. Mogelijke waarden zijn: 'Windows', 'Netwerk'. Vereist.
scanName	Tekenreeks	Naam van de scan. Vereist.
isActive	Booleaanse waarde	Status van of de scan actief wordt uitgevoerd. Vereist.
doel	Tekenreeks	Een door komma's gescheiden lijst met doelen die moeten worden gescand, ip-adressen of hostnamen. Vereist.
intervalInHours	Int	Het interval waarmee de scan wordt uitgevoerd. Vereist.
targetType	Tekenreeks	Het doeltype in het doelveld. Mogelijke typen zijn 'IP-adres' of 'Hostnaam'. De standaardwaarde is IP-adres. Vereist.
scannerAgent	Object	machine-id. Vereist.
scanAuthenticationParams	Object	Zie Objecteigenschappen van verificatieparameters voor verwachte velden voor een object dat de verificatieparameters vertegenwoordigt. Deze eigenschap is verplicht bij het maken van een nieuwe scan en is optioneel bij het bijwerken van een scan.

Antwoord

Als dit lukt, retourneert deze methode 200 - OK-antwoordcode en de nieuwe of bijgewerkte scandefinitie in de antwoordtekst.

Voorbeeldaanvraag voor het toevoegen van een nieuwe scan

Hier volgt een voorbeeld van een aanvraag waarmee een nieuwe scan wordt toegevoegd.

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

 {
"scanType": "Windows", 
"scanName": "Test Windows scan", 
"isActive": true, 
"target": "127.0.0.1", 
"intervalInHours": 1, 
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
},
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
}

Voorbeeld van antwoord

Hier volgt een voorbeeld van het antwoord.

 {
"@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Windows scan",
    "isActive": true,
    "target": "127.0.0.1",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "username@test.com",
    "targetType": "Ip",
    "scanAuthenticationParams": null,
    "scannerAgent": {
        "id": "0335a792-18d2-424b-aeed-559567054570_ eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77",
        "machineName": "DESKTOP-TEST",
        "lastSeen": "2023-01-04T09:40:03.2787058Z",
        "assignedApplicationId": "ae4a5cde-b4a1-4b76-8635-458b2cf15752",
        "scannerSoftwareVersion": "7.6.0.0",
        "lastCommandExecutionTimestamp": "2023-01-04T09:33:16Z",
        "mdeClientVersion": "10.8295.22621.1010"
    },
    "latestScan": {
        "status": null,
        "failureReason": null,
        "executionDateTime": null
    }

}

Voorbeeldaanvraag voor het bijwerken van een scan

Hier volgt een voorbeeld van een aanvraag waarmee een scan wordt bijgewerkt.

PATCH  https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/289224fb-1686-472c-9751-5555960854ca

{
"scanName": "Test Update Windows scan", 
"isActive": false, 
"target": "127.0.0.2,127.0.0.3", 
"intervalInHours": 1, 
"targetType": "Ip",
"scanAuthenticationParams": { 
    "@odata.type": "#microsoft.windowsDefenderATP.api.WindowsAuthParams", 
    "type": "Kerberos", 
    "username": "username", 
    "domain": "password",
    "isGmsaUser": true
    }
 }

Antwoordvoorbeeld