ApiEntityBaseContract interface

الحزمة:

@azure/arm-apimanagement

تفاصيل العقد الأساسي لواجهة برمجة التطبيقات.

الخصائص

apiRevision	يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير أي قيمة، يتم إنشاء المراجعة الافتراضية 1
apiRevisionDescription	وصف مراجعة واجهة برمجة التطبيقات.
apiType	نوع واجهة برمجة التطبيقات.
apiVersion	يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات
apiVersionDescription	وصف إصدار واجهة برمجة التطبيقات.
apiVersionSetId	معرف مورد ل ApiVersionSet ذات الصلة.
authenticationSettings	مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه.
contact	معلومات الاتصال لواجهة برمجة التطبيقات.
description	وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML.
isCurrent	يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية.
isOnline	يشير إلى ما إذا كان يمكن الوصول إلى مراجعة واجهة برمجة التطبيقات عبر البوابة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
license	معلومات الترخيص لواجهة برمجة التطبيقات.
subscriptionKeyParameterNames	البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها.
subscriptionRequired	تحديد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات.
termsOfServiceUrl	عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL.

تفاصيل الخاصية

apiRevision

يصف مراجعة واجهة برمجة التطبيقات. إذا لم يتم توفير أي قيمة، يتم إنشاء المراجعة الافتراضية 1

apiRevision?: string

قيمة الخاصية

string

apiRevisionDescription

وصف مراجعة واجهة برمجة التطبيقات.

apiRevisionDescription?: string

قيمة الخاصية

string

apiType

نوع واجهة برمجة التطبيقات.

apiType?: string

قيمة الخاصية

string

apiVersion

يشير إلى معرف إصدار واجهة برمجة التطبيقات إذا تم إصدار واجهة برمجة التطبيقات

apiVersion?: string

قيمة الخاصية

string

apiVersionDescription

وصف إصدار واجهة برمجة التطبيقات.

apiVersionDescription?: string

قيمة الخاصية

string

apiVersionSetId

معرف مورد ل ApiVersionSet ذات الصلة.

apiVersionSetId?: string

قيمة الخاصية

string

authenticationSettings

مجموعة من إعدادات المصادقة المضمنة في واجهة برمجة التطبيقات هذه.

authenticationSettings?: AuthenticationSettingsContract

قيمة الخاصية

AuthenticationSettingsContract

contact

معلومات الاتصال لواجهة برمجة التطبيقات.

contact?: ApiContactInformation

قيمة الخاصية

ApiContactInformation

description

وصف واجهة برمجة التطبيقات. قد تتضمن علامات تنسيق HTML.

description?: string

قيمة الخاصية

string

isCurrent

يشير إلى ما إذا كانت مراجعة واجهة برمجة التطبيقات هي مراجعة واجهة برمجة التطبيقات الحالية.

isCurrent?: boolean

قيمة الخاصية

boolean

isOnline

يشير إلى ما إذا كان يمكن الوصول إلى مراجعة واجهة برمجة التطبيقات عبر البوابة. ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

isOnline?: boolean

قيمة الخاصية

boolean

license

معلومات الترخيص لواجهة برمجة التطبيقات.

license?: ApiLicenseInformation

قيمة الخاصية

ApiLicenseInformation

subscriptionKeyParameterNames

البروتوكولات التي يتم توفير واجهة برمجة التطبيقات عليها.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

قيمة الخاصية

SubscriptionKeyParameterNamesContract

subscriptionRequired

تحديد ما إذا كان اشتراك API أو Product مطلوبا للوصول إلى واجهة برمجة التطبيقات.

subscriptionRequired?: boolean

قيمة الخاصية

boolean

termsOfServiceUrl

عنوان URL لشروط الخدمة لواجهة برمجة التطبيقات. يجب أن يكون بتنسيق عنوان URL.

termsOfServiceUrl?: string

قيمة الخاصية

string