Hinzufügen, Aktualisieren oder Löschen einer Scandefinition

Artikel
08/14/2024

Gilt für:

Möchten Sie Microsoft Defender für Endpunkt ausprobieren? Registrieren Sie sich für eine kostenlose Testversion.

Möchten Sie Microsoft Defender-Sicherheitsrisikomanagement erleben? Erfahren Sie mehr darüber, wie Sie sich für die öffentliche Vorschauversion von Microsoft Defender Vulnerability Management registrieren können.

Wichtig

Einige Informationen in diesem Artikel beziehen sich auf ein vorab veröffentlichtes Produkt, das vor der kommerziellen Veröffentlichung möglicherweise erheblich geändert wird. Microsoft übernimmt in Bezug auf die hier bereitgestellten Informationen keine Gewährleistung, weder ausdrücklich noch konkludent.

Hinweis

Wenn Sie ein US Government-Kunde sind, verwenden Sie die URIs, die unter Microsoft Defender für Endpunkt für US Government-Kunden aufgeführt sind.

Tipp

Um die Leistung zu verbessern, können Sie den Server näher an Ihrem geografischen Standort verwenden:

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-Beschreibung

API zum Hinzufügen, Aktualisieren oder Löschen einer authentifizierten Überprüfung.

Begrenzungen

Die Ratenbeschränkungen für diese API sind 100 Aufrufe pro Minute und 1.500 Aufrufe pro Stunde.

Sie können Beiträge auf Computern bereitstellen, die zuletzt gemäß Ihrem konfigurierten Aufbewahrungszeitraum angezeigt wurden.

Berechtigungen

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, einschließlich der Auswahl von Berechtigungen, finden Sie unter Verwenden von Defender für Endpunkt-APIs.

Berechtigungstyp	Berechtigung	Anzeigename der Berechtigung
App	Machine.ReadWrite.All	Lesen und Schreiben aller Scaninformationen.
Delegiert (Geschäfts-, Schul- oder Unikonto)	Machine.Read.Write	Lesen und Schreiben aller Scaninformationen.

Hinweis

Beim Abrufen eines Tokens mit Benutzeranmeldeinformationen:

Zum Anzeigen von Daten benötigt der Benutzer mindestens die folgende Rollenberechtigung: ViewData oder TvmViewData (weitere Informationen finden Sie unter Erstellen und Verwalten von Rollen ).
Zum Bearbeiten von Daten benötigt der Benutzer mindestens die folgende Rollenberechtigung: ManageSecurity (Weitere Informationen finden Sie unter Erstellen und Verwalten von Rollen ).

HTTP-Anforderung

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

Anforderungsheader

Name	Typ	Beschreibung
Authorization	Zeichenfolge	Bearer {token}. Erforderlich.
Content-Type	string	application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an:

Parameter	Typ	Beschreibung
scanType	Enum	Der Typ der Überprüfung. Mögliche Werte: "Windows", "Network". Erforderlich.
scanName	Zeichenfolge	Name der Überprüfung. Erforderlich.
isActive	Boolesch	Status, ob die Überprüfung aktiv ausgeführt wird. Erforderlich.
target	Zeichenfolge	Eine durch Trennzeichen getrennte Liste der zu überprüfenden Ziele, entweder IP-Adressen oder Hostnamen. Erforderlich.
intervalInHours	Int	Das Intervall, in dem die Überprüfung ausgeführt wird. Erforderlich.
targetType	Zeichenfolge	Der Zieltyp im Zielfeld. Mögliche Typen sind "IP-Adresse" oder "Hostname". Der Standardwert ist IP-Adresse. Erforderlich.
scannerAgent	Objekt	Computer-ID. Erforderlich.
scanAuthenticationParams	Objekt	Ein Objekt, das die Authentifizierungsparameter darstellt, finden Sie unter Eigenschaften des Authentifizierungsparameterobjekts für erwartete Felder. Diese Eigenschaft ist beim Erstellen einer neuen Überprüfung obligatorisch und beim Aktualisieren einer Überprüfung optional.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den Antwortcode 200 – Ok und die neue oder aktualisierte Scandefinition im Antworttext zurück.

Beispielanforderung zum Hinzufügen einer neuen Überprüfung

Hier sehen Sie ein Beispiel für eine Anforderung, die eine neue Überprüfung hinzufügt.

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
    }
}

Beispielantwort

Hier ist ein Beispiel für die Antwort.

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

}

Beispielanforderung zum Aktualisieren einer Überprüfung

Hier sehen Sie ein Beispiel für eine Anforderung, die eine Überprüfung aktualisiert.

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
    }
 }

Anforderungsbeispiel