Felhőhöz készült Defender Apps REST API

Cikk
01/23/2024

Ez a cikk azt ismerteti, hogyan használhatja az Felhőhöz készült Defender-alkalmazásokat HTTPS-en keresztül.

A Felhőhöz készült Microsoft Defender Apps API programozott hozzáférést biztosít Felhőhöz készült Defender Alkalmazásokhoz REST API-végpontokon keresztül. Az alkalmazások az API-val olvasási és frissítési műveleteket hajthatnak végre Felhőhöz készült Defender Apps-adatokon és -objektumokon. A Felhőhöz készült Defender Apps API például a következő gyakori műveleteket támogatja egy felhasználói objektum esetében:

Naplófájlok feltöltése a Cloud Discoveryhez
Blokkszkriptek létrehozása
Tevékenységek és riasztások listázása
Riasztások elvetése vagy feloldása

API URL-struktúrája

A Felhőhöz készült Defender Apps API használatához először be kell szereznie az API URL-címét a bérlőtől. Az API URL-címe a következő formátumot használja: https://<portal_url>/api/<endpoint>.

A bérlőhöz tartozó Felhőhöz készült Defender Apps API URL-címének beszerzéséhez hajtsa végre a következő lépéseket:

A Microsoft Defender portálon válassza a Gépház. Ezután válassza a Cloud Apps lehetőséget. A Rendszer területen válassza a Névjegy lehetőséget.
A képernyőről Felhőhöz készült Defender alkalmazásokban megjelenik az API URL-címe.

Ha már rendelkezik az API URL-címével, adja hozzá az /api utótagot az API URL-címének beszerzéséhez. Ha például a portál URL-címe, https://mytenant.us2.contoso.comakkor az API URL-címe.https://mytenant.us2.portal.cloudappsecurity.com/api

API-tokenek

Felhőhöz készült Defender Alkalmazásokhoz api-jogkivonatra van szükség a kiszolgálónak küldött összes API-kérés fejlécében, például a következőket:

Authorization: Token <your_token_key>

Hol <your_token_key> található a személyes API-jogkivonat.

Az API-jogkivonatokról további információt az API-jogkivonatok kezelése című témakörben talál.

API-jogkivonatok – példa

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"

Mely műveletek támogatottak?

Az alábbi táblázat a támogatott műveleteket ismerteti:

Erőforrás	HTTP-parancsok	URI-útvonalak
Tevékenységek	GET vagy POST metódus	/api/v1/activities/
Riasztások	GET vagy POST metódus	/api/v1/alerts/
Adatdúsítás	GET, POST vagy DELETE	/api/alhálózat/
Entitások	GET vagy POST metódus	/api/v1/entities/
Fájlok	GET vagy POST metódus	/api/v1/files/

Ahol az erőforrás a kapcsolódó entitások csoportját jelöli.

Milyen mezőtípusok támogatottak?

Az alábbi táblázat a támogatott mezőtípusokat ismerteti:

Mező	Leírás
húr	Szöveges sztring
Logikai	Igaz/hamis értéket képviselő logikai érték
egész szám	32 bites aláírt egész szám
időbélyeg	Ezredmásodperc a korszak óta

Időbélyegek

Az Felhőhöz készült Defender Apps API időbélyegeinek említései a Unix időbélyegre hivatkoznak ezredmásodpercben. Ezt az időbélyeget az ezredmásodpercek száma határozza meg 1970-01-01 0:00:00 óta. A get-date PowerShell-parancsmaggal időbélyegekké alakíthatja a dátumokat.

Korlátozások

A kérések korlátozásához megadhat egy korlátparamétert a kérelemben.

A korlátparaméter megadásához a következő módszerek támogatottak:

URL-kódolt (fejléccel Content-Type: application/x-www-form-urlencoded )
Űrlapadatok
JSON-törzs (és Content-Type: multipart/form-data egy megfelelő határfejléc)

Feljegyzés

Ha nincs megadva korlát, a rendszer 100-ra állítja be az alapértelmezett értéket.
Az API-jogkivonattal küldött összes kérésre adott válaszok legfeljebb 100 elemre korlátozódnak.
Az összes API-kérés szabályozási korlátja bérlőnként percenként 30 kérés.

Szűrők

Ha sok találatot kap, hasznosnak fogja találni a kérések szűrőkkel történő finomhangolását. Ez a szakasz a szűrők szerkezetét és a szűrőkkel használható operátorokat ismerteti.

Struktúra

Egyes API-végpontok támogatják a szűrőket a lekérdezések végrehajtásakor. A vonatkozó szakaszokban talál egy hivatkozást, amely felsorolja az erőforrás összes elérhető szűrhető mezőjét és támogatott operátorát.

A legtöbb szűrő több értéket támogat, hogy hatékony lekérdezéseket biztosítson. Szűrők és operátorok kombinálásakor az AND függvényt használjuk logikai operátorként a szűrők között.

Szűrők – példa

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint" -d '{
  "filters": {
    "some.field": {
      "eq": ["value1", "value2"],
      "isset": true
    },
    "some.field2": {
      "gte": 5
    }
  },
  "skip": 5,
  "limit": 10
}'

Operátorok