إشعار
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تسجيل الدخول أو تغيير الدلائل.
يتطلب الوصول إلى هذه الصفحة تخويلاً. يمكنك محاولة تغيير الدلائل.
توفر هذه المقالة معلومات أساسية حول بيانات التعريف وكيفية استخدامها لإدارة واجهة برمجة التطبيقات في مركز واجهة برمجة تطبيقات Azure. يمكنك تحديد بيانات التعريف وتعيينها لتنظيم واجهات برمجة التطبيقات والكيانات الأخرى وتصفيتها في مركز واجهة برمجة التطبيقات الخاص بك. يمكن تضمين بيانات التعريف أوتخصيصها، ويمكنك تطوير مخطط بيانات التعريف لفرض الاتساق عبر واجهات برمجة التطبيقات والبيئات وعمليات النشر.
البيانات الوصفية المضمنة
عند إنشاء واجهات برمجة التطبيقات والبيئات وعمليات النشر أو تحديثها في مركز واجهة برمجة التطبيقات الخاص بك، يمكنك تعيين خصائص بيانات تعريف مضمنة معينة، مثل نوع واجهة برمجة التطبيقات (REST وWSDL وما إلى ذلك).
تسرد الجداول التالية بيانات التعريف المضمنة المتوفرة لكيانات مركز واجهة برمجة تطبيقات Azure. للحصول على التفاصيل، راجع مرجع واجهة برمجة تطبيقات REST لمركز واجهة برمجة التطبيقات. لا تتضمن الجداول خصائص Azure القياسية مثل معرفات الموارد أو عناوين العرض أو الأوصاف. ليست كل العقارات مطلوبة.
واجهات برمجة التطبيقات
| بيانات التعريف | وصف | قيم الأمثلة |
|---|---|---|
| نوع | نوع (نوع) واجهة برمجة التطبيقات | REST ، صابون ، GraphQL |
| مرحلة دورة الحياة | مرحلة دورة حياة تطوير واجهة برمجة التطبيقات | التصميم والتطوير |
| ترخيص | معلومات الترخيص لواجهة برمجة التطبيقات | معرف SPDX، رابط إلى نص الترخيص |
| الوثائق الخارجية | موقع للوثائق الخارجية لواجهة برمجة التطبيقات | عنوان URL يشير إلى الوثائق |
| معلومات الاتصال | نقاط الاتصال لواجهة برمجة التطبيقات | عنوان البريد الإلكتروني والاسم وعنوان URL |
| شروط الخدمة | شروط الخدمة لواجهة برمجة التطبيقات | عنوان URL يشير إلى شروط الخدمة |
البيئات
| بيانات التعريف | وصف | قيم الأمثلة |
|---|---|---|
| نوع | نوع (نوع) البيئة | الإنتاج والتدريج والتطوير |
| server | معلومات الخادم للبيئة | النوع وعنوان URL الذي يشير إلى خادم البيئة |
| نوع الخادم | نوع خادم البيئة | خادم إدارة واجهة برمجة التطبيقات، خادم Kubernetes، خادم Apigee |
| الإعداد | معلومات الإعداد للبيئة | التعليمات وعنوان URL الذي يشير إلى مدخل مطور البيئة |
عمليات النشر
| بيانات التعريف | وصف | قيم الأمثلة |
|---|---|---|
| server | معلومات الخادم الخاصة بالنشر | عنوان URL الذي يشير إلى خادم التوزيع |
| حالة | حالة النشر | نشط وغير نشط |
بيانات التعريف المخصصة
حدد بيانات التعريف المخصصة باستخدام مدخل Microsoft Azure أو واجهة برمجة تطبيقات REST لمركز واجهة برمجة تطبيقات Azure أو Azure CLI للمساعدة في تنظيم واجهات برمجة التطبيقات والبيئات وعمليات التوزيع وتصفيتها في مركز واجهة برمجة التطبيقات الخاص بك. يدعم مركز واجهة برمجة تطبيقات Azure بيانات التعريف المخصصة من الأنواع التالية.
| Type | وصف | مثال على الاسم |
|---|---|---|
| boolean | صواب أم خطأ | داخلي |
| number | القيمة الرقمية | سنةالإنشاء |
| خيط | قيمة النص | مستودع GitHub |
| صفيف | قائمة القيم | العلامات |
| اختيار مدمج | قائمة خيارات مضمنة | Department |
| object | كائن معقد يتكون من أنواع متعددة | APIApprover |
مهم
لا تقم بتضمين أي معلومات حساسة أو سرية أو شخصية في عناوين (أسماء) البيانات الوصفية التي تحددها. تظهر هذه العناوين في سجلات المراقبة التي تستخدمها Microsoft لتحسين وظائف الخدمة. ومع ذلك، فإن تفاصيل وقيم بيانات التعريف الأخرى هي بيانات العملاء المحمية.
تعيين بيانات التعريف للكيانات
يمكن تعيين خصائص بيانات التعريف المخصصة لواجهات برمجة التطبيقات أو البيئات أو عمليات النشر في مركز واجهة برمجة التطبيقات الخاص بك. على سبيل المثال، يمكنك تحديد بيانات تعريف القسم وتعيينها إلى واجهات برمجة التطبيقات، بحيث يتم تحديد القسم المسؤول عن واجهة برمجة التطبيقات عند تسجيل واجهة برمجة التطبيقات أو إضافة إصدار جديد لواجهة برمجة التطبيقات.
إذا تم تعيينها لكيان، فإن بيانات التعريف إما اختيارية أو مطلوبة. على سبيل المثال، قد تطلب تعيين بيانات تعريف القسم لواجهات برمجة التطبيقات فقط، ولكن السماح ل YearOfCreation بأن تكون بيانات تعريف اختيارية للبيئات.
إشعار
- حدد بيانات التعريف المخصصة في أي وقت وقم بتطبيقها على واجهات برمجة التطبيقات والكيانات الأخرى في مركز واجهة برمجة التطبيقات الخاص بك.
- بعد تحديد بيانات التعريف المخصصة، يمكنك تغيير تعيينها إلى كيان، على سبيل المثال من مطلوب إلى اختياري لواجهات برمجة التطبيقات.
- يمكنك تغيير قيم بيانات التعريف، ولكن لا يمكنك حذف أو تغيير نوع بيانات التعريف المخصصة التي تم تعيينها حاليا في واجهات برمجة التطبيقات والبيئات وعمليات النشر. قم بإلغاء تعيين بيانات التعريف المخصصة من الكيانات أولا، ثم يمكنك حذفها أو تغييرها.
استخدام بيانات التعريف للحوكمة
استخدم بيانات التعريف المضمنة والمخصصة لتنظيم واجهات برمجة التطبيقات والبيئات وعمليات النشر في مركز واجهة برمجة التطبيقات الخاص بك. على سبيل المثال:
فرض معايير الحوكمة في مؤسستك من خلال طلب تعيين بيانات تعريف معينة لواجهات برمجة التطبيقات والبيئات وعمليات النشر.
ابحث عن واجهات برمجة التطبيقات وتصفيتها في مركز واجهة برمجة التطبيقات حسب قيم البيانات الوصفية. يمكنك التصفية مباشرة على صفحة واجهات برمجة التطبيقات في مدخل Microsoft Azure، أو استخدام واجهة برمجة تطبيقات REST Center Azure أو Azure CLI للاستعلام عن واجهات برمجة التطبيقات استنادا إلى قيم بيانات تعريف معينة.
