Přehled rozhraní API pro dotazy na protokoly Azure Monitor

Zadejte dotaz na úplnou sadu dat shromažďovaných protokoly Azure Monitor pomocí rozhraní API pro dotazování protokolů. Toto rozhraní REST API používá stejný dotazovací jazyk, který se používá v celé službě k načítání dat, vytváření nových vizualizací dat a rozšíření možností Log Analytics. Širší oblast rozhraní API služby Azure Monitor najdete v části Dotaz na protokoly v indexu rozhraní Azure Monitor REST API.

Koncový bod dotazu

Všechny dotazy cílí na pracovní prostor Log Analytics. Následující příklady spustí dotaz AzureActivity | summarize count() by Category KQL za posledních 12 hodin, aby se spočítaly záznamy protokolu aktivit podle kategorie.

Následující Azure CLI příklad používá az monitor log-analytics query příkaz.

# Set variables
workspaceId="<WorkspaceId>"
query="AzureActivity | summarize count() by Category"
timespan="PT12H"

# Run the Log Analytics query
az monitor log-analytics query \
  --workspace "$workspaceId" \
  --analytics-query "$query" \
  --timespan "$timespan"

Rozhraní REST API vrátí odpověď JSON obsahující tables pole. Každá tabulka obsahuje columns (schéma) a rows (data). Následující příklad ukazuje výsledky dotazu protokolu aktivit:

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

Úplný odkaz na parametr požadavku (včetně timespan a možností mezi pracovními prostory) najdete v tématu Formát požadavku. Podrobnou strukturu odpovědí a zpracování chyb najdete v tématu Formát odpovědi.

Ověřování rozhraní API pro dotazování protokolů

Vaše aplikace se musí ověřit pro přístup k rozhraní API pro dotazy protokolů:

  • K dotazování na pracovní prostory musíte použít ověřování Microsoft Entra.
  • Pokud chcete rychle prozkoumat rozhraní API bez použití ověřování Microsoft Entra, použijte ukázkový klíč rozhraní API k dotazování ukázkových dat v neprodukčním testovacím prostředí.

Ověřování Microsoft Entra pro data pracovního prostoru

Rozhraní API pro dotazování protokolů podporuje ověřování Microsoft Entra pomocí Microsoft Entra ID OAuth2. Zvolte tok, který odpovídá vaší aplikaci:

  • Autorizační kód (s PKCE, doporučeno pro interaktivní aplikace)
  • Přihlašovací údaje klienta (pro neinteraktivní přístup mezi službami)

Implicitní tok udělení se podporuje pro zpětnou kompatibilitu, ale nedoporučuje se. Pro nové aplikace použijte tok autorizačního kódu s PKCE nebo tok přihlašovacích údajů klienta.

Tok autorizačního kódu vyžaduje aspoň jedno interaktivní přihlášení uživatele k vaší aplikaci. Pokud potřebujete neinteraktivní tok, použijte tok přihlašovacích údajů klienta.

Po přijetí tokenu je proces volání rozhraní API pro dotazy protokolů stejný pro všechny toky. Požadavky vyžadují hlavičku Authorization: Bearer vyplněnou tokenem přijatým z toku OAuth2.

Poznámka:

Pokud používáte ověřování Microsoft Entra, může trvat několik minut, než rozhraní API pro dotazy protokolů rozpozná nové oprávnění řízení přístupu na základě role. Zatímco se oprávnění šíří, volání rozhraní REST API můžou selhat s kódem chyby 403.

Ověřování pomocí klíče API pro ukázková data

Pokud chcete rychle prozkoumat rozhraní API bez použití ověřování Microsoft Entra, Microsoft poskytuje ukázkový pracovní prostor s ukázkovými daty. Ověřování pomocí klíče rozhraní API

Limity rozhraní API pro dotazy na protokoly

API uplatňuje limity na souběžnost, velikost výsledků, dobu trvání dotazu a rychlost omezování. Tato omezení platí pro každý pracovní prostor a liší se v závislosti na zdroji dotazu. Úplný seznam prahových hodnot najdete v tématu Omezení rozhraní API pro dotazy.

Klientské knihovny a nástroje příkazového řádku

Azure Monitor podporuje klientské knihovny pro různé programovací jazyky. Místo přímého volání rozhraní REST API poskytují tyto knihovny obálku pro volání rozhraní API pro dotazy protokolů, které také zpracovává ověřování, opakování a parsování odpovědí za vás. Klientské knihovny jsou k dispozici pro:

Příklady Azure CLI a Azure PowerShell najdete v tématu Koncový bod dotazu.

Vyzkoušejte rozhraní API

Pokud chcete prozkoumat rozhraní API bez psaní kódu, použijte klienta rozhraní API, jako je Bruno nebo Režim spánku , k vytváření dotazů pomocí vizuálního rozhraní. Můžete také použít cURL z příkazového řádku a převést výstup do jsonlint pro čitelný JSON.

Související obsah

  • Poslední aktualizace v