Analīzes izsaukšana

Raksts
10/16/2024

Analīzes uzdevuma sākšana tiek veikta, iesniedzot POST pieprasījumu analyze maršrutam. Analīzei var būt ilgs izpildes process, kas parasti ilgst ilgāk par minūti. API vispirms veic dažas pamata validācijas, uzsāk pieprasījumu uz aizmugures pamata, iesniedzot darbu, un pēc tam atbild ar statusa kodu 202 un Location galveni vai ar atbilstošu kļūdas informāciju. Location galvenes vērtība ir URL, ko var izmantot, lai pārbaudītu pieprasījuma statusu un iegūtu rezultātu URL. Ir dažādas iespējas, izmantojot POST darbību, lai pielāgotu uzdevumu, pamatojoties uz kritērijiem, piemēram, kārtulu sarakstu vai kārtulu kopām, failiem, kas jāizslēdz no analīzes, un daudz ko citu. Varat sākt analīzi, izmantojot tālāk norādītās darbības [Geographical URL]/api/analyze?api-version=1.0.

Note

Ir ieteicams starp statusa pārbaudēm nogaidīt no 15 līdz 60 sekundēm. Analīzes palaišana parasti aizņem no 1 līdz 5 minūtēm.
Šim API ir nepieciešams marķieris OAuth .

Virsraksti

Nosaukums/vārds	Tipi	Paredzētā vērtība	Vai jānorāda obligāti?
Autorizācija	string	OAuth 1 uzrādītāja marķieris ar Microsoft Entra ID lietojumprogrammas ID prasību.	jā
x-ms-tenant-id	GUID	Lietojumprogrammas nomnieka ID.	jā
x-ms-correlation-id	GUID	Analīzes izpildes identifikators. Ir jānodrošina tas pats ID visai izpildei (augšupielādēt, analizēt, statuss).	jā
Akceptēt	objekts	`application/json, application/x-ms-sarif-v2`	jā
Accept-Language	string	Valodas kods vai kodi (piem., en-US). Noklusējuma iestatījums ir en-US. Ja tiek nodrošinātas vairākas valodas, pirmā būs primārā. Taču tiks iekļauti visi tulkojumi (ja valoda tiek atbalstīta).	nē

Pamatteksts

Biežāk lietotās opcijas:

Rekvizīts	Veids	Paredzētā vērtība	Vai jānorāda obligāti?
sasUriList	virkņu masīvs	URI saraksts, kas nodrošina servisa piekļuvi, lai lejupielādētu atsevišķu risinājumu, zip failu, kurā ir vairāki risinājuma faili, vai pakotni.	Jā
ruleSets	pasūtījuma masīvs	0 vai vairāk	Nē
ruleSets.id	guid	Kārtulu kopas ID, ko var atrast, veicot vaicājumu kārtulu kopas API.	Nē, bet tas parasti ir tas, ko jūs vēlētos izmantot. Jums ir jāizmanto šī vai ruleCodes.
ruleCodes.code	string	Vēlamās kārtulas ID, ko var atrast, veicot vaicājumu kārtulu kopai un kārtulas API.	Nē, jums ir jāizmanto šī vai ruleSets.
fileExclusions	virkņu masīvs	To failu nosaukumu vai failu nosaukumu saraksts, kas ir jāizslēdz. Pastāv atbalsts, lai izmantotu "" kā aizstājējzīmi faila nosaukuma sākumā un/vai beigās (piemēram, jquery.dll un jquery).	Nē.

Paredzamās atbildes

HTTP statusa kods	Situācija	Rezultāts
202	Analīzes pieprasījums tika akceptēts, un `Location` galvenē tika atgriezts statusa pārbaudes URI	Nav rezultāta pamatteksta
400	Tika nosūtīts fails, kas nav zip fails, nepareizie parametri vai fails tika iekļauts kopā ar vīrusu	Nav rezultāta pamatteksta
409	Pieprasījums ar `x-ms-correlation-id` galvenes vērtības dublikātu tika nosūtīts	Nav rezultāta pamatteksta

Paredzētās atbildes galvenes

Nosaukums/vārds, uzvārds	Veids	Paredzētā vērtība	Vai jānorāda obligāti?
Atrašanās vieta	URI	URL var izmantot, lai vaicātu par pašreizējo statusu un iegūtu rezultātus	jā

Piemērs: sākt analīzi

Šis ir piemērs, kā sākt analīzes uzdevumu, izmantojot AppSource sertificēšanas kārtulu kopu, atsevišķu failu un neiekļaujot failus, kuros ir teksts jquery un json nosaukumā.

Lūgums

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

atbilde

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

Skatiet arī

Pārbaudītāja Power Apps tīmekļa API izmantošana
Kārtulu kopu saraksta izgūšana
Izgūt kārtulu sarakstu
Faila augšupielāde
Analīzes statusa pārbaude

Kopīgot, izmantojot