Invocar análise

Artigo
03/27/2023

Para iniciar uma tarefa de análise, envie um pedido POST para a rota à analyze. A análise pode ser um processo de execução prolongada que normalmente dura mais de um minuto. Primeiro, a API faz alguma validação básica, inicia o pedido no back-end através do envio de uma tarefa e, depois, responde com um código de estado de 202 e um cabeçalho Location, ou com os detalhes de erro adequados. O valor de cabeçalho Location é um URL que pode ser utilizado para verificar o estado do pedido e para obter os URLs dos resultados. Existem várias opções através da ação POST para adaptar a tarefa com base nos seus critérios, como a lista de regras ou os conjuntos de regras, os ficheiros a excluir da análise e muito mais. Pode iniciar a análise com a seguinte [Geographical URL]/api/analyze?api-version=1.0.

Nota

Recomenda-se que aguarde entre 15 a 60 segundos entre as verificações de estado. Normalmente, a análise demora entre 1 a 5 minutos a ser executada.
Esta API exige um token de OAuth.

Cabeçalhos

Nome	Tipo	Valor esperado	Necessária?
Autorização	cadeia	O token de portador de OAuth 1 com a afirmação do ID da Aplicação do ID do Microsoft Entra.	sim
x-ms-tenant-id	GUID	O ID do inquilino para a aplicação.	sim
x-ms-correlation-id	GUID	O Identificador para a execução da análise. Deve fornecer o mesmo ID para toda a execução (carregar, analisar, estado).	sim
Aceitar	objeto	`application/json, application/x-ms-sarif-v2`	sim
Accept-Language	string	O código ou os códigos de idioma (por exemplo, en-US). A predefinição é en-US. Se forem fornecidos vários idiomas, a primeira será a principal. No entanto, todas as traduções (se o idioma for suportado) serão incluídas.	não

Corpo

Opções utilizadas frequentemente:

Propriedade	Tipo	Valor esperado	Necessária?
sasUriList	matriz de cadeias	Uma lista de URIs que fornece o acesso ao serviço para descarregar uma única solução, um ficheiro zip que contém vários ficheiros de solução, ou um pacote.	Sim
ruleSets	matriz de personalizado	0 ou mais	Não
ruleSets.id	guid	O ID do conjunto de regras, que pode ser encontrado ao consultar a API de conjunto de regras.	Não, mas isto é normalmente o que quereria utilizar. Tem de utilizar isto ou ruleCodes.
ruleCodes.code	string	O ID da regra pretendida, que pode ser encontrado ao consultar as APIs de conjunto de regras e de regra.	Não, tem de utilizar isto ou ruleSets.
fileExclusions	matriz de cadeias	Uma lista de nomes de ficheiros ou padrões de nomes de ficheiros a excluir. Existe suporte para utilizar "" como caráter universal no início e/ou no fim do nome de ficheiro (por exemplo, jquery.dll e jquery).	No

Respostas esperadas

Código de estado HTTP	Cenário	Result
202	O pedido de análise foi aceite e o URI de verificação de estado foi devolvido no cabeçalho `Location`	Sem corpo de resultados
400	Foi enviado um ficheiro não zip, parâmetros incorretos ou um ficheiro foi incluído com um vírus	Sem corpo de resultados
409	Foi enviado um pedido com um valor de cabeçalho `x-ms-correlation-id` duplicado	Sem corpo de resultados

Cabeçalhos de resposta esperados

Nome	Tipo	Valor esperado	Necessária?
Localização	Uri	URL para utilizar na consulta do estado atual e para obter os resultados	sim

Exemplo: iniciar uma análise

Este é um exemplo de iniciar uma tarefa de análise com o conjunto de regras Certificação AppSource, um único ficheiro e excluindo os ficheiros que contêm o texto jquery e json no nome.

Pedido

POST [Geographical URI]/api/analyze?api-version=1.0
Accept: application/json
Content-Type: application/json; charset=utf-8
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
x-ms-tenant-id: F2E60E49-CB87-4C24-8D4F-908813B22506

{
    "ruleSets": [{
        "id": "0ad12346-e108-40b8-a956-9a8f95ea18c9"
    }],
    "sasUriList": ["https://testenvfakelocation.blob.core.windows.net/mySolution.zip"],
    "fileExclusions": ["*jquery*", "*json*"]
}

Response

HTTP/1.1 202 Accepted
Content-Type: application/json; charset=utf-8
Location: [Geographical URI]/api/status/9E378E56-6F35-41E9-BF8B-C0CC88E2B832&api-version=1.0

Consulte também

Utilizar a API Web do verificador do Power Apps
Obter a lista de conjuntos de regras
Obter a lista de regras
Carregar um ficheiro
Verificar o estado da análise

Partilhar via