Přidání, aktualizace nebo odstranění definice kontroly

Článek
08/14/2024

Platí pro:

Chcete vyzkoušet Defender pro Endpoint? Zaregistrujte se a získejte bezplatnou zkušební verzi,

Chcete si prožít správu ohrožení zabezpečení v programu Microsoft Defender? Přečtěte si další informace o tom, jak se můžete zaregistrovat ke zkušební verzi Public Preview správy ohrožení zabezpečení v programu Microsoft Defender.

Důležité

Některé informace v tomto článku se týkají předvydaného produktu, který může být před komerčním vydáním podstatně změněn. Společnost Microsoft neposkytuje na zde uvedené informace žádné záruky, vyjádřené ani předpokládané.

Poznámka

Pokud jste zákazníkem státní správy USA, použijte identifikátory URI uvedené v programu Microsoft Defender for Endpoint pro zákazníky státní správy USA.

Tip

Pro lepší výkon můžete použít server blíže k vašemu geografickému umístění:

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

Popis rozhraní API

Rozhraní API pro přidání, aktualizaci nebo odstranění ověřené kontroly

Omezení

Omezení rychlosti pro toto rozhraní API jsou 100 volání za minutu a 1 500 volání za hodinu.

Podle nakonfigurované doby uchovávání můžete publikovat na počítačích, které byly naposledy zobrazeny.

Oprávnění

K volání tohoto rozhraní API se vyžaduje jedno z následujících oprávnění. Další informace, včetně postupu výběru oprávnění, najdete v tématu Použití rozhraní DEFENDER for Endpoint API.

Typ oprávnění	Povolení	Zobrazovaný název oprávnění
Application	Machine.ReadWrite.All	Čtení a zápis všech informací o kontrole
Delegovaný (pracovní nebo školní účet)	Machine.Read.Write	Čtení a zápis všech informací o kontrole

Poznámka

Při získávání tokenu pomocí přihlašovacích údajů uživatele:

K zobrazení dat musí mít uživatel alespoň následující oprávnění role: ViewData nebo TvmViewData (další informace najdete v tématu Vytváření a správa rolí ).
Aby uživatel mohl upravovat data, musí mít alespoň následující oprávnění role: ManageSecurity (Další informace najdete v tématu Vytváření a správa rolí ).

Požadavek HTTP

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

Hlavičky požadavků

Name (Název)	Typ	Popis
Oprávnění	String	Nosný {token}. Povinné.
Typ obsahu	řetězec	application/json. Povinné.

Text požadavku

V textu požadavku zadejte objekt JSON s následujícími parametry:

Parametr	Typ	Popis
scanType	Výčet	Typ kontroly. Možné hodnoty jsou: "Windows", "Network". Povinné.
scanName	String	Název kontroly. Povinné.
isActive	Boolean	Stav aktivního spuštění kontroly Povinné.
cíl	String	Čárkami oddělený seznam cílů, které se mají zkontrolovat, a to buď IP adresy, nebo názvy hostitelů. Povinné.
intervalInHours	Int	Interval, ve kterém se kontrola spustí. Povinné.
targetType	String	Typ cíle v cílovém poli. Možné typy jsou IP adresa nebo název hostitele. Výchozí hodnota je IP adresa. Povinné.
scannerAgent	Objekt	ID počítače. Povinné.
scanAuthenticationParams	Objekt	Objekt představující parametry ověřování, viz Vlastnosti objektu parametrů ověřování pro očekávaná pole. Tato vlastnost je povinná při vytváření nové kontroly a je volitelná při aktualizaci kontroly.

Odpověď

V případě úspěchu vrátí tato metoda kód odpovědi 200 – Ok a novou nebo aktualizovanou definici kontroly v těle odpovědi.

Příklad požadavku na přidání nové kontroly

Tady je příklad požadavku, který přidá novou kontrolu.

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

Příklad odpovědi

Tady je příklad odpovědi.

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

}

Příklad požadavku na aktualizaci kontroly

Tady je příklad požadavku, který aktualizuje kontrolu.

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

Příklad odpovědi

Tady je příklad odpovědi.

{
    "@odata.context": "https://localhost:1059/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
    "id": "289224fb-1686-472c-9751-5555960854ca",
    "scanType": "Windows",
    "scanName": "Test Update Windows scan",
    "isActive": false,
    "target": "127.0.0.2,127.0.0.3",
    "orgId": "0335a792-18d2-424b-aeed-559567054570",
    "intervalInHours": 1,
    "createdBy": "userName@microsoft.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
    }
}

Příklad žádosti o odstranění kontrol

Tady je příklad požadavku, který odstraní kontroly.

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

{
  "ScanDefinitionIds": ["td32f17af-5cc2-4e4e-964a-4c4ef7d216e2", "ab32g20af-5dd2-4a5e-954a-4c4ef7d216e2"],
}

Tip

Chcete se dozvědět více? Spojte se s komunitou zabezpečení Microsoftu v naší technické komunitě: Technická komunita Microsoft Defenderu for Endpoint.

Sdílet prostřednictvím

Přidání, aktualizace nebo odstranění definice kontroly

Popis rozhraní API

Omezení

Oprávnění

Požadavek HTTP

Hlavičky požadavků

Text požadavku

Odpověď

Příklad požadavku na přidání nové kontroly

Příklad odpovědi

Příklad požadavku na aktualizaci kontroly

Příklad odpovědi

Příklad žádosti o odstranění kontrol

Váš názor

Další materiály