Mengakses API Log Analytics Azure Monitor

Artikel
10/18/2023

Anda dapat mengirimkan permintaan kueri ke ruang kerja dengan menggunakan titik https://api.loganalytics.azure.comakhir Analitik Log Azure Monitor . Untuk mengakses titik akhir, Anda harus mengautentikasi melalui ID Microsoft Entra.

Catatan

Titik api.loganalytics.io akhir sedang digantikan oleh api.loganalytics.azure.com. Titik api.loganalytics.io akhir akan terus didukung untuk masa mendatang yang dapat dilihat.

Mengautentikasi dengan kunci API demo

Untuk menjelajahi API dengan cepat tanpa autentikasi Microsoft Entra, gunakan ruang kerja demonstrasi dengan data sampel, yang mendukung autentikasi kunci API.

Untuk mengautentikasi dan menjalankan kueri terhadap ruang kerja sampel, gunakan DEMO_WORKSPACE sebagai {workspace-id} dan lewati kunci API DEMO_KEY.

Jika ID Aplikasi atau kunci API salah, layanan API mengembalikan kesalahan 403 (Terlarang).

Kunci API DEMO_KEY dapat diteruskan dengan tiga cara berbeda, tergantung pada apakah Anda ingin menggunakan header, URL, atau autentikasi dasar:

Header kustom: Berikan kunci API di header X-Api-Keykustom .
Parameter kueri: Berikan kunci API dalam parameter api_keyURL .
Autentikasi dasar: Berikan kunci API sebagai nama pengguna atau kata sandi. Jika Anda menyediakan keduanya, kunci API harus ada di nama pengguna.

Contoh ini menggunakan ID ruang kerja dan kunci API di header:

    POST https://api.loganalytics.azure.com/v1/workspaces/DEMO_WORKSPACE/query
    X-Api-Key: DEMO_KEY
    Content-Type: application/json
    
    {
        "query": "AzureActivity | summarize count() by Category"
    }

Titik akhir API Publik

Titik akhir API publik adalah:

    https://api.loganalytics.azure.com/{api-version}/workspaces/{workspaceId}

di mana:

api-version: Versi API. Versi saat ini adalah "v1."
workspaceId: ID ruang kerja Anda.

Kueri diteruskan dalam isi permintaan.

Contohnya:

   https://api.loganalytics.azure.com/v1/workspaces/1234abcd-def89-765a-9abc-def1234abcde
   
   Body:
   {
       "query": "Usage"
   }

Mengonfigurasikan autentikasi

Untuk mengakses API, Anda mendaftarkan aplikasi klien dengan ID Microsoft Entra dan meminta token.

Daftarkan aplikasi di ID Microsoft Entra.
Pada halaman gambaran umum aplikasi, pilih Izin API.
Pilih Tambahkan izin.
Pada tab API yang digunakan organisasi saya, cari Log Analytics dan pilih Log Analytics API dari daftar.
Pilih Izin yang didelegasikan.
Pilih kotak centang Data.Read .
Pilih Tambahkan izin.

Sekarang setelah aplikasi Anda terdaftar dan memiliki izin untuk menggunakan API, berikan aplikasi Anda akses ke ruang kerja Analitik Log Anda.

Dari halaman gambaran umum ruang kerja Analitik Log Anda, pilih Kontrol akses (IAM).
Pilih Tambahkan penetapan peran.
Pilih peran Pembaca lalu pilih Anggota.
Pada tab Anggota , pilih Pilih anggota.
Masukkan nama aplikasi Anda di kotak Pilih .
Pilih aplikasi Anda dan pilih Pilih.
Pilih Tinjau + tetapkan.
Setelah Anda menyelesaikan penyiapan Direktori Aktif dan izin ruang kerja, minta token otorisasi.

Catatan

Untuk contoh ini, kami menerapkan peran Pembaca. Peran ini adalah salah satu dari banyak peran bawaan dan mungkin menyertakan lebih banyak izin daripada yang Anda butuhkan. Peran dan izin yang lebih terperinci dapat dibuat. Untuk informasi selengkapnya, lihat Mengelola akses ke ruang kerja Analitik Log.

Meminta token otorisasi

Sebelum memulai, pastikan Anda memiliki semua nilai yang diperlukan untuk membuat permintaan berhasil. Semua permintaan memerlukan:

ID penyewa Microsoft Entra Anda.
ID ruang kerja Anda.
ID klien Microsoft Entra Anda untuk aplikasi.
Rahasia klien Microsoft Entra untuk aplikasi.

API Analitik Log mendukung autentikasi Microsoft Entra dengan tiga alur Microsoft Entra ID OAuth2 yang berbeda:

Informasi masuk klien
Kode otorisasi
Implisit

Alur Info masuk Klien

Dalam alur kredensial klien, token digunakan dengan titik akhir Analitik Log. Satu permintaan dibuat untuk menerima token dengan menggunakan kredensial yang disediakan untuk aplikasi Anda di langkah sebelumnya saat Anda mendaftarkan aplikasi di ID Microsoft Entra.

https://api.loganalytics.azure.com Gunakan titik akhir.

URL token kredensial klien (permintaan POST)

    POST /<your-tenant-id>/oauth2/token
    Host: https://login.microsoftonline.com
    Content-Type: application/x-www-form-urlencoded
    
    grant_type=client_credentials
    &client_id=<app-client-id>
    &resource=https://api.loganalytics.io
    &client_secret=<app-client-secret>

Permintaan yang berhasil menerima token akses dalam respons:

    {
        token_type": "Bearer",
        "expires_in": "86399",
        "ext_expires_in": "86399",
        "access_token": ""eyJ0eXAiOiJKV1QiLCJ.....Ax"
    }

Gunakan token dalam permintaan ke titik akhir Analitik Log:

    POST /v1/workspaces/your workspace id/query?timespan=P1D
    Host: https://api.loganalytics.azure.com
    Content-Type: application/json
    Authorization: Bearer <your access token>

    Body:
    {
    "query": "AzureActivity |summarize count() by Category"
    }

Contoh respons:

    {
        "tables": [
            {
                "name": "PrimaryResult",
                "columns": [
                    {
                        "name": "OperationName",
                        "type": "string"
                    },
                    {
                        "name": "Level",
                        "type": "string"
                    },
                    {
                        "name": "ActivityStatus",
                        "type": "string"
                    }
                ],
                "rows": [
                    [
                        "Metric Alert",
                        "Informational",
                        "Resolved",
                        ...
                    ],
                    ...
                ]
            },
            ...
        ]
    }

Alur kode otorisasi

Aliran OAuth2 utama yang didukung adalah melalui kode otorisasi. Metode ini memerlukan dua permintaan HTTP untuk memperoleh token untuk memanggil API Analitik Log Azure Monitor. Ada dua URL, dengan satu titik akhir per permintaan. Formatnya dijelaskan di bagian berikut.

URL kode otorisasi (permintaan GET)

    GET https://login.microsoftonline.com/YOUR_Azure AD_TENANT/oauth2/authorize?
    client_id=<app-client-id>
    &response_type=code
    &redirect_uri=<app-redirect-uri>
    &resource=https://api.loganalytics.io

Saat permintaan dibuat ke URL otorisasi, client_id adalah ID aplikasi dari aplikasi Microsoft Entra Anda, yang disalin dari menu properti aplikasi. redirect_uri adalah URL beranda/login dari aplikasi Microsoft Entra yang sama. Ketika permintaan berhasil, titik akhir ini mengarahkan Anda ke halaman masuk yang Anda berikan saat mendaftar dengan kode otorisasi yang ditambahkan ke URL. Lihat contoh berikut:

    http://<app-client-id>/?code=AUTHORIZATION_CODE&session_state=STATE_GUID

Pada titik ini, Anda telah mendapatkan kode otorisasi, yang Anda butuhkan sekarang untuk meminta token akses.

URL token kode otorisasi (permintaan POST)

    POST /YOUR_Azure AD_TENANT/oauth2/token HTTP/1.1
    Host: https://login.microsoftonline.com
    Content-Type: application/x-www-form-urlencoded
    
    grant_type=authorization_code
    &client_id=<app client id>
    &code=<auth code fom GET request>
    &redirect_uri=<app-client-id>
    &resource=https://api.loganalytics.io
    &client_secret=<app-client-secret>

Semua nilai sama seperti sebelumnya, dengan beberapa tambahan. Kode otorisasi adalah kode yang sama dengan yang Anda terima dalam permintaan sebelumnya setelah pengalihan berhasil. Kode dikombinasikan dengan kunci yang diperoleh dari aplikasi Microsoft Entra. Jika Anda tidak menyimpan kunci, Anda dapat menghapusnya dan membuat kunci baru dari tab kunci menu aplikasi Microsoft Entra. Responsnya adalah string JSON yang berisi token dengan skema berikut. Jenis ditunjukkan untuk nilai token.

Contoh respons:

    {
        "access_token": "eyJ0eXAiOiJKV1QiLCJ.....Ax",
        "expires_in": "3600",
        "ext_expires_in": "1503641912",
        "id_token": "not_needed_for_log_analytics",
        "not_before": "1503638012",
        "refresh_token": "eyJ0esdfiJKV1ljhgYF.....Az",
        "resource": "https://api.loganalytics.io",
        "scope": "Data.Read",
        "token_type": "bearer"
    }

Bagian token akses dari respons ini adalah apa yang Anda sajikan kepada API Analitik Log di header Authorization: Bearer. Anda juga dapat menggunakan token refresh di masa mendatang untuk memperoleh access_token baru dan refresh_token ketika token Anda telah basi. Untuk permintaan ini, format dan titik akhir adalah:

    POST /YOUR_AAD_TENANT/oauth2/token HTTP/1.1
    Host: https://login.microsoftonline.com
    Content-Type: application/x-www-form-urlencoded
    
    client_id=<app-client-id>
    &refresh_token=<refresh-token>
    &grant_type=refresh_token
    &resource=https://api.loganalytics.io
    &client_secret=<app-client-secret>

Contoh respons:

    {
      "token_type": "Bearer",
      "expires_in": "3600",
      "expires_on": "1460404526",
      "resource": "https://api.loganalytics.io",
      "access_token": "eyJ0eXAiOiJKV1QiLCJ.....Ax",
      "refresh_token": "eyJ0esdfiJKV1ljhgYF.....Az"
    }

Alur kode implisit

API Analitik Log mendukung alur implisit OAuth2. Untuk alur ini, hanya satu permintaan yang diperlukan, tetapi tidak ada token refresh yang dapat diperoleh.

URL otorisasi kode implisit

    GET https://login.microsoftonline.com/YOUR_AAD_TENANT/oauth2/authorize?
    client_id=<app-client-id>
    &response_type=token
    &redirect_uri=<app-redirect-uri>
    &resource=https://api.loganalytics.io

Permintaan yang berhasil menghasilkan pengalihan ke URI pengalihan Anda dengan token di URL:

    http://YOUR_REDIRECT_URI/#access_token=YOUR_ACCESS_TOKEN&token_type=Bearer&expires_in=3600&session_state=STATE_GUID

Access_token ini dapat digunakan sebagai Authorization: Bearer nilai header saat diteruskan ke API Analitik Log untuk mengotorisasi permintaan.

Informasi selengkapnya

Anda dapat menemukan dokumentasi tentang OAuth2 dengan Microsoft Entra di sini:

Share via

Mengakses API Log Analytics Azure Monitor

Mengautentikasi dengan kunci API demo

Titik akhir API Publik

Mengonfigurasikan autentikasi

Meminta token otorisasi

Alur Info masuk Klien

URL token kredensial klien (permintaan POST)

Alur kode otorisasi

URL kode otorisasi (permintaan GET)

URL token kode otorisasi (permintaan POST)

Alur kode implisit

URL otorisasi kode implisit

Informasi selengkapnya

Langkah berikutnya

Sumber Daya Tambahan: