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

Alkalmazandó: Microsoft Defender for Endpoint, Microsoft Defender Vulnerability Management

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.

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

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ó: Szerepkörök létrehozása és kezelése
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ó: Szerepkörök létrehozása és kezelése

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.

HTTP-kérés

POST https://api.security.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	sztring	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. Lehetséges érték: "Hálózat". 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.
`target`	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.security.microsoft.com/api/DeviceAuthenticatedScanDefinitions

 {
"scanType": "Network",
"scanName": "Test Network scan",
"isActive": true,
"target": "127.0.0.1",
"intervalInHours": 1,
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77"
},
"scanAuthenticationParams": {
    "@odata.type": "#microsoft.windowsDefenderATP.api.SnmpAuthParams",
    "type": "AuthPriv",
    "username": "username",
    "authProtocol": "authProtocol",
    "authPassword": "authPassword",
    "privProtocol": "privProtocol",
    "privPassword": "privPassword",
    "communityString": "community-string"
    }
}

Példaválasz

Íme egy példa a válaszra.

 {
  "@odata.context": "https://api.security.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity",
  "id": "d14cefe1-0301-488c-ad17-a86c428c3727",
  "scanType": "Network",
  "scanName": "Test Network 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": "2025-12-18T14:04:34.2258259Z",
    "assignedApplicationId": "f23c76e1-a6b5-4f77-9468-3a57916c910e",
    "scannerSoftwareVersion": "9.3.15.19",
    "lastCommandExecutionTimestamp": "2025-12-18T13:29:48Z",
    "mdeClientVersion": null
  },
  "latestScan": {
    "status": null,
    "failureReason": null,
    "executionDateTime": null
  },
  "advancedActiveConfiguration": 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.security.microsoft.com/api/DeviceAuthenticatedScanDefinitions/289224fb-1686-472c-9751-5555960854ca

{
"scanType": "Network",
"scanName": "Test Network scan",
"isActive": true,
"target": "127.0.0.1,127.0.0.2",
"intervalInHours": 1,
"targetType": "Ip",
"scannerAgent": {
    "machineId": "eb663a27ae9d032f61bc268a79eedf14c4b90f77"
},
"scanAuthenticationParams": {
    "@odata.type": "#microsoft.windowsDefenderATP.api.SnmpAuthParams",
    "type": "AuthPriv",
    "username": "username",
    "authProtocol": "authProtocol",
    "authPassword": "authPassword",
    "privProtocol": "privProtocol",
    "privPassword": "privPassword",
    "communityString": "community-string"
    }
}

Példa válaszra

Íme egy példa a válaszra.

{
  "@odata.context": "https://api.security.microsoft.com/api/$metadata#DeviceAuthenticatedScanDefinitions/$entity%22",
  "id": "d14cefe1-0301-488c-ad17-a86c428c3727",
  "scanType": "Network",
  "scanName": "Test Network scan",
  "isActive": true,
  "target": "127.0.0.1,127.0.0.2",
  "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": "2025-12-18T14:34:39.3296383Z",
    "assignedApplicationId": "f23c76e1-a6b5-4f77-9468-3a57916c910e",
    "scannerSoftwareVersion": "9.3.15.19",
    "lastCommandExecutionTimestamp": "2025-12-18T14:33:48Z",
    "mdeClientVersion": null
  },
  "latestScan": {
    "status": "Fail",
    "failureReason": null,
    "executionDateTime": "2025-12-18T14:33:49.413596Z"
  },
  "advancedActiveConfiguration": 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.security.microsoft.com/api/DeviceAuthenticatedScanDefinitions/BatchDelete

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

Visszacsatolás

Hasznos volt ez az oldal?

Last updated on 2025-12-19