ApiContract interface

الحزمة:

@azure/arm-apimanagement

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

يمتد

ProxyResource

الخصائص

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

الخصائص الموروثة

id	معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
name	اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.
type	نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

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

apiRevision

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

apiRevision?: string

قيمة الخاصية

string

apiRevisionDescription

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

apiRevisionDescription?: string

قيمة الخاصية

string

apiType

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

apiType?: string

قيمة الخاصية

string

apiVersion

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

apiVersion?: string

قيمة الخاصية

string

apiVersionDescription

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

apiVersionDescription?: string

قيمة الخاصية

string

apiVersionSet

تفاصيل مجموعة الإصدارات

apiVersionSet?: ApiVersionSetContractDetails

قيمة الخاصية

ApiVersionSetContractDetails

apiVersionSetId

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

apiVersionSetId?: string

قيمة الخاصية

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

قيمة الخاصية

AuthenticationSettingsContract

contact

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

contact?: ApiContactInformation

قيمة الخاصية

ApiContactInformation

description

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

description?: string

قيمة الخاصية

string

displayName

اسم واجهة برمجة التطبيقات. يجب أن يكون طوله من 1 إلى 300 حرف.

displayName?: string

قيمة الخاصية

string

isCurrent

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

isCurrent?: boolean

قيمة الخاصية

boolean

isOnline

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

isOnline?: boolean

قيمة الخاصية

boolean

license

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

license?: ApiLicenseInformation

قيمة الخاصية

ApiLicenseInformation

path

يحدد URL النسبي بشكل فريد واجهة برمجة التطبيقات هذه وجميع مسارات الموارد الخاصة بها داخل مثيل خدمة APIM. يتم إلحاقه بعنوان URL الأساسي لنقطة نهاية API المحدد أثناء إنشاء مثيل الخدمة لتشكيل عنوان URL عام لواجهة برمجة التطبيقات هذه.

path?: string

قيمة الخاصية

string

protocols

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

protocols?: string[]

قيمة الخاصية

string[]

serviceUrl

عنوان URL المطلق لخدمة الواجهة الخلفية التي تنفذ واجهة برمجة التطبيقات هذه. لا يمكن أن يزيد طوله عن 2000 حرف.

serviceUrl?: string

قيمة الخاصية

string

sourceApiId

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

sourceApiId?: string

قيمة الخاصية

string

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

قيمة الخاصية

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

قيمة الخاصية

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

id

معرف المورد المؤهل بالكامل للمورد. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} ملاحظة: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

id?: string

قيمة الخاصية

string

موروث منProxyResource.id

name

اسم المورد NOTE: لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

name?: string

قيمة الخاصية

string

موروث منProxyResource.name

type

نوع المورد. على سبيل المثال، ملاحظة "Microsoft.Compute/virtualMachines" أو "Microsoft.Storage/storageAccounts": لن يتم تسلسل هذه الخاصية. لا يمكن ملؤها إلا بواسطة الخادم.

type?: string

قيمة الخاصية

string

موروث منProxyResource.type