Membuat dan mengelola kunci Grafana API di Azure Managed Grafana (Tidak digunakan lagi)

Penting

Dokumen ini tidak digunakan lagi karena fitur kunci API telah digantikan oleh akun layanan di Grafana 9.1. Untuk beralih menggunakan akun layanan, di instans Grafana yang dibuat sebelum rilis Grafana 9.1, buka Kunci API Konfigurasi > dan pilih Migrasi ke akun layanan sekarang. Pilih Ya, migrasikan sekarang. Setiap kunci API yang ada akan secara otomatis dimigrasikan ke akun layanan dengan token. Akun layanan akan dibuat dengan izin yang sama dengan Kunci API dan kunci API saat ini akan terus berfungsi seperti sebelumnya.

Perhatian

Setiap kunci API diperlakukan oleh Azure Managed Grafana sebagai satu pengguna aktif. Dengan demikian, membuat kunci API baru akan meningkatkan faktur Azure bulanan Anda. Harga per pengguna aktif dapat ditemukan di Detail Harga.

Dalam panduan ini, pelajari cara membuat dan mengelola kunci API, dan mulai melakukan panggilan API ke server Grafana. Kunci API Grafana akan memungkinkan Anda membuat integrasi antara Azure Managed Grafana dan layanan lainnya.

Prasyarat

Mengaktifkan kunci API

Kunci API dinonaktifkan secara default di Azure Managed Grafana. Anda dapat mengaktifkan fitur ini selama pembuatan instans di portal Azure, atau Anda dapat mengaktifkannya pada instans yang ada, menggunakan portal Azure atau CLI.

Membuat ruang kerja Azure Managed Grafana dengan pembuatan kunci API diaktifkan

Selama pembuatan ruang kerja Azure Managed Grafana, aktifkan pembuatan kunci API di tab Tingkat Lanjut , dengan mengatur Aktifkan pembuatan kunci API ke Diaktifkan. Untuk informasi selengkapnya tentang membuat instans baru menggunakan portal Azure, buka Mulai Cepat: Membuat instans Azure Managed Grafana.

Mengaktifkan pembuatan kunci API pada instans Azure Managed Grafana yang ada

  1. Di portal Azure, di bawah Pengaturan, pilih Konfigurasi, lalu di bawah Kunci API, pilih Aktifkan.

    Screenshot of the Azure platform. Enable API keys.

  2. Pilih Simpan untuk mengonfirmasi bahwa Anda ingin mengaktifkan pembuatan kunci API di Azure Managed Grafana.

Membuat kunci API

  1. Buka instans Azure Managed Grafana Anda dan dari menu sebelah kiri, pilih Kunci API Konfigurasi>. Screenshot of the Grafana dashboard. Access API keys page.

  2. Pilih Kunci API baru.

  3. Isi formulir, dan pilih Tambahkan untuk menghasilkan kunci API baru.

    Parameter Deskripsi Contoh
    Nama kunci Masukkan nama untuk kunci Grafana API baru Anda. api-key-1
    Peran Grafana Terkelola Pilih peran Grafana Terkelola: Penampil, Editor, atau Admin. Editor
    Waktu untuk aktif Masukkan waktu sebelum kunci API Anda kedaluwarsa. Gunakan s untuk detik, m untuk menit, h selama berjam-jam , d untuk hari, w selama berpekanan, M selama berbulan-bulan, y selama bertahun-tahun. 7h terakhir

    Screenshot of the Grafana dashboard. API creation form is filled out.

  4. Setelah kunci dibuat, pesan muncul dengan kunci baru dan perintah curl termasuk kunci Anda. Salin informasi ini dan simpan di rekaman Anda sekarang, karena akan disembunyikan setelah Anda meninggalkan halaman ini. Jika Anda menutup halaman ini tanpa menyimpan kunci API baru, Anda harus membuat yang baru.

    Screenshot of the Grafana dashboard. API key is displayed.

Anda sekarang dapat menggunakan kunci Grafana API ini untuk memanggil server Grafana.

Menguji kunci API

Jalankan perintah az grafana dashboard list di bawah ini untuk memeriksa apakah kunci API Anda berfungsi. Ganti tempat penampung dan <api-key> dengan nama instans <azure-managed-grafana-name> Azure Managed Grafana dan kunci API Anda.

az grafana dashboard list --name <azure-managed-grafana-name> --api-key <api-key>

Output terminal mencantumkan semua dasbor yang dapat diakses kunci API Anda dalam instans Azure Managed Grafana yang ditentukan.

Mengelola kunci API

Kunci API yang ada tercantum dalam kunci API Konfigurasi>. Secara default, hanya kunci API aktif yang ditampilkan. Pilih Sertakan kunci yang kedaluwarsa untuk melihat semua kunci yang dibuat, dan pilih X (Hapus) untuk menghapus kunci API.

Screenshot of the Grafana dashboard. API keys are listed under Configuration > API keys.

Langkah berikutnya

Dalam panduan cara ini, Anda mempelajari cara membuat kunci API untuk Azure Managed Grafana. Saat Anda siap, mulai gunakan akun layanan sebagai cara baru untuk mengautentikasi aplikasi yang berinteraksi dengan Grafana: