Compartilhar via

Formato de solicitação da API do Log Analytics do Azure Monitor

  • Artigo

Há dois pontos de extremidade por meio dos quais é possível se comunicar com a API do Log Analytics:

  • Uma URL direta para a API: https://api.loganalytics.azure.com
  • Por meio do ARM (Azure Resource Manager).

Embora as URLs sejam diferentes, os parâmetros de consulta são os mesmos para cada ponto de extremidade. Ambos os pontos de extremidade exigem autorização por meio do Microsoft Entra ID.

A API suporta os métodos POST e GET.

Formato de API Pública

O formato da API Pública é:

    https://api.loganalytics.azure.com/{api-version}/workspaces/{workspaceId}/query?[parameters]

em que:

  • api-version: a versão da API. A versão atual é "v1"
  • workspaceId: ID do espaço de trabalho
  • parameters: os dados necessários para essa consulta

GET /query

Quando o método HTTP executado é GET, os parâmetros são incluídos na cadeia de caracteres de consulta.

Por exemplo, para contar eventos AzureActivity por categoria, faça esta chamada:

    GET https://api.loganalytics.azure.com/v1/workspaces/{workspace-id}/query?query=AzureActivity%20|%20summarize%20count()%20by%20Category
    Authorization: Bearer <access token>

POST /query

Quando o método HTTP executado é POST:

  • O corpo DEVE ser um JSON válido.
  • As solicitações devem incluir o cabeçalho: Content-Type: application/json
  • Os parâmetros são incluídos como propriedades no corpo JSON.
  • Se o parâmetro timespan estiver incluído na cadeia de caracteres de consulta e no corpo JSON, o período de tempo será a interseção dos dois valores.

Por exemplo, para contar eventos AzureActivity por categoria, faça esta chamada:

    POST https://api.loganalytics.azure.com/v1/workspaces/{workspace-id}/query
    
    Authorization: Bearer <access token>
    Content-Type: application/json
    
    {
      "query": "AzureActivity | summarize count() by Category"
    }