Priklic analize

Zagon posla analize izvedete tako, da pošljete zahtevo POST poti analyze. Analiza je lahko dolgotrajen postopek, ki običajno traja dlje kot minuto. API najprej opravi osnovno preverjanje, sproži zahtevo v zaledju tako, da pošlje posel, in nato odgovori s kodo stanja 202 in glavo Location ali z ustreznimi podrobnostmi o napaki. Vrednost glave Location je URL, s katerim lahko preverite stanje zahteve in pridobite URL-je rezultatov. Obstajajo različne možnosti prek dejanja POST za prilagajanje posla na podlagi vaših meril, kot je seznam pravil ali naborov pravil, datotek, ki jih želite izključiti iz analize, in drugega. Analiza lahko zaženete z uporabo [Geographical URL]/api/analyze?api-version=1.0.

opomba,

Med preverjanji stanja je priporočljivo počakati od 15 do 60 sekund. Analiza običajno traja od 1 do 5 minut.
Ta API zahteva žeton. OAuth

Glave

Imenu	Tip	Pričakovana vrednost	Obvezno?
Avtorizacija	niz	Nosilni žeton OAuth 1 z zahtevkom Microsoft Entra ID Application ID.	da
x-ms-tenant-id	GUID	ID najemnika za aplikacijo.	da
x-ms-correlation-id	GUID	Identifikator za zagon analize. Za celotno izvedbo (nalaganje, analiza, stanje) morate navesti enak ID.	da
Sprejmi	predmet	application/json, application/x-ms-sarif-v2	da
Sprejmi jezik	niz	Jezikovna koda ali kode (npr. en-US). Privzeta nastavitev je en-US. Če je na voljo več jezikov, bo prvi jezik glavni. Kljub temu bodo vključeni vsi prevodi (če je jezik podprt).	ne

Telo

Pogosto uporabljene možnosti:

Lastnost	Tip	Pričakovana vrednost	Obvezno?
sasUriList	polje nizov	Seznam URI-jev, ki omogoča dostop do storitve za prenos posamezne rešitve, datoteka zip, ki vsebuje več datotek z rešitvami, ali paket.	Da
ruleSets	polje po meri	0 ali več	Ne
ruleSets.id	Guid	ID nabora pravil, ki ga lahko najdete s poizvedbo po API-ju nabora pravil.	Ne, vendar je to običajno tisto, kar bi bilo dobro uporabiti. Uporabiti morate bodisi to bodisi ruleCodes.
ruleCodes.code	niz	ID želenega pravila, ki ga lahko najdete s poizvedbo po naboru pravil in API-jih pravila.	Ne, uporabiti morate bodisi to bodisi ruleSets.
fileExclusions	polje nizov	Seznam imen datotek ali vzorcev imen datotek, ki jih želite izključiti. Obstaja podpora za uporabo »*« kot nadomestnega znaka na začetku in/ali koncu imena datoteke (npr. *jquery.dll in *jquery*).	Ne

Pričakovani odzivi

Koda stanja HTTP	Scenarij	Rezultat
202	Zahteva za analizo je bila sprejeta, URI preverjanja stanja pa je bil vrnjen v glavo Location	Ni telesa rezultata
400	Poslana je bila datoteka, ki ni v obliki zip, napačni parametri ali pa je bila vključena datoteka z virusom	Ni telesa rezultata
409	Zahteva s podvojeno vrednostjo glave x-ms-correlation-id je bila poslana	Ni telesa rezultata

Pričakovani glave odzivov

Imenu	Tip	Pričakovana vrednost	Obvezno?
Lokacija	URI	URL za uporabo pri poizvedovanju o trenutnem stanju in pridobivanje rezultatov	da

Primer: zagon analize

To je primer začetka analitične naloge z naborom pravil Marketplace Certification , eno samo datoteko, in izključevanje datotek, ki vsebujejo besedilo jquery in json v imenu.

Zahteva

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*"]
}

Odziv

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

Glejte tudi

Uporabite spletni API Power Apps checker
Pridobi seznam naborov pravil
Pridobi seznam pravil
Naloži datoteko
Preveri stanje analize