DEFENDER FOR CLOUD APPS REST API
Ez a cikk a Defender for Cloud Apps HTTPS-en keresztüli használatát ismerteti.
A Microsoft Defender for Cloud Apps API programozott hozzáférést biztosít a Defender for Cloud Apps REST API-végpontokon keresztül. Az alkalmazások az API-val olvasási és frissítési műveleteket hajthatnak végre Defender for Cloud Apps adatokon és objektumokon. A Defender for Cloud 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 felhőfelderítéshez
- Blokkszkriptek létrehozása
- Tevékenységek és riasztások listázása
- Riasztások elvetése vagy megoldása
API URL-struktúrája
A Defender for Cloud 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ő Defender for Cloud Apps API URL-címének beszerzéséhez hajtsa végre az alábbi lépéseket:
A Microsoft Defender Portálon válassza a Beállítások lehetőséget. 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 Defender for Cloud Apps az API URL-címe látható.
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.com
, akkor az API URL-címe https://mytenant.us2.portal.cloudappsecurity.com/api
.
API-jogkivonatok
Defender for Cloud Apps egy API-jogkivonatot igényel 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.
További információ az API-jogkivonatokról: Api-jogkivonatok kezelése.
API-jogkivonatok – példa
curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"
Milyen műveletek támogatottak?
Az alábbi táblázat a támogatott műveleteket ismerteti:
Erőforrás | HTTP-műveletek | URI-útvonalak |
---|---|---|
Tevékenységek | GET vagy POST | /api/v1/activities/ |
Riasztások | GET vagy POST | /api/v1/alerts/ |
Adatdúsítás | GET, POST vagy DELETE | /api/alhálózat/ |
Entitások | GET vagy POST | /api/v1/entities/ |
Fájlok | GET vagy POST | /api/v1/files/ |
Ahol az Erőforrás a kapcsolódó entitások egy 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 |
---|---|
sztring | Szöveges sztring |
Logikai | Igaz/hamis értéket jelölő logikai érték |
egész szám | 32 bites aláírt egész szám |
Időbélyeg | Ezredmásodperc az alapidőszak óta |
Időbélyegek
Az Defender for Cloud Apps API időbélyegeinek említései a Unix időbélyegre utalnak 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.
Határok
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ódolás (fejléccel
Content-Type: application/x-www-form-urlencoded
) - Űrlapadatok
- JSON-törzs (és
Content-Type: multipart/form-data
egy megfelelő határfejléc)
Megjegyzé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 30 kérés percenként.
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 az azokkal használható operátorokat ismerteti.
Szerkezet
Egyes API-végpontok támogatják a szűrőket lekérdezések végrehajtásakor. A megfelelő szakaszokban talál egy hivatkozást, amely felsorolja az erőforráshoz elérhető összes elérhető szűrhető mezőt és támogatott operátort.
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
}'
Piaci szereplők
Megjegyzés:
Nem minden operátor kompatibilis az összes szűrővel.
Az alábbi táblázat a támogatott operátorokat ismerteti:
Operátor | Válasz típusa | Leírás |
---|---|---|
Tartalmaz | sztringek listája | A megadott sztringek egyikét tartalmazó összes releváns rekordot visszaadja |
deq | értékek listája | Az összes olyan rekordot visszaadja, amely egy olyan értéket tartalmaz, amely nem egyenlő a megadott értékekkel |
descendantof | értékek listája | Az értékeknek vagy leszármazottaiknak megfelelő összes rekordot visszaadja |
doesnotstartwith | sztringek listája | Az összes olyan releváns rekordot adja vissza, amely nem a megadott sztringekkel kezdődik |
vége: | sztringek listája | A megadott sztringek egyikével végződő összes releváns rekordot visszaadja |
Eq | értékek listája | A megadott értékek egyikét tartalmazó összes releváns rekordot visszaadja |
Gt | egyetlen érték | Az összes olyan rekordot visszaadja, amelynek értéke nagyobb a megadott értéknél |
Gte | egyetlen érték | Az összes olyan rekordot visszaadja, amelynek értéke nagyobb vagy egyenlő a megadott értékkel |
gte_ndays | szám | Az N napnál későbbi dátumú összes rekordot visszaadja |
isotset | Logikai | Ha "true" (igaz) értékre van állítva, a visszaadja az összes olyan releváns rekordot, amely nem tartalmaz értéket a megadott mezőben |
isset | Logikai | Ha "true" (igaz) értékre van állítva, a a megadott mezőben értékkel rendelkező összes releváns rekordot visszaadja. |
lt | egyetlen érték | Az összes olyan rekordot visszaadja, amelynek értéke kisebb a megadott értéknél |
lte | egyetlen érték | Az összes olyan rekordot visszaadja, amelynek értéke kisebb vagy egyenlő a megadott értékkel |
lte_ndays | szám | Az N napnál korábbi dátumú összes rekordot visszaadja |
ncontains | sztringek listája | Az összes olyan releváns rekordot adja vissza, amely nem tartalmazza a megadott sztringek egyikét |
ndescendantof | értékek listája | Az összes olyan rekordot visszaadja, amely nem egyezik meg az értékekkel vagy azok leszármazottaival |
neq | értékek listája | Az összes olyan releváns rekordot adja vissza, amely nem tartalmazza az összes megadott értéket |
tartomány | "start" és "end" mezőket tartalmazó objektumok listája | A megadott tartományokon belüli összes rekordot adja vissza |
startswith | sztringek listája | A megadott sztringek egyikével kezdődő összes releváns rekordot visszaadja |
startswithsingle | sztring | A megadott sztringgel kezdődő összes releváns rekordot visszaadja |
SMS | sztring | Teljes szöveges keresést végez az összes rekordban |
Következő lépések
Ha bármilyen problémába ütközik, segítünk. Ha segítséget vagy támogatást szeretne kapni a termék problémájához, nyisson egy támogatási jegyet.