Invocar análise

O inicio dun traballo de análise faise enviando unha solicitude POST á ruta analyze. A análise pode ser un proceso longo que normalmente dura máis dun minuto. A API primeiro fai algunha validación básica, inicia a solicitude no back-end enviando un traballo e despois responde cun código de estado de 202 e unha cabeceira Location ou cos detalles de erro apropiados. O valor de cabeceira Location é un URL que se pode usar para comprobar o estado da solicitude e para obter os URL dos resultados. Hai varias opcións a través da acción POST para adaptar o traballo en función dos seus criterios, como a lista de regras ou conxuntos de regras, ficheiros que hai que excluír da análise e moito máis. Pode iniciar a análise usando a seguinte [Geographical URL]/api/analyze?api-version=1.0.

Nota

Recoméndase esperar de 15 a 60 segundos entre as comprobacións de estado. A análise normalmente tarda entre 1 e 5 minutos en executarse.
Esta API require un OAuth token.

Cabeceiras

Nome	Tipo	Valor esperado	Requirido?
Autorización	cadea	O token de portador OAuth 1 con Microsoft Entra reivindicación de ID da aplicación ID.	si
x-ms-tenant-id	GUID	ID do arrendatario para a aplicación.	si
x-ms-correlation-id	GUID	Identificador para a execución da análise. Debe fornecer o mesmo ID para toda a execución (carga, análise, estado).	si
Aceptar	obxecto	application/json, application/x-ms-sarif-v2	si
Accept-Language	cadea	O código ou códigos do idioma (por exemplo, en-US). O valor predefinido é en-US. Se se proporcionan varios idiomas, o primeiro será o primario. Non obstante, incluiranse todas as traducións (se o idioma é compatible).	non

Corpo

Opcións comunmente usadas:

Propiedade	Tipo	Valor esperado	Requirido?
sasUriList	matriz de cadeas	Lista de URI que proporciona o acceso ao servizo para descargar unha única solución, un ficheiro .zip que contén varios ficheiros de solucións ou un paquete.	Si
ruleSets	matriz de elementos personalizados	0 ou máis	Non
ruleSets.id	guid	ID do conxunto de regras, que se pode atopar consultando a API do conxunto de regras.	Non, pero normalmente é o que quere empregar. Debe empregar isto ou ruleCodes.
ruleCodes.code	cadea	ID da regra desexada, que se pode atopar consultando as API da regra e do conxunto de regras.	Non, debe empregar isto ou ruleSets.
fileExclusions	matriz de cadeas	Lista de nomes de ficheiros ou padróns de nomes de ficheiro a excluír. Existe soporte para usar "*" como comodín no inicio ou ao final dun nome de ficheiro (por exemplo,*jquery.dll e *jquery*).	Non

Respostas esperadas

Código de estado HTTP	Escenario	Resultado
202	Aceptouse a solicitude de análise e devolveuse o URI de comprobación de estado na cabeceira Location	Sen corpo de resultado
400	Enviouse un ficheiro non .zip, parámetros incorrectos ou incluíuse un ficheiro cun virus	Sen corpo de resultado
409	Enviouse unha solicitude cun valor de cabeceira x-ms-correlation-id duplicado	Sen corpo de resultado

Cabeceiras da resposta esperadas

Nome	Tipo	Valor esperado	Requirido?
Localización	URI	URL para usar para consultar o estado actual e para obter os resultados	si

Exemplo: iniciar unha análise

Este é un exemplo de iniciar un traballo de análise co conxunto de regras de AppSource Certificación, un único ficheiro e excluíndo os ficheiros que conteñan o texto jquery e json no nome.

Solicitude

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

Consulte tamén

Usa a API web de verificación Power Apps
Recuperar a lista de conxuntos de regras
Recuperar a lista de regras
Cargar un ficheiro
Comprobar o estado da análise