مزامنة واجهات برمجة التطبيقات من مثيل APIM (معاينة)
توضح هذه المقالة كيفية دمج مثيل APIM بحيث يتم تحديث واجهات برمجة التطبيقات للمثيلات باستمرار في مخزون مركز واجهة برمجة التطبيقات.
حول دمج مثيل APIM
على الرغم من أنه يمكنك استخدام Azure CLI لاستيراد واجهات برمجة التطبيقات عند الطلب من Azure API Management إلى Azure API Center، فإن دمج (ربط) مثيل APIM يتيح المزامنة المستمرة بحيث يظل مخزون واجهة برمجة التطبيقات محدثا. يمكن ل Azure API Center أيضا مزامنة واجهات برمجة التطبيقات من مصادر بما في ذلك Amazon API Gateway.
عند دمج مثيل APIM كمصدر API، يحدث ما يلي:
- تتم إضافة جميع واجهات برمجة التطبيقات، وتعريفات واجهة برمجة التطبيقات (المواصفات) اختياريا، من مثيل APIM إلى مخزون مركز واجهة برمجة التطبيقات.
- يمكنك تكوين بيئة من نوع Azure API Management في مركز واجهة برمجة التطبيقات.
- يتم إنشاء نشر مقترن لكل تعريف واجهة برمجة تطبيقات متزامن من APIM.
تتم مزامنة API Management APIs تلقائيا إلى مركز API كلما تغيرت إعدادات واجهات برمجة التطبيقات الحالية (على سبيل المثال، تتم إضافة إصدارات جديدة)، أو يتم إنشاء واجهات برمجة تطبيقات جديدة، أو حذف واجهات برمجة التطبيقات. هذه المزامنة أحادية الاتجاه من APIM إلى مركز Azure API، ما يعني أن تحديثات واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات لا تتم مزامنتها مرة أخرى إلى مثيل APIM.
إشعار
- تكامل Azure API Management قيد المعاينة حاليا.
- هناك حدود لعدد مثيلات APIM المتكاملة (مصادر واجهة برمجة التطبيقات).
- عادة ما تتم مزامنة تحديثات واجهة برمجة التطبيقات في APIM مع مركز واجهة برمجة التطبيقات في غضون دقائق، ولكن قد تستغرق المزامنة ما يصل إلى 24 ساعة.
- كما تتم مزامنة تعريفات واجهة برمجة التطبيقات مع مركز واجهة برمجة التطبيقات إذا حددت خيار تضمينها أثناء التكامل.
الكيانات المتزامنة من APIM
يمكنك إضافة خصائص بيانات التعريف والوثائق أو تحديثها إلى واجهات برمجة التطبيقات المتزامنة في مركز واجهة برمجة التطبيقات لمساعدة المساهمين على اكتشاف واجهات برمجة التطبيقات وفهمها واستهلاكها. تعرف على المزيد حول خصائص بيانات التعريف المضمنة والمخصصة لمركز Azure API.
يعرض الجدول التالي خصائص الكيان التي يمكن تعديلها في Azure API Center والخصائص التي تم تعيينها استنادا إلى قيمها في مصدر واجهة برمجة التطبيقات.
| الكيان | الخصائص القابلة للتكوين في مركز واجهة برمجة التطبيقات | الخصائص المحددة في مصدر واجهة برمجة التطبيقات المتكامل |
|---|---|---|
| واجهة برمجة التطبيقات (API) | الملخص. دورة الحياةStage termsOfService الترخيص مستند خارجي خصائص مخصصة |
العنوان الوصف النوع |
| إصدار API | دورة الحياةStage | العنوان التعريفات (إذا تمت مزامنتها) |
| البيئة | العنوان الوصف kind server.managementPortalUri الإعداد خصائص مخصصة |
server.type |
| التوزيع | العنوان الوصف الخادم state خصائص مخصصة |
server.runtimeUri |
إشعار
يتم إنشاء معرفات الموارد والنظام للكيانات المتزامنة مع Azure API Center تلقائيا ولا يمكن تغييرها.
المتطلبات الأساسية
مركز API في اشتراك Azure الخاص بك. إذا لم تكن قد أنشأت واحدا، فشاهد التشغيل السريع: إنشاء مركز واجهة برمجة التطبيقات.
مثيل Azure API Management، في نفس الاشتراك أو اشتراك مختلف. يجب أن يكون المثيل في نفس الدليل.
بالنسبة إلى Azure CLI:
استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع التشغيل السريع ل Bash في Azure Cloud Shell.
إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.
إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات أخرى لتسجيل دخول، راجع تسجيل الدخول باستخدام Azure CLI.
عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات بشأن الامتدادات، راجع استخدام امتدادات مع Azure CLI.
يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.
إشعار
az apicتتطلبapic-extensionالأوامر ملحق Azure CLI. إذا لم تكن قد استخدمتaz apicالأوامر، يمكن تثبيت الملحق ديناميكيا عند تشغيل الأمر الأولaz apic، أو يمكنك تثبيت الملحق يدويا. تعرف على المزيد حول ملحقات Azure CLI.راجع ملاحظات الإصدار للاطلاع على آخر التغييرات والتحديثات في
apic-extension. قد تتطلب بعض الميزات معاينة أو إصدار معين من الملحق.إشعار
يمكن تشغيل أمثلة أوامر Azure CLI في هذه المقالة في PowerShell أو bash shell. عند الحاجة بسبب بناء جملة متغير مختلف، يتم توفير أمثلة أوامر منفصلة للقذيفتين.
تمكين هوية مدارة في مركز واجهة برمجة التطبيقات
بالنسبة لهذا السيناريو، يستخدم مركز API الخاص بك هوية مدارة للوصول إلى موارد Azure. بناء على احتياجاتك، قم بتمكين هوية مدارة معينة من قبل النظام أو هوية واحدة أو أكثر من الهويات المدارة المعينة من قبل المستخدم.
توضح الأمثلة التالية كيفية تمكين هوية مدارة معينة من قبل النظام باستخدام مدخل Azure أو Azure CLI. على مستوى عال، تتشابه خطوات التكوين مع الهوية المدارة المعينة من قبل المستخدم.
- في المدخل، انتقل إلى مركز API الخاص بك.
- في القائمة اليسرى، ضمن Security، حدد Managed identities.
- حدد النظام المعين، ثم قم بتعيين الحالة إلى تشغيل.
- حدد حفظ.
تعيين الهوية المدارة دور قارئ خدمة إدارة واجهة برمجة التطبيقات
للسماح باستيراد واجهات برمجة التطبيقات، قم بتعيين الهوية المدارة لمركز API دور قارئ خدمة إدارة واجهة برمجة التطبيقات في مثيل APIM الخاص بك. يمكنك استخدام المدخل أو Azure CLI.
- في المدخل، انتقل إلى مثيل API Management.
- على الجانب الأيسر، حدد التحكم بالوصول (IAM).
- حدد + إضافة تعيين دور.
- في صفحة إضافة تعيين دور، قم بتعيين القيم كما يلي:
- في علامة التبويب Role ، حدد API Management Service Reader.
- في علامة التبويب الأعضاء، في تعيين الوصول إلى - حدد الهوية> المدارة + تحديد الأعضاء.
- في صفحة تحديد الهويات المدارة ، حدد الهوية المدارة المعينة من قبل النظام لمركز API الذي أضفته في القسم السابق. انقر فوق تحديد.
- حدد مراجعة + تعيين.
دمج مثيل APIM
يمكنك دمج مثيل APIM باستخدام المدخل أو Azure CLI.
- في المدخل، انتقل إلى مركز API الخاص بك.
- ضمن Assets، حدد Environments.
- حدد ارتباطات (معاينة)>+ إنشاء ارتباط.
- في صفحة ربط خدمة إدارة واجهة برمجة تطبيقات Azure:
- حدد الاشتراك ومجموعة الموارد وخدمة Azure API Management التي تريد دمجها.
- في تفاصيل الارتباط، أدخل معرفا.
- في تفاصيل البيئة، أدخل عنوان البيئة (الاسم) ونوع البيئة والوصف الاختياري.
- في تفاصيل واجهة برمجة التطبيقات:
- حدد دورة حياة لواجهات برمجة التطبيقات المتزامنة. (يمكنك تحديث هذه القيمة لواجهات برمجة التطبيقات بعد إضافتها إلى مركز واجهة برمجة التطبيقات.)
- اختياريا، حدد ما إذا كنت تريد تضمين تعريفات واجهة برمجة التطبيقات مع واجهات برمجة التطبيقات المتزامنة.
- حدد إنشاء.
تتم إضافة البيئة في مركز API الخاص بك. يتم استيراد API Management APIs إلى مخزون مركز API.
حذف تكامل
أثناء دمج مصدر واجهة برمجة التطبيقات، لا يمكنك حذف واجهات برمجة التطبيقات المتزامنة من مركز واجهة برمجة التطبيقات. إذا كنت بحاجة إلى ذلك، يمكنك حذف التكامل. عند حذف تكامل:
- يتم حذف واجهات برمجة التطبيقات المتزامنة في مخزون مركز واجهة برمجة التطبيقات
- يتم حذف البيئة والنشرات المقترنة بمصدر واجهة برمجة التطبيقات
يمكنك حذف تكامل باستخدام المدخل أو Azure CLI.
- في المدخل، انتقل إلى مركز API الخاص بك.
- ضمن Assets، حدد Environments>Links (preview).
- حدد الارتباط، ثم حدد حذف (أيقونة سلة المهملات).