Обзор API запросов Azure Monitor Logs

Запросите полный набор данных, собранных Azure Monitor журналами, с помощью API запросов журналов. Этот REST API использует тот же язык запросов, который используется в службе для получения данных, создания новых визуализаций данных и расширения возможностей Log Analytics. Описание более широкой поверхности API Azure Monitor см. в разделе Запрос журналов указателя REST API Azure Monitor.

Конечная точка запроса

Все запросы предназначены для рабочей области Log Analytics через общедоступную конечную точку REST:

POST https://api.loganalytics.azure.com/v1/workspaces/{workspaceId}/query
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "query": "AzureActivity | summarize count() by Category",
  "timespan": "PT12H"
}

Замените {workspaceId} на GUID вашей рабочей области Log Analytics, а {accessToken} — на токен носителя Microsoft Entra.

API возвращает ответ JSON, tables содержащий массив. Каждая таблица включает columns (схему) и rows (данные):

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        { "name": "Category", "type": "string" },
        { "name": "count_", "type": "long" }
      ],
      "rows": [
        ["Administrative", 20839],
        ["Recommendation", 122],
        ["Alert", 64],
        ["ServiceHealth", 11]
      ]
    }
  ]
}

Полный справочник по параметрам запроса (включая timespan и параметры для разных рабочих областей) см. в разделе Формат запроса. Подробные сведения о структуре ответа и обработке ошибок см. в формате ответа.

Проверка подлинности API запросов журналов

Приложение должно пройти проверку подлинности для доступа к API запросов журналов:

• Для запроса рабочих областей необходимо использовать аутентификацию Microsoft Entra.
• Чтобы быстро изучить API без использования проверки подлинности Microsoft Entra, используйте демонстрационный ключ API для запроса примеров данных в нерабокой тестовой среде.

Аутентификация Microsoft Entra для данных рабочей области

API запросов к журналам поддерживает аутентификацию Microsoft Entra с помощью Microsoft Entra ID OAuth2. Выберите поток, соответствующий приложению:

• Код авторизации (с PKCE, рекомендуемый для интерактивных приложений)
• Учетные данные клиента (для неинтерактивного доступа между службами)

Неявный поток предоставления прав поддерживается для обратной совместимости, но более не рекомендуется. Для новых приложений используйте поток кода авторизации с PKCE или потоком учетных данных клиента.

Для потока кода авторизации требуется по крайней мере один интерактивный вход пользователя в приложение. Если вам нужен неинтерактивный поток, используйте поток учетных данных клиента.

После получения токена процесс вызова API запросов к журналам одинаков для всех сценариев. Для запросов требуется заголовок Authorization: Bearer, содержащий полученный из потока OAuth2 маркер.

Проверка подлинности по ключу API для демонстрационных данных

Чтобы быстро изучить API без использования проверки подлинности Microsoft Entra, Microsoft предоставляет демонстрационную рабочую область с примерами данных. Проверка подлинности с помощью ключа API.

Ограничения API запросов к журналам

API применяет ограничения на параллелизм, размер результатов, длительность запроса и частоту регулирования. Эти ограничения применяются для каждой рабочей области и зависят от источника запроса. Полный список пороговых значений см. в разделе "Ограничения API запросов".

Клиентские библиотеки и средства командной строки

Azure Monitor поддерживает клиентские библиотеки для различных языков программирования. Вместо прямого вызова REST API эти библиотеки предоставляют оболочку для вызова API запросов журналов, который также обрабатывает проверку подлинности, повторные попытки и анализ ответа. Клиентские библиотеки доступны для:

• .СЕТЬ
• Поехали
• Java
• JavaScript
• Питон

Используйте Azure CLI или Azure PowerShell аналогично запросу из командной строки:

az monitor log-analytics query \
  --workspace "myWorkspaceId" \
  --analytics-query "AzureActivity | summarize count() by Category" \
  --timespan "PT12H"

$queryParams = @{
    WorkspaceId = 'myWorkspaceId'
    Query       = 'AzureActivity | summarize count() by Category'
    Timespan    = (New-TimeSpan -Hours 12)
}

Invoke-AzOperationalInsightsQuery @queryParams

Попробуйте API

Чтобы изучить API без написания кода, используйте клиент API, например Бруно или Бессонница , для создания запросов с помощью визуального интерфейса. Вы также можете использовать cURL из командной строки и передать выходные данные в jsonlint для доступных для чтения JSON.

Связанный контент

• Обнаружение доступных конечных точек и операций в индексе REST API Azure Monitor.
• Узнайте, как перенести данные в Azure Monitor, проверив API приема журналов в Azure Monitor.
• Копирование и преобразование данных из конечной точки REST и обратно с помощью фабрики данных Azure.