Megosztás a következőn keresztül:


Vizsgálati definíció hozzáadása, frissítése vagy törlése

Érintett szolgáltatás:

Szeretné megismerni a Végponthoz készült Microsoft Defendert? Regisztráció az ingyenes próbaverzióra

Szeretne Microsoft Defender biztonságirés-kezelés tapasztalni? További információ arról, hogyan regisztrálhat a Microsoft Defender biztonságirés-kezelés nyilvános előzetes verziójára.

Fontos

A cikkben található információk egy része egy előzetesen kiadott termékre vonatkozik, amely a kereskedelmi forgalomba kerülés előtt lényegesen módosulhat. A Microsoft nem vállal kifejezett vagy hallgatólagos szavatosságot az itt megadott információkra vonatkozóan.

Megjegyzés:

Ha Ön az USA kormányzati szerveinek ügyfele, használja a Végponthoz készült Microsoft Defender-ben felsorolt URI-kat az USA kormányzati ügyfelei számára.

Tipp

A jobb teljesítmény érdekében a földrajzi helyhez közelebbi kiszolgálót használhat:

  • 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

API-leírás

API hitelesített vizsgálat hozzáadásához, frissítéséhez vagy törléséhez.

Korlátozások

Az API sebességkorlátozásai percenként 100 hívás, óránként 1500 hívás.

A gépeken a konfigurált megőrzési időszaknak megfelelően közzéteheti a bejegyzést.

Engedélyek

Az API meghívásához az alábbi engedélyek egyikére van szükség. További információ, beleértve az engedélyek kiválasztását is: Végponthoz készült Defender API-k használata.

Engedély típusa Engedély Engedély megjelenítendő neve
Alkalmazás Machine.ReadWrite.All Olvassa el és írja meg az összes vizsgálati információt.
Delegált (munkahelyi vagy iskolai fiók) Machine.Read.Write Olvassa el és írja meg az összes vizsgálati információt.

Megjegyzés:

Jogkivonat felhasználói hitelesítő adatokkal történő beszerzésekor:

  • Az adatok megtekintéséhez a felhasználónak legalább a következő szerepköri engedéllyel kell rendelkeznie: ViewData vagy TvmViewData (További információt a szerepkörök Létrehozás és kezelése című témakörben talál)
  • Az adatok szerkesztéséhez a felhasználónak legalább a következő szerepköri engedéllyel kell rendelkeznie: ManageSecurity (További információt a szerepkörök Létrehozás és kezelése című témakörben talál.

HTTP-kérés

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

Kérelemfejlécek

Name (Név) Típus Leírás
Engedélyezési Karakterlánc Tulajdonos : {token}. Kötelező megadni.
Tartalomtípus Karakterlánc application/json. Kötelező megadni.

Kérelem törzse

A kérelem törzsében adjon meg egy JSON-objektumot a következő paraméterekkel:

Paraméter Típus Leírás
scanType Enum A vizsgálat típusa. A lehetséges értékek a következők: "Windows", "Network". Kötelező megadni.
scanName Karakterlánc A vizsgálat neve. Kötelező megadni.
isActive Logikai Annak állapota, hogy a vizsgálat aktívan fut-e. Kötelező megadni.
Cél Karakterlánc A vizsgálandó célok vesszővel tagolt listája, IP-címek vagy állomásnevek alapján. Kötelező megadni.
intervalInHours Int A vizsgálat futtatásának időköze. Kötelező megadni.
targetType Karakterlánc A cél típusa a célmezőben. Lehetséges típusok: "IP-cím" vagy "Állomásnév". Az alapértelmezett érték az IP-cím. Kötelező megadni.
scannerAgent Objektum gépazonosító. Kötelező.
scanAuthenticationParams Objektum A hitelesítési paramétereket képviselő objektum, lásd: Hitelesítési paraméterek objektumtulajdonságai a várt mezőkhöz. Ez a tulajdonság új vizsgálat létrehozásakor kötelező, és nem kötelező a vizsgálat frissítésekor.

Válasz

Ha sikerült, ez a metódus a 200 – OK válaszkódot és az új vagy frissített vizsgálati definíciót adja vissza a válasz törzsében.

Új vizsgálat hozzáadására vonatkozó példakérés

Íme egy példa egy kérésre, amely új vizsgálatot ad hozzá.

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éldaválasz

Íme egy példa a válaszra.

 {
"@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élda kérés egy vizsgálat frissítésére

Íme egy példa egy kérésre, amely frissíti a vizsgálatot.

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élda válaszra

Íme egy példa a válaszra.

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

Vizsgálat törlésére irányuló példakérés

Íme egy példa egy kérésre, amely törli a vizsgálatokat.

POST https://api.securitycenter.microsoft.com/api/DeviceAuthenticatedScanDefinitions/BatchDelete
{
  "ScanDefinitionIds": ["td32f17af-5cc2-4e4e-964a-4c4ef7d216e2", "ab32g20af-5dd2-4a5e-954a-4c4ef7d216e2"],
}

Tipp

Szeretne többet megtudni? Engage a Microsoft biztonsági közösségével a technikai közösségünkben: Végponthoz készült Microsoft Defender Tech Community.