Comparteix a través de

Invocar l'anàlisi

  • Article

La iniciació d'una feina d'anàlisi es realitza enviant una sol·licitud POST a la ruta analyze. L'anàlisi pot ser un procés d'execució llarg que normalment dura més d'un minut. L'API realitza una primera validació bàsica, inicia la sol·licitud al backend mitjançant la presentació d'una feina i, a continuació, respon amb un codi d'estat 202 i una capçalera Location o amb els detalls de l'error adients. El valor de la capçalera Location és una URL que es pot utilitzar per comprovar l'estat de la sol·licitud i obtenir les adreces URL dels resultats. Hi ha diverses opcions per mitjà de l'acció POST per adaptar la feina segons els criteris que vulgueu, com ara la llista de normes o conjunts de normes, els fitxers que s'han d'excloure de l'anàlisi i altres. Podeu iniciar l'anàlisi mitjançant el següent [Geographical URL]/api/analyze?api-version=1.0.

Nota

Es recomana esperar entre 15 a 60 segons entre els controls d'estat. L'anàlisi sol tardar d'1 a 5 minuts a executar-se.
Aquesta API requereix un OAuth token.

Capçaleres

Nom Type Valor esperat És obligatori?
Autorització cadena El OAuth testimoni de portador 1 amb Microsoft Entra la reclamació d'ID d'aplicació d'identificació. sí
x-ms-tenant-id GUID Identificador de l'inquilí per a l'aplicació. sí
x-ms-correlation-id GUID L'identificador de l'execució d'anàlisi. Heu de proporcionar el mateix identificador per a tota l'execució (càrrega, anàlisi, estat). sí
Accepta objecte application/json, application/x-ms-sarif-v2 sí
Accept-Language string El codi o codis de llengua (per exemple, en-US). El valor per defecte és en-US. Si es proporcionen diverses llengües, la primera serà la principal. No obstant, totes les traduccions (si la llengua és compatible) s'inclouran. no

Cos

Opcions més habituals:

Propietat Type Valor esperat És obligatori?
sasUriList matriu de cadenes Llista d'URI que proporciona al servei accés a la baixada d'una única solució, un fitxer zip que conté diversos fitxers de solucions o un paquet. Sí
ruleSets matriu personalitzada 0 o més No
ruleSets.id guid L'identificador del conjunt de normes, que es pot trobar consultant l'API de conjunts de normes. No, però això és generalment el que voleu utilitzar. Heu d'utilitzar això o ruleCodes.
ruleCodes.code string L'identificador de la norma desitjada, que es pot trobar consultant les API de conjunts de normes i normes. No, heu d'utilitzar això o ruleSets.
fileExclusions matriu de cadenes Una llista de noms de fitxer o patrons de nom de fitxer que voleu excloure. Existeix compatibilitat amb l'ús de "*" com a caràcter comodí a l'inici i/o al final d'un nom de fitxer (per exemple, *jquery.dll i *jquery*). No

Respostes esperades

Codi d'estat HTTP Escenari Resultat
202 S'ha acceptat la sol·licitud d'anàlisi i s'ha retornat l'URI de comprovació d'estat a la capçalera Location Sense cos de resultat
400 S'ha enviat un fitxer que no és un zip, s'han inclòs paràmetres incorrectes o s'ha inclòs un fitxer amb un virus Sense cos de resultat
409 S'ha enviat una sol·licitud amb un valor de capçalera x-ms-correlation-id duplicat Sense cos de resultat

Capçaleres de resposta esperades

Nom Type Valor esperat És obligatori?
Location Uri URL per utilitzar en la consulta de l'estat actual i obtenir els resultats sí

Exemple: iniciar una anàlisi

Es tracta d'un exemple d'inici d'una feina d'anàlisi amb el conjunt de normes de Certificació AppSource, un únic fitxer i que exclou els fitxers que contenen el text jquery i json al nom.

Demanar

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

resposta

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

Consulteu també

Utilitzar l'API web del Power Apps verificador
Recuperar la llista de conjunts de regles
Recuperar la llista de regles
Penjar un fitxer
Comprovar l'estat de l'anàlisi