Descrição geral da API de Análise de Registos do Azure Monitor

  • Artigo

A API de Consulta do Log Analytics é uma API REST que você pode usar para consultar o conjunto completo de dados coletados pelos logs do Azure Monitor. Você pode usar a mesma linguagem de consulta usada em todo o serviço. Use essa API para recuperar dados, criar novas visualizações de seus dados e estender os recursos do Log Analytics.

Autenticação da API do Log Analytics

Você deve se autenticar para acessar a API do Log Analytics:

  • Para consultar seus espaços de trabalho, você deve usar a autenticação do Microsoft Entra.
  • Para explorar rapidamente a API sem usar a autenticação do Microsoft Entra, você pode usar uma chave de API para consultar dados de exemplo em um ambiente que não seja de produção.

Autenticação do Microsoft Entra para dados do espaço de trabalho

A API do Log Analytics suporta a autenticação do Microsoft Entra com três fluxos diferentes do Microsoft Entra ID OAuth2 :

  • Código de autorização
  • Implícito
  • Credenciais de cliente

O fluxo de código de autorização e o fluxo implícito exigem pelo menos uma entrada interativa do usuário em seu aplicativo. Se você precisar de um fluxo não interativo, use o fluxo de credenciais do cliente.

Depois de receber um token, o processo para chamar a API do Log Analytics é o mesmo para todos os fluxos. As solicitações exigem o Authorization: Bearer cabeçalho, preenchido com o token recebido do fluxo OAuth2.

Autenticação de chave de API para dados de exemplo

Para explorar rapidamente a API sem usar a autenticação do Microsoft Entra, fornecemos um espaço de trabalho de demonstração com dados de exemplo. Você pode autenticar usando uma chave de API.

Nota

Quando você usa a autenticação do Microsoft Entra, pode levar até 60 minutos para que a API REST do Application Insights reconheça novas permissões de controle de acesso baseadas em função. Enquanto as permissões estão se propagando, as chamadas da API REST podem falhar com o código de erro 403.

Limites de consulta da API do Log Analytics

Para obter informações sobre limites de consulta, consulte a seção API de consulta desta página da Web.

Experimente a API do Log Analytics

Para experimentar a API sem escrever nenhum código, você pode usar:

  • Seu cliente favorito, como Fiddler ou Postman para gerar consultas manualmente com uma interface de usuário.
  • cURL da linha de comando. Em seguida, canalize a saída para jsonlint para obter JSON legível.

Em vez de chamar a API REST diretamente, você pode usar as bibliotecas de cliente idiomáticas do Azure Monitor Query:

Cada biblioteca de cliente é um wrapper em torno da API REST que permite recuperar dados de log do espaço de trabalho.