مزامنة واجهات برمجة التطبيقات من مثيل APIM

توضح هذه المقالة كيفية دمج (ربط) نسخة إدارة واجهة برمجة التطبيقات بحيث تبقى واجهات برمجة التطبيقات الخاصة بالمثيل محدثة باستمرار في مخزون مركز واجهة برمجة التطبيقات الخاصة بك.

Tip

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

Note

يمكن الآن استخدام API Center Standard دون تكلفة إضافية عند ربطه بمثيل إدارة API في المستوى القياسي أو المعيار v2 أو Premium أو Premium v2. لمزيد من المعلومات، راجع خطط وميزات مركز API.

حول دمج مثيل APIM

على الرغم من أنه يمكنك استخدام Azure CLI لاستيراد واجهات برمجة التطبيقات عند الطلب من Azure API Management إلى Azure API Center، إلا أن دمج (ربط) مثيل إدارة واجهة برمجة التطبيقات يتيح المزامنة المستمرة بحيث يظل مخزون واجهة برمجة التطبيقات محدثا. يمكن ل Azure API Center أيضا مزامنة واجهات برمجة التطبيقات من مصادر بما في ذلك Amazon API Gateway.

عند دمج مثيل APIM كمصدر API، يحدث ما يلي:

1. تتم إضافة جميع واجهات برمجة التطبيقات، وتعريفات واجهة برمجة التطبيقات (المواصفات) اختياريا، من مثيل APIM إلى مخزون مركز واجهة برمجة التطبيقات. تدرج خوادم MCP وواجهات برمجة تطبيقات الوكلاء A2A في إدارة واجهات برمجة التطبيقات ضمن واجهات البرمجة المضافة إلى المخزون.
2. يمكنك تكوين بيئة من النوع Azure API Management في مركز واجهة برمجة التطبيقات.
3. يتم إنشاء توزيع مقترن لكل تعريف واجهة برمجة تطبيقات متزامنة من إدارة واجهة برمجة التطبيقات.

تتم مزامنة API Management APIs تلقائيا إلى مركز API كلما تغيرت إعدادات واجهات برمجة التطبيقات الحالية (على سبيل المثال، تتم إضافة إصدارات جديدة)، أو يتم إنشاء واجهات برمجة تطبيقات جديدة، أو حذف واجهات برمجة التطبيقات. هذه المزامنة أحادية الاتجاه من APIM إلى مركز Azure API، ما يعني أن تحديثات واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات لا تتم مزامنتها مرة أخرى إلى مثيل APIM.

Note

• هناك حدود لعدد مثيلات إدارة واجهة برمجة التطبيقات المتكاملة (مصادر واجهة برمجة التطبيقات).
• يمكنك تكوين مثيل إدارة واجهة برمجة تطبيقات متكاملة في شبكة افتراضية.
• عادة ما تتم مزامنة تحديثات واجهة برمجة التطبيقات في APIM مع مركز واجهة برمجة التطبيقات في غضون دقائق، ولكن قد تستغرق المزامنة ما يصل إلى 24 ساعة.
• كما تتم مزامنة تعريفات واجهة برمجة التطبيقات مع مركز واجهة برمجة التطبيقات إذا حددت خيار تضمينها أثناء التكامل.

الكيانات المتزامنة من APIM

يمكنك إضافة خصائص بيانات التعريف والوثائق أو تحديثها إلى واجهات برمجة التطبيقات المتزامنة في مركز واجهة برمجة التطبيقات لمساعدة المساهمين على اكتشاف واجهات برمجة التطبيقات وفهمها واستهلاكها. تعرف على المزيد حول خصائص بيانات التعريف المضمنة والمخصصة لمركز Azure API.

يعرض الجدول التالي خصائص الكيان التي يمكن تعديلها في Azure API Center والخصائص التي تم تعيينها استنادا إلى قيمها في مصدر واجهة برمجة التطبيقات.

Entity	الخصائص القابلة للتكوين في مركز واجهة برمجة التطبيقات	الخصائص المحددة في مصدر واجهة برمجة التطبيقات المتكامل
API	summary lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
إصدار API	lifecycleStage	title التعريفات (إذا تمت مزامنتها)
Environment	title description نوع server.managementPortalUri onboarding customProperties	server.type
Deployment	title description server state customProperties	server.runtimeUri

Note

يتم إنشاء معرفات الموارد والنظام للكيانات المتزامنة مع Azure API Center تلقائيا ولا يمكن تغييرها.

Prerequisites

• مركز API في اشتراك Azure الخاص بك. إذا لم تنشئ مركز API، راجع Quickstart: إنشاء مركز API الخاص بك.

• مثيل Azure API Management، في نفس الاشتراك أو اشتراك مختلف. يجب أن يكون المثيل في نفس الدليل.

• بالنسبة إلى Azure CLI:

  • استخدم بيئة Bash في Azure Cloud Shell. لمزيد من المعلومات، راجع بدء استخدام Azure Cloud Shell.

    

  • إذا كنت تفضل تشغيل أوامر مرجع CLI محلياً قم بتثبيت CLI Azure. إذا كنت تعمل على نظام تشغيل Windows أو macOS، ففكر في تشغيل Azure CLI في حاوية Docker. لمزيد من المعلومات، راجع كيفية تشغيل Azure CLI في حاوية Docker.

    • إذا كنت تستخدم تثبيت محلي، يُرجى تسجيل الدخول إلى Azure CLI مستخدمًا أمر az login. لإنهاء عملية المصادقة، اتبع الخطوات المعروضة في جهازك. للحصول على خيارات تسجيل الدخول الأخرى، راجع المصادقة على Azure باستخدام Azure CLI.

    • عندما يُطلب منك، قم بتثبيت ملحق Azure CLI عند الاستخدام لأول مرة. لمزيد من المعلومات حول الملحقات، راجع استخدام الملحقات وإدارتها باستخدام Azure CLI.

    • يُرجى تشغيل إصدار az للوصول إلى الإصدار والمكتبات التابعة التي تم تثبيتها. للتحديث لآخر إصدار، يُرجى تشغيل تحديث az.

  Note

  تتطلب الأوامر az apic إضافة apic-extension Azure CLI. يمكن تثبيت الإضافة ديناميكيا عند تشغيل أول az apic أمرة، أو يمكنك تثبيت الإضافة يدويا. لمزيد من المعلومات، راجع إدارة امتدادات Azure CLI: تثبيت، تحديث، وإزالة.

  للحصول على أحدث التغييرات والتحديثات في ، apic-extensionراجع ملاحظات الإصدار. قد تتطلب بعض الميزات معاينة أو نسخة محددة من الإضافة.

  Note

  يمكنك تشغيل أمثلة أوامر Azure CLI في هذه المقالة في PowerShell أو في bash shell. عندما يتطلب الأمر بناء جملة متغيرات مختلفة، توفر المقالة أمثلة أوامر منفصلة للقشرتين.

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

بالنسبة لهذا السيناريو، يستخدم مركز API الخاص بك هوية مدارة للوصول إلى موارد Azure. بناء على احتياجاتك، قم بتمكين هوية مدارة معينة من قبل النظام أو هوية واحدة أو أكثر من الهويات المدارة المعينة من قبل المستخدم.

توضح الأمثلة التالية كيفية تمكين هوية مدارة معينة من قبل النظام باستخدام مدخل Azure أو Azure CLI. على مستوى عال، تتشابه خطوات التكوين مع الهوية المدارة المعينة من قبل المستخدم.

Portal

1. في البوابة، اذهب إلى مركز واجهة برمجة التطبيقات الخاصة بك.
2. في قائمة الشريط الجانبي، تحت قسم الأمان، اختر الهويات المدارة.
3. حدد النظام المعين، ثم قم بتعيين الحالة إلى تشغيل.
4. حدد حفظ.

قم بتعيين الهوية المعينة من قبل النظام في مركز واجهة برمجة التطبيقات باستخدام الأمر التالي az apic update . استبدل أسماء مركز واجهة برمجة التطبيقات ومجموعة الموارد:

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

تعيين الهوية المدارة دور قارئ خدمة إدارة واجهة برمجة التطبيقات

للسماح باستيراد واجهات برمجة التطبيقات، قم بتعيين الهوية المدارة لمركز API دور قارئ خدمة إدارة واجهة برمجة التطبيقات في مثيل APIM الخاص بك. يمكنك استخدام المدخل أو Azure CLI.

Portal

1. في المدخل، انتقل إلى مثيل API Management.
2. على الجانب الأيسر، حدد التحكم بالوصول (IAM).
3. حدد + إضافة تعيين دور.
4. في صفحة إضافة تعيين دور، قم بتعيين القيم كما يلي:
   1. في علامة التبويب Role ، حدد API Management Service Reader.
   2. في علامة التبويب الأعضاء، في تعيين الوصول إلى - حدد الهوية> المدارة + تحديد الأعضاء.
   3. في صفحة تحديد الهويات المدارة ، حدد الهوية المدارة المعينة من قبل النظام لمركز API الذي أضفته في القسم السابق. انقر فوق تحديد.
   4. حدد مراجعة + تعيين.

1. احصل على المعرف الأساسي للهوية. للحصول على هوية معينة من قبل النظام، استخدم الأمر az apic show .

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. احصل على معرف المورد لمثيل APIM باستخدام الأمر az apim show .

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. قم بتعيين الهوية المدارة دور قارئ خدمة APIM في مثيل APIM باستخدام الأمر az role assignment create .

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

دمج مثيل APIM

يمكنك دمج نسخة إدارة API باستخدام البوابة أو Azure CLI.

Portal

1. في البوابة، اذهب إلى مركز واجهة برمجة التطبيقات الخاصة بك.
2. ضمن الأنظمة الأساسية، حدد عمليات التكامل.
3. حدد + تكامل> جديدمن Azure API Management.
4. في دمج خدمة إدارة واجهة برمجة تطبيقات Azure الخاصة بك:
   1. حدد ما إذا كنت تريد مزامنة جميع واجهات برمجة التطبيقات من مثيل إدارة واجهة برمجة التطبيقات أو واجهات برمجة التطبيقات الموجودة في مساحة عمل إدارة واجهة برمجة التطبيقات فقط.
   2. حدد خدمة الاشتراكومجموعة المواردوإدارة واجهة برمجة تطبيقات Azure التي تريد دمجها. إذا كنت تريد مزامنة واجهات برمجة التطبيقات فقط من مساحة عمل، فقم بإجراء تحديد في اختيار مساحة عمل.
   3. في تفاصيل الدمج، أدخل معرفا. إذا لم تكن قد قمت بالفعل بتكوين هوية مدارة مع الوصول إلى مثيل APIM، فمكن تكوين الهوية المدارة تلقائيا وتعيين الأذونات. يعين هذا التحديد تلقائيا الهوية المدارة المعينة من قبل النظام لمركز API الأذونات الضرورية لمزامنة واجهات برمجة التطبيقات من مثيل APIM.
   4. في تفاصيل البيئة، أدخل عنوان البيئة (الاسم) ونوع البيئةوالوصف الاختياري.
   5. في تفاصيل واجهة برمجة التطبيقات:
      1. حدد دورة حياة لواجهات برمجة التطبيقات المتزامنة. (يمكنك تحديث هذه القيمة لواجهات برمجة التطبيقات بعد إضافتها إلى مركز واجهة برمجة التطبيقات.)
      2. اختياريا، حدد ما إذا كنت تريد تضمين تعريفات واجهة برمجة التطبيقات مع واجهات برمجة التطبيقات المتزامنة.
5. حدد إنشاء.

قم بتشغيل الأمر az apic integration create apim لدمج مثيل APIM في مركز API الخاص بك.

Note

• هذا الأمر متوفر فقط في نسخة المعاينة من امتداد APIC.
• قم بتثبيت النسخة الجديدة من المعاينة قبل استخدام هذا الأمر.

• قم بتوفير أسماء مجموعة الموارد ومركز واجهة برمجة التطبيقات والتكامل.

• إذا كان مثيل إدارة الواجهة ومركز واجهة برمجة التطبيقات في نفس مجموعة الموارد، يمكنك تقديم اسم مثيل إدارة الواجهة كقيمة .azure-apim وإلا، قدم معرف موارد Azure.

az apic integration create apim \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <apim-integration-name> \
    --azure-apim <apim-instance-name>

يتم دمج مثيل APIM كبيئة في مركز API الخاص بك. تتم مزامنة API Management APIs مع مخزون مركز API.

حذف تكامل

أثناء دمج مصدر واجهة برمجة التطبيقات، لا يمكنك حذف واجهات برمجة التطبيقات المتزامنة من مركز واجهة برمجة التطبيقات. إذا كنت بحاجة إلى ذلك، يمكنك حذف التكامل. عند حذف تكامل:

• يتم حذف واجهات برمجة التطبيقات المتزامنة في مخزون مركز واجهة برمجة التطبيقات
• يتم حذف البيئة والنشرات المقترنة بمصدر واجهة برمجة التطبيقات

يمكنك حذف تكامل باستخدام المدخل أو Azure CLI.

Portal

1. في المدخل، انتقل إلى مركز API الخاص بك.
2. ضمن الأصول، حدد عمليات تكامل البيئات>(معاينة).
3. حدد التكامل، ثم حدد حذف (أيقونة سلة المهملات).

قم بتشغيل الأمر az apic integration delete (preview) لحذف تكامل. قم بتوفير أسماء مجموعة الموارد ومركز واجهة برمجة التطبيقات والتكامل.

az apic integration delete \
    --resource-group <resource-group-name> \
    --service-name <api-center-name> \
    --integration-name <integration-name> \

المحتويات ذات الصلة

• إدارة مخزون واجهة برمجة التطبيقات باستخدام أوامر Azure CLI
• استيراد واجهات برمجة التطبيقات من APIM إلى مركز Azure API
• قم بالتسجيل واكتشاف خوادم MCP في مركز واجهة برمجة التطبيقات الخاص بك
• وثائق إدارة واجهات برمجة تطبيقات Azure