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

Elemzés meghívása

  • Cikk

Az elemzési feladatok egy POST kérés analyze átirányításhoz történő elküldésével kezdeményezhetők. Az elemzés hosszú, általában egy percnél tovább tartó folyamat lehet. Az API először alapszintű ellenőrzést végez, egy feladat elküldésével kezdeményezi a kérést a háttéralkalmazásban, majd a 202-es állapotkóddal és a Location fejléccel, vagy a megfelelő hibarészletekkel válaszol. A Location fejléc értéke egy olyan URL-cím, amely a kérelem állapotának ellenőrzésére és az eredmények URL-címének megszerzésére használható. A POST-műveletek több lehetőséget kínálnak a művelet feltételek alapján történő testreszabására, például a szabályok vagy szabályrendszerek listáját, az elemzésből kizárandó fájlokat stb. Az elemzés a következő [Geographical URL]/api/analyze?api-version=1.0 használatával indítható.

Feljegyzés

Javasoljuk, hogy az állapotellenőrzések között várjon 15–60 másodpercet. Az elemzés futása általában 1–5 percig tart.
Ehhez az API-hoz jogkivonatra OAuth van szükség.

Fejlécek

Name Type Várt érték Kötelező?
Engedélyezés sztring Az OAuth 1 tulajdonosi jogkivonat azonosítóval Alkalmazásazonosító jogcím. Microsoft Entra yes
x-ms-tenant-id GUID-azonosító Az alkalmazáshoz tartozó bérlő azonosítója. igen
x-ms-correlation-id GUID Az elemzés futtatásának azonosítója. A teljes végrehajtáshoz (feltöltés, elemzés, állapot) ugyanazt az azonosítót kell megadni. igen
Elfogadás objektum application/json, application/x-ms-sarif-v2 igen
Nyelv elfogadása string A nyelvkód vagy -kódok (pl. en-US). Az alapértelmezett kód az en-US. Ha több nyelv van megadva, az első lesz az elsődleges. Az összes fordítás (ha az adott nyelv támogatott) szerepelni fog. nem

Szövegtörzs

Gyakran használt lehetőségek:

Tulajdonság Típus szerint Várt érték Kötelező?
sasUriList sztringek tömbje Azon URI-k listája, amelyek hozzáférést biztosítanak a szolgáltatás számára egyetlen megoldás, több megoldásfájlt tartalmazó zip-fájl vagy csomag letöltéséhez. Igen
ruleSets egyéni értékek tömbje 0 vagy több Nem
ruleSets.id guid A szabálykészlet azonosítója, amely a szabálykészlet API-jának lekérdezésével érhető el. Nem, de általában ezt szeretné használni. Vagy ezt, vagy a ruleCodes tulajdonságot kell használni.
ruleCodes.code string A kívánt szabály azonosítója, amely a szabálykészlet és a szabály API-jának lekérdezésével érhető el. Nem, vagy ezt, vagy a ruleSets tulajdonságot kell használni.
fileExclusions sztringek tömbje A kizárandó fájlnevek vagy fájlnévminták listája. A „*” használható helyettesítő karakterként a fájlnév elején és/vagy végén (pl. *jquery.dll és *jquery*). No

Elvárt válaszok

HTTP-állapotkód Forgatókönyv Result
202 Az elemzési kérelmet elfogadták, és az állapotellenőrzési URI-t visszaadták a Location fejlécben Nincs eredmény szövegtörzse
400 Nem zip-fájlt, helytelen paramétereket vagy vírust tartalmazó fájlt küldtek el Nincs eredmény szövegtörzse
409 Ismétlődő x-ms-correlation-id fejlécű kérést küldtek el Nincs eredmény szövegtörzse

Várt válaszok fejléce

Név szerint Típus szerint Várt érték Kötelező?
Location URI Az aktuális állapot lekérdezéséhez és az eredmények beolvasásához használandó URL-cím igen

Példa: elemzés kezdeményezése

Ez egy, az AppSource Certification szabálykészlettel, egyetlen fájllal kezdeményezett elemzési munka bemutatása; a névben a jquery és a json szövegrészt tartalmazó fájlokat kizárjuk.

Kérés

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
x-ms-tenant-id: aaaabbbb-0000-cccc-1111-dddd2222eeee

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

válasz

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/aaaa0000-bb11-2222-33cc-444444dddddd&api-version=1.0

Kapcsolódó információk

Power Apps Az ellenőrző webes API használata
A szabálykészletek listájának lekérése
A szabályok listájának lekérése
Fájl feltöltése
Ellenőrizze az elemzés állapotát