Condividi tramite

Richiamare l'analisi

L'avvio di un processo di analisi viene eseguito inviando una richiesta POST alla route analyze. L'analisi può essere un processo di lunga durata che di solito dura più di un minuto. L'API esegue prima una convalida di base, avvia la richiesta sul back-end inviando un processo, quindi risponde con un codice di stato di 202 e un'intestazione Location o con i dettagli dell'errore appropriati. Il valore del'intestazione Location è un URL che può essere utilizzato per verificare lo stato della richiesta e ottenere gli URL dei risultati. Ci sono varie opzioni dell'azione POST per personalizzare il processo in base ai propri criteri, come l'elenco di regole o set di regole, i file da escludere dall'analisi e altro ancora. Puoi avviare l'analisi utilizzando il seguente [Geographical URL]/api/analyze?api-version=1.0.

Nota

Ti consigliamo di attendere da 15 a 60 secondi tra i controlli di stato. L'analisi richiede in genere da 1 a 5 minuti per l'esecuzione.
Questa API richiede un token OAuth.

Intestazioni

Name Tipo Valore previsto Obbligatorio?
Autorizzazione string Token portatore OAuth 1 con Microsoft Entra ID con attestazione dell'ID dell'applicazione. sì
x-ms-tenant-id GUID (Identificatore Unico Globale) L'ID del tenant dell'applicazione. sì
x-ms-correlation-id GUID (Identificatore Unico Globale) L'identificatore per l'esecuzione dell'analisi. Devi fornire lo stesso ID per l'intera esecuzione (caricamento, analisi, stato). sì
Accetta oggetto application/json, application/x-ms-sarif-v2 sì
Accept-Language string Il codice o i codici della lingua (ad esempio, en-US). L'area predefinita è en-US. Se vengono fornite più lingue, la prima sarà la principale. Tuttavia, saranno incluse tutte le traduzioni (se la lingua è supportata). no

Corpo

Opzioni comunemente usate:

Proprietà Tipo Valore previsto Obbligatorio?
sasUriList matrice di stringhe Un elenco di URI che forniscono l'accesso al servizio per scaricare una singola soluzione, un file zip contenente più file di soluzione o un pacchetto. Sì
insiemi di regole matrice personalizzata di 0 o più No
ruleSets.id GUID L'ID del set di regole, che può essere trovato eseguendo una query sull'API del set di regole. No, ma di solito è quello che vorresti usare. È necessario utilizzare questo elemento o ruleCodes.
ruleCodes.code string L'ID della regola desiderata, che può essere trovato eseguendo una query sul set di regole e sull'API delle regole. No, è necessario utilizzare questo oppure ruleSets.
fileExclusions matrice di stringhe Elenco di nomi di file o modelli di nomi di file da escludere. Esiste il supporto per l'utilizzo di "*" come carattere jolly all'inizio e/o alla fine del nome di un file (ad esempio, *jquery.dll e *jquery*). No

Risposte previste

Codice di stato HTTP Scenario Risultato
202 La richiesta di analisi è stata accettata e l'URI di controllo dello stato è stato restituito nell'intestazione Location Nessun corpo restituito
400 È stato inviato un file non zip, parametri errati o un file è stato incluso con un virus Nessun corpo restituito
409 Una richiesta con un valore dell'intestazione x-ms-correlation-id duplicato è stata inviata Nessun corpo restituito

Intestazioni di risposte previste

Name Tipo Valore previsto Obbligatorio?
Posizione Uri URL da utilizzare nelle query per lo stato corrente e per ottenere i risultati sì

Esempio: avviare un'analisi

Questo è un esempio di avvio di un processo di analisi con il set di regole di certificazione del Marketplace , un singolo file ed esclusi i file che contengono il testo jquery e json nel nome.

Richiedi

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

risposta

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

Vedi anche

Usare l'API Web di controllo Power Apps
Recuperare l'elenco di set di regole
Recuperare l'elenco di regole
Caricare un file
Verificare lo stato dell'analisi

  • Last updated on