مشاركة عبر


مركز واجهة برمجة تطبيقات Azure كمصدر لشبكة الأحداث (معاينة)

توفر هذه المقالة خصائص ومخطط أحداث Azure API Center. للحصول على مقدمة لمخططات الأحداث، راجع مخطط حدث Azure Event Grid.

إشعار

هذه الميزة في وضع المعاينة حاليًا.

أنواع الأحداث المتاحة

يتم تشغيل هذه الأحداث عندما يضيف عميل تعريف واجهة برمجة التطبيقات أو يحدثه.

اسم الحدث ‏‏الوصف
تمت إضافة Microsoft.ApiCenter.ApiDefinition يتم تشغيله عند إضافة تعريف واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات.
Microsoft.ApiCenter.ApiDefinitionUpdated يتم تشغيله عند تحديث تعريف واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات.

مثال حدث

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

حدث Microsoft.ApiCenter.ApiDefinitionAdded

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionAdded",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

حدث Microsoft.ApiCenter.ApiDefinitionUpdated

[{
  "source": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services",
  "subject": "/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.ApiCenter/services/{api_center_name}/workspaces/default/apis/{api_name}/versions/{version_name}/definitions/{definition_name}",
  "type": "Microsoft.ApiCenter.ApiDefinitionUpdated",
  "time": "2024-03-01T00:00:00.0000000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "data": {
    "title": "OpenAPI",
    "description": "Default spec",
    "specification": {
      "name": "openapi",
      "version": "3.0.1"
    }
  },
  "specversion": "1.0"
}]

خصائص الحدث

ويحتوي الحدث على بيانات المستوى الأعلى التالية:

الخاصية نوع الوصف
source سلسلة مسار المورد الكامل إلى مصدر الحدث. هذا الحقل غير قابل للكتابة. توفر شبكة الأحداث هذه القيمة.
subject سلسلة مسار يحدده الناشر لموضوع الحدث.
type سلسلة أحد أنواع الأحداث المسجلة لمصدر الحدث الماثل.
time سلسلة الوقت الذي يتم إنشاء الحدث استناداً إلى وقت UTC الموفر.
id سلسلة المعرف الفريد للحدث.
data كائن بيانات حدث Azure API Center.
specversion سلسلة إصدار مواصفات مخطط CloudEvents.

كائن البيانات له الخصائص التالية:

الخاصية نوع الوصف
title سلسلة عنوان تعريف واجهة برمجة التطبيقات.
description سلسلة وصف تعريف واجهة برمجة التطبيقات.
specification سلسلة خصائص مواصفات واجهة برمجة التطبيقات، التي تتكون من (اسم المواصفات name ) و version (إصدار المواصفات)

البرامج التعليمية والدروس المعرفية

المسمى الوظيفي ‏‏الوصف
تمكين التحليل والتحليل لحوكمة واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات استخدم أحداث Event Grid لتشغيل التحليل لتحليل تعريفات واجهة برمجة التطبيقات في مركز واجهة برمجة التطبيقات.