إنشاء مفاتيح واجهة برمجة تطبيقات Grafana وإدارتها في Azure Managed Grafana (مهمل)

هام

يتم إهمال هذا المستند حيث تم استبدال ميزة مفاتيح API بحسابات الخدمة في Grafana 9.1. للتبديل إلى استخدام حسابات الخدمة، في مثيلات Grafana التي تم إنشاؤها قبل إصدار Grafana 9.1، انتقل إلى مفاتيح واجهة برمجة تطبيقات التكوين > وحدد ترحيل إلى حسابات الخدمة الآن. حدد نعم، قم بالترحيل الآن. سيتم ترحيل كل مفاتيح واجهة برمجة التطبيقات الموجودة تلقائيا إلى حساب خدمة برمز مميز. سيتم إنشاء حساب الخدمة بنفس إذن مفتاح API وستستمر مفاتيح واجهة برمجة التطبيقات الحالية في العمل كما كان من قبل.

تنبيه

يتم التعامل مع كل مفتاح API بواسطة Azure Managed Grafana كمستخدم نشط واحد. وبالتالي فإن إنشاء مفاتيح API جديدة سيؤدي إلى زيادة فاتورة Azure الشهرية. يمكن العثور على التسعير لكل مستخدم نشط في تفاصيل التسعير.

في هذا الدليل، تعرف على كيفية إنشاء مفاتيح واجهة برمجة التطبيقات وإدارتها، وابدأ في إجراء استدعاءات واجهة برمجة التطبيقات إلى خادم Grafana. ستمكنك مفاتيح واجهة برمجة تطبيقات Grafana من إنشاء عمليات تكامل بين Azure Managed Grafana والخدمات الأخرى.

المتطلبات الأساسية

تمكين مفاتيح واجهة برمجة التطبيقات

يتم تعطيل مفاتيح واجهة برمجة التطبيقات بشكل افتراضي في Azure Managed Grafana. يمكنك تمكين هذه الميزة أثناء إنشاء المثيل في مدخل Azure، أو يمكنك تنشيطه على مثيل موجود، باستخدام مدخل Azure أو CLI.

إنشاء مساحة عمل Azure Managed Grafana مع تمكين إنشاء مفتاح API

أثناء إنشاء مساحة عمل Azure Managed Grafana، قم بتمكين إنشاء مفاتيح API في علامة التبويب Advanced ، عن طريق تعيين Enable API key creation إلى Enabled. لمزيد من المعلومات حول إنشاء مثيل جديد باستخدام مدخل Microsoft Azure، انتقل إلى التشغيل السريع: إنشاء مثيل Azure Managed Grafana.

تمكين إنشاء مفتاح API على مثيل Azure Managed Grafana موجود

  1. في مدخل Microsoft Azure، ضمن الإعدادات، حدد Configuration، ثم ضمن API keys، حدد Enable.

    Screenshot of the Azure platform. Enable API keys.

  2. حدد حفظ لتأكيد رغبتك في تنشيط إنشاء مفاتيح واجهة برمجة التطبيقات في Azure Managed Grafana.

إنشاء مفتاح API

  1. افتح مثيل Azure Managed Grafana ومن القائمة اليسرى، حدد Configuration > API keys. Screenshot of the Grafana dashboard. Access API keys page.

  2. حدد New API key.

  3. املأ النموذج، وحدد Add لإنشاء مفتاح API الجديد.

    المعلمة ‏‏الوصف‬ مثال
    اسم المفتاح أدخل اسما لمفتاح Grafana API الجديد. api-key-1
    دور Grafana المدار اختر دور Grafana المدار: عارض أو محرر أو مسؤول. محرر
    مدة البقاء أدخل وقتا قبل انتهاء صلاحية مفتاح API. استخدم s للثوان، m للدقائق، h للساعات، d للأيام، w للأسابيع، M للأشهر، y للسنوات. 7d

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

  4. بمجرد إنشاء المفتاح، تظهر رسالة مع المفتاح الجديد والأمر curl بما في ذلك المفتاح الخاص بك. انسخ هذه المعلومات واحفظها في سجلاتك الآن، حيث سيتم إخفاؤها بمجرد مغادرة هذه الصفحة. إذا أغلقت هذه الصفحة دون حفظ مفتاح API الجديد، فستحتاج إلى إنشاء مفتاح جديد.

    Screenshot of the Grafana dashboard. API key is displayed.

يمكنك الآن استخدام مفتاح Grafana API هذا للاتصال بخادم Grafana.

اختبار مفتاح API

قم بتشغيل الأمر az grafana dashboard list أدناه للتحقق مما إذا كان مفتاح API الخاص بك يعمل. استبدل العناصر النائبة <azure-managed-grafana-name> واسم <api-key> مثيل Azure Managed Grafana ومفتاح API الخاص بك.

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

يسرد إخراج المحطة جميع لوحات المعلومات التي يمكن لمفتاح API الوصول إليها في مثيل Azure Managed Grafana المحدد.

إدارة مفاتيح API

يتم سرد مفاتيح واجهة برمجة التطبيقات الموجودة في مفاتيح واجهة برمجة تطبيقات التكوين>. بشكل افتراضي، يتم عرض مفاتيح API النشطة فقط. حدد تضمين مفاتيح منتهية الصلاحية لعرض جميع المفاتيح التي تم إنشاؤها، وحدد X (حذف) لحذف مفتاح API.

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

الخطوات التالية

في هذا الدليل الإرشادي، تعلمت كيفية إنشاء مفتاح API ل Azure Managed Grafana. عندما تكون مستعدا، ابدأ باستخدام حسابات الخدمة كطريقة جديدة لمصادقة التطبيقات التي تتفاعل مع Grafana: