Azure APIM كمصدر شبكة الأحداث
توفر هذه المقالة مخطط أحداث إدارة واجهة برمجة التطبيقات لـ Azure وخصائصها. للحصول على مقدمة لمخططات الأحداث، راجع مخطط حدث Azure Event Grid. كما أنه توفر لك ارتباطات إلى مقالات لمعرفة استخدام إدارة واجهة برمجة التطبيقات لـ Azure كمصدر الحدث.
أنواع الأحداث المتاحة
إدارة واجهة برمجة التطبيقات يتفرع منها أنواع الأحداث التالية:
| نوع الحدث | الوصف |
|---|---|
| Microsoft.ApiManagement.UserCreated | يحدث عند إنشاء مستخدم. |
| Microsoft.ApiManagement.UserUpdated | يحدث عند تحديث مستخدم. |
| Microsoft.ApiManagement.UserDeleted | يحدث عند حذف مستخدم. |
| Microsoft.ApiManagement.APICreated | يحدث عند إنشاء واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.APIUpdated | يحدث عند تحديث واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.APIDeleted | يحدث عند حذف واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.ProductCreated | يحدث عند إنشاء منتج. |
| Microsoft.ApiManagement.ProductUpdated | يحدث عند تحديث منتج. |
| Microsoft.ApiManagement.ProductDeleted | يحدث عند حذف منتج. |
| Microsoft.ApiManagement.ReleaseCreated | يحدث عند إنشاء إصدار واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.ReleaseUpdated | يحدث عند تحديث إصدار واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.ReleaseDeleted | يحدث عند حذف إصدار واجهة برمجة التطبيقات. |
| Microsoft.ApiManagement.SubscriptionCreated | يحدث عند إنشاء اشتراك. |
| Microsoft.ApiManagement.SubscriptionUpdated | يحدث عند تحديث اشتراك. |
| Microsoft.ApiManagement.SubscriptionDeleted | يحدث عند حذف اشتراك. |
| Microsoft.ApiManagement.GatewayCreated | يرفع عند إنشاء بوابة ذاتية الاستضافة. |
| Microsoft.ApiManagement.GatewayDeleted | يرفع عند تحديث بوابة ذاتية الاستضافة. |
| Microsoft.ApiManagement.GatewayUpdated | يرفع عند حذف بوابة مستضافة ذاتيا. |
| تمت إضافة Microsoft.ApiManagement.GatewayAPI | يتم رفعه عند إزالة واجهة برمجة تطبيقات من بوابة مستضافة ذاتيا. |
| Microsoft.ApiManagement.GatewayAPIRemoved | يتم رفعه عند إزالة واجهة برمجة تطبيقات من بوابة مستضافة ذاتيا. |
| Microsoft.ApiManagement.GatewayCertificateAuthorityCreated | يتم رفعه عند تحديث مرجع مصدق لاستضافة ذاتية. |
| Microsoft.ApiManagement.GatewayCertificateAuthorityDeleted | يرفع عند حذف مرجع مصدق لاستضافة ذاتية. |
| Microsoft.ApiManagement.GatewayCertificateAuthorityUpdated | يتم رفعه عند تحديث مرجع مصدق لاستضافة ذاتية. |
| Microsoft.ApiManagement.GatewayHostnameConfigurationCreated | يتم رفعه عند إنشاء تكوين اسم مضيف لاستضافة ذاتية. |
| Microsoft.ApiManagement.GatewayHostnameConfigurationDeleted | يتم رفعه عند حذف تكوين اسم مضيف لاستضافة ذاتية. |
| Microsoft.ApiManagement.GatewayHostnameConfigurationUpdated | يتم رفعه عند تحديث تكوين اسم المضيف لاستضافة ذاتية. |
مثال حدث
يوضح المثال التالي مخطط حدث إنشاء منتج. مخطط الأحداث الأخرى التي تم إنشاؤها من موارد إدارة واجهة برمجة التطبيقات مشابه.
[{
"id": "81dac958-49cf-487e-8805-d0baf0ee485a",
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
"subject": "/products/myproduct",
"data": {
"resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/products/myproduct"
},
"Type": "Microsoft.ApiManagement.ProductCreated",
"Time": "2021-07-02T00:38:44.3978295Z",
"specversion":"1.0"
}]
يوضح المثال التالي مخطط حدث حذف مستخدم. مخطط الأحداث الأخرى التي تم خذفها من موارد إدارة واجهة برمجة التطبيقات مشابه.
[{
"id": "81dac958-49cf-487e-8805-d0baf0ee485a",
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
"subject": "/users/apimuser-contoso-com",
"data": {
"resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/users/apimuser-contoso-com"
},
"Type": "Microsoft.ApiManagement.UserDeleted",
"Time": "2021-07-02T00:38:44.3978295Z",
"specversion":"1.0"
}]
يوضح المثال التالي مخطط حدث تحديث واجهة برمجة التطبيقات. مخطط الأحداث الأخرى التي تم تحديثها من موارد إدارة واجهة برمجة التطبيقات مشابه.
[{
"id": "95015754-aa51-4eb6-98d9-9ee322b82ad7",
"source": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}",
"subject": "/apis/myapi;Rev=1",
"data": {
"resourceUri": "/subscriptions/{subscription-id}/resourceGroups/{your-rg}/providers/Microsoft.ApiManagement/service/{your-APIM-instance}/apis/myapi;Rev=1"
},
"Type": "Microsoft.ApiManagement.APIUpdated",
"Time": "2021-07-12T23:13:44.9048323Z",
"specversion":1.0
}]
خصائص الحدث
ويحتوي الحدث على بيانات المستوى الأعلى التالية:
| الخاصية | نوع | الوصف |
|---|---|---|
source |
سلسلة | مسار المورد الكامل إلى مصدر الحدث. هذا الحقل غير قابل للكتابة. توفر شبكة الأحداث هذه القيمة. |
subject |
سلسلة | مسار يحدده الناشر لموضوع الحدث. |
type |
سلسلة | أحد أنواع الأحداث المسجلة لمصدر الحدث الماثل. |
time |
سلسلة | الوقت الذي يتم إنشاء الحدث استناداً إلى وقت UTC الموفر. |
id |
سلسلة | المعرف الفريد للحدث. |
data |
كائن | بيانات حدث إدارة واجهة برمجة التطبيقات. |
specversion |
سلسلة | إصدار مواصفات مخطط CloudEvents. |
كائن البيانات له الخصائص التالية:
| الخاصية | نوع | الوصف |
|---|---|---|
resourceUri |
سلسلة | معرّف المورد المؤهّل بالكامل للمورد الذي تم تغيير حالة التوافق له، بما في ذلك اسم المورد ونوع المورد. استخدم التنسيق، /subscriptions/<SubscriptionID>/resourceGroups/<ResourceGroup>/Microsoft.ApiManagement/service/<ServiceName>/<ResourceType>/<ResourceName> |
البرامج التعليمية والدروس المعرفية
| المسمى الوظيفي | الوصف |
|---|---|
| إرسال الأحداث من إدارة واجهة برمجة التطبيقات إلى شبكة الأحداث | كيفية الاشتراك في أحداث إدارة واجهة برمجة التطبيقات باستخدام شبكة الأحداث. |
الخطوات التالية
- للحصول على مقدمة حول Azure Event Grid، راجع ما المقصود بشبكة الأحداث؟
- لمزيد من المعلومات حول إنشاء اشتراك Azure Event Grid، راجع مخطط اشتراك شبكة الأحداث.