Azure İzleyici Günlükleri sorgu API'sine genel bakış

Günlükler sorgu API'siyle Azure İzleyici Günlükler tarafından toplanan verilerin tamamını sorgular. Bu REST API, verileri almak, verilerinizin yeni görselleştirmelerini oluşturmak ve Log Analytics özelliklerini genişletmek için hizmet genelinde kullanılan sorgu dilini kullanır. Daha geniş Azure İzleyici API yüzeyi için Azure İzleyici REST API dizininin Günlükler sorgusu bölümüne bakın.

Sorgu uç noktası

Tüm sorgular genel REST uç noktası aracılığıyla bir Log Analytics çalışma alanını hedefler:

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} değerini Log Analytics çalışma alanınızın GUID’siyle ve {accessToken} değerini Microsoft Entra bearer belirteciyle değiştirin.

API, dizi içeren bir tables JSON yanıtı döndürür. Her tablo, columns (şema) ve rows (veriler) içerir:

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

tam istek parametresi başvurusu için (çalışma alanları arası seçenekler dahil timespan ) bkz. İstek biçimi. Ayrıntılı yanıt yapısı ve hata işleme için bkz. Yanıt biçimi.

Sorgu API'sinde kimlik doğrulamayı günlüğe kaydeder

Uygulamanızın Günlükler sorgu API'sine erişmek için kimlik doğrulaması yapması gerekir:

  • Çalışma alanlarınızı sorgulamak için Microsoft Entra kimlik doğrulamasını kullanmanız gerekir.
  • Microsoft Entra kimlik doğrulaması kullanmadan API'yi hızla keşfetmek için demo API anahtarını kullanarak üretim dışı bir test ortamındaki örnek verileri sorgulayın.

Çalışma alanı verileri için Microsoft Entra kimlik doğrulaması

Günlük Sorgusu API'si, Microsoft Entra ID OAuth2 ile Microsoft Entra kimlik doğrulamasını destekler. Uygulamanıza uygun akışı seçin:

  • Yetkilendirme kodu (PKCE ile, etkileşimli uygulamalar için önerilir)
  • İstemci kimlik bilgileri (etkileşimli olmayan, hizmet-hizmet erişimi için)

Örtük yetkilendirme akışı, geriye dönük uyumluluk için desteklenmektedir ancak artık önerilmemektedir. Yeni uygulamalar için PKCE ile yetkilendirme kodu akışını veya istemci kimlik bilgileri akışını kullanın.

Yetkilendirme kodu akışı, uygulamanızda en az bir kullanıcı etkileşimli oturum açma gerektirir. Etkileşimli olmayan bir akışa ihtiyacınız varsa istemci kimlik bilgileri akışını kullanın.

Belirteç aldıktan sonra Günlükler sorgu API'sini çağırma işlemi tüm akışlar için aynıdır. İstekler, OAuth2 akışından alınan belirteçle doldurulmuş Authorization: Bearer başlığını gerektirir.

Not

Microsoft Entra kimlik doğrulaması kullandığınızda, Günlükler sorgu API'sinin yeni rol tabanlı erişim denetimi izinlerini tanıması birkaç dakika sürebilir. İzinler yayılırken REST API çağrıları 403 hata koduyla başarısız olabilir.

Örnek veriler için API anahtarı kimlik doğrulaması

Microsoft Entra kimlik doğrulaması kullanmadan API'yi hızla keşfetmek için Microsoft örnek verileri içeren bir tanıtım çalışma alanı sağlar. API anahtarı kullanarak kimlik doğrulaması yapın.

Sorgu API'si sınırlarını günlüğe kaydeder

API eşzamanlılık, sonuç boyutu, sorgu süresi ve azaltma oranı sınırlarını zorunlu tutar. Bu sınırlar çalışma alanı başına uygulanır ve sorgu kaynağına bağlı olarak değişir. Eşiklerin tam listesi için bkz. Sorgu API'si sınırları.

İstemci kitaplıkları ve komut satırı araçları

Azure İzleyici çeşitli programlama dilleri için istemci kitaplıklarını destekler. Bu kitaplıklar, REST API'yi doğrudan çağırmak yerine sizin için kimlik doğrulama, yeniden deneme ve yanıt ayrıştırma işlemlerini de işleyen Günlükler sorgu API'sini çağırmak için bir sarmalayıcı sağlar. İstemci kitaplıkları şunlar için kullanılabilir:

komut satırından sorgulamak için Azure CLI veya Azure PowerShell benzer şekilde kullanın:

Çalışma alanında KQL sorgusu çalıştırmak için kullanın az monitor log-analytics query .

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

API'yi deneyin

Kod yazmadan API'yi keşfetmek için Bruno veya Uykusuz gibi bir API istemcisi kullanarak görsel bir arabirimle sorgular oluşturun. Ayrıca komut satırından cURL kullanabilir ve okunabilir JSON için çıkışı jsonlint'e aktarabilirsiniz.

İlgili içerik

  • Last updated on