Omówienie interfejsu API zapytań dzienników Azure Monitor

Wykonaj zapytanie dotyczące pełnego zestawu danych zebranych przez dzienniki Azure Monitor przy użyciu interfejsu API zapytań dzienników. Ten interfejs API REST używa tego samego języka zapytań, który jest używany w całej usłudze do pobierania danych, tworzenia nowych wizualizacji danych i rozszerzania możliwości Log Analytics. Aby uzyskać szerszą powierzchnię interfejsu API Azure Monitor, zobacz sekcję Zapytania dzienników w indeksie interfejsu API REST Azure Monitor.

Punkt końcowy zapytania

Wszystkie zapytania są przeznaczone dla obszaru roboczego Log Analytics za pośrednictwem publicznego punktu końcowego 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"
}

Zastąp {workspaceId} identyfikatorem GUID obszaru roboczego usługi Log Analytics, a {accessToken} tokenem okaziciela Microsoft Entra.

Interfejs API zwraca odpowiedź JSON zawierającą tablicę tables . Każda tabela zawiera columns (schemat) i rows (dane):

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

Pełny opis parametrów żądania (w tym timespan i opcji między obszarami roboczymi) znajdziesz w sekcji Format żądania. Aby uzyskać szczegółową strukturę odpowiedzi i obsługę błędów, zobacz Format odpowiedzi.

Uwierzytelnianie interfejsu API zapytań dzienników

Aplikacja musi uwierzytelniać się, aby uzyskać dostęp do interfejsu API zapytań dzienników:

  • Aby zapytać o swoje przestrzenie robocze, musisz użyć uwierzytelnienia Microsoft Entra.
  • Aby szybko eksplorować interfejs API bez używania uwierzytelniania Microsoft Entra, użyj klucza demonstracyjnego interfejsu API do wykonywania zapytań dotyczących przykładowych danych w środowisku testowym nieprodukcyjnym.

uwierzytelnianie Microsoft Entra dla danych przestrzeni roboczej

Interfejs API zapytań dzienników obsługuje uwierzytelnianie Microsoft Entra za pomocą protokołu OAuth2 Microsoft Entra ID. Wybierz przepływ pasujący do aplikacji:

  • Kod autoryzacji (z protokołem PKCE zalecanym w przypadku aplikacji interaktywnych)
  • Poświadczenia klienta (w przypadku dostępu nieinterakcyjnego do usługi)

Niejawny przepływ udzielania jest obsługiwany w celu zapewnienia zgodności z poprzednimi wersjami, ale nie jest już zalecany. W przypadku nowych aplikacji użyj przepływu kodu autoryzacji z PKCE lub przepływu poświadczeń klienta.

Przepływ kodu autoryzacyjnego wymaga co najmniej jednego interaktywnego logowania użytkownika do aplikacji. Jeśli potrzebujesz przepływu nieinteraktywnego, użyj przepływu poświadczeń klienta.

Po otrzymaniu tokenu proces wywoływania interfejsu API zapytań dzienników jest taki sam dla wszystkich przepływów. Żądania wymagają nagłówka Authorization: Bearer, wypełnionego tokenem otrzymanym z procesu OAuth2.

Notatka

Gdy używasz uwierzytelniania Microsoft Entra, może minąć kilka minut, zanim interfejs API zapytań dzienników rozpozna nowe uprawnienia kontroli dostępu opartej na rolach. Podczas propagacji uprawnień wywołania interfejsu API REST mogą zakończyć się niepowodzeniem z kodem błędu 403.

Uwierzytelnianie za pomocą klucza API dla danych przykładowych

Aby szybko eksplorować interfejs API bez używania uwierzytelniania Microsoft Entra, Microsoft udostępnia przykładowy obszar roboczy z przykładowymi danymi. Uwierzytelnianie przy użyciu klucza interfejsu API.

Limity interfejsu API zapytań dzienników

Interfejs API wymusza limity współbieżności, rozmiaru wyników, czasu trwania zapytania i ograniczania przepustowości. Te limity są stosowane dla obszaru roboczego i różnią się w zależności od źródła zapytań. Aby uzyskać pełną listę progów, zobacz Limity interfejsu API zapytań.

Biblioteki klienta i narzędzia wiersza polecenia

Azure Monitor obsługuje biblioteki klienckie dla różnych języków programowania. Zamiast wywoływać interfejs API REST bezpośrednio, biblioteki te udostępniają nakładkę do wywoływania interfejsu API zapytań dzienników, która obsługuje również uwierzytelnianie, ponawianie prób i parsowanie odpowiedzi. Biblioteki klienckie są dostępne dla:

Użyj Azure CLI lub Azure PowerShell w podobny sposób, aby wykonywać zapytania z wiersza polecenia:

Użyj polecenia az monitor log-analytics query, aby uruchomić zapytanie KQL dla obszaru roboczego.

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

Wypróbuj interfejs API

Aby eksplorować interfejs API bez pisania kodu, użyj klienta interfejsu API, takiego jak Bruno lub Bezsenność , aby tworzyć zapytania za pomocą interfejsu wizualnego. Możesz również użyć biblioteki cURL z wiersza polecenia i przekazać dane wyjściowe do pliku jsonlint w celu odczytania kodu JSON.

Treści powiązane

  • Last updated on