Invocar análise

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.

Observação

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

Name Tipo Valor esperado Obrigatório?
Autorização cadeia (de caracteres) O token portador OAuth 1 com a reivindicação de ID de aplicação Microsoft Entra ID. 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 objecto application/json, application/x-ms-sarif-v2 sim
Aceitar-Linguagem cadeia (de caracteres) 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.º

Corpo

Opções utilizadas frequentemente:

Propriedade Tipo Valor esperado Obrigatório?
sasUriList matriz de strings 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. Yes
ruleSets matriz de personalizado 0 ou mais No
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 cadeia (de caracteres) 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 strings 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 de HTTP Cenário Resultado
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

Name Tipo Valor esperado Obrigatório?
Location 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 um trabalho de análise com o conjunto de regras de Certificação do Marketplace , um único ficheiro, excluindo ficheiros que contenham o texto jquery e json no nome.

Pedir

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

Ver também

Utilize a API web do Power Apps checker
Obter a lista de conjuntos de regras
Obter a lista de regras
Carregar um ficheiro
Verificar o estado da análise

  • Last updated on