ProductContract interface

الحزمة:

@azure/arm-apimanagement

تفاصيل المنتج.

يمتد

ProxyResource

الخصائص

approvalRequired	ما إذا كانت الموافقة على الاشتراك مطلوبة أم لا. إذا كانت خاطئة، فستتم الموافقة على الاشتراكات الجديدة تلقائيا لتمكين المطورين من استدعاء واجهات برمجة التطبيقات للمنتج مباشرة بعد الاشتراك. إذا كان صحيحا، يجب على المسؤولين الموافقة يدويا على الاشتراك قبل أن يتمكن المطور من أي من واجهات برمجة التطبيقات للمنتج. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.
description	وصف المنتج. قد تتضمن علامات تنسيق HTML.
displayName	اسم المنتج.
state	ما إذا كان المنتج منشورا أم لا. المنتجات المنشورة قابلة للاكتشاف من قبل مستخدمي مدخل المطور. المنتجات غير المنشورة مرئية فقط للمسؤولين. الحالة الافتراضية للمنتج غير منشورة.
subscriptionRequired	ما إذا كان اشتراك المنتج مطلوبا للوصول إلى واجهات برمجة التطبيقات المضمنة في هذا المنتج. إذا كان صحيحا، يشار إلى المنتج باسم "محمي" ومفتاح اشتراك صالح مطلوب لطلب واجهة برمجة تطبيقات مضمنة في المنتج للنجاح. إذا كان خطأ، يشار إلى المنتج باسم "فتح" ويمكن إجراء طلبات إلى واجهة برمجة تطبيقات مضمنة في المنتج دون مفتاح اشتراك. إذا تم حذف الخاصية عند إنشاء منتج جديد، افتراض أن القيمة صحيحة.
subscriptionsLimit	ما إذا كان عدد الاشتراكات التي يمكن أن يمتلكها المستخدم لهذا المنتج في نفس الوقت. اضبط على null أو احذف للسماح باشتراكات غير محدودة لكل مستخدم. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.
terms	شروط استخدام المنتج. سيتم تقديم المطورين الذين يحاولون الاشتراك في المنتج ويطلب منهم قبول هذه الشروط قبل أن يتمكنوا من إكمال عملية الاشتراك.

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

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

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

approvalRequired

ما إذا كانت الموافقة على الاشتراك مطلوبة أم لا. إذا كانت خاطئة، فستتم الموافقة على الاشتراكات الجديدة تلقائيا لتمكين المطورين من استدعاء واجهات برمجة التطبيقات للمنتج مباشرة بعد الاشتراك. إذا كان صحيحا، يجب على المسؤولين الموافقة يدويا على الاشتراك قبل أن يتمكن المطور من أي من واجهات برمجة التطبيقات للمنتج. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.

approvalRequired?: boolean

قيمة الخاصية

boolean

description

وصف المنتج. قد تتضمن علامات تنسيق HTML.

description?: string

قيمة الخاصية

string

displayName

اسم المنتج.

displayName?: string

قيمة الخاصية

string

state

ما إذا كان المنتج منشورا أم لا. المنتجات المنشورة قابلة للاكتشاف من قبل مستخدمي مدخل المطور. المنتجات غير المنشورة مرئية فقط للمسؤولين. الحالة الافتراضية للمنتج غير منشورة.

state?: ProductState

قيمة الخاصية

ProductState

subscriptionRequired

ما إذا كان اشتراك المنتج مطلوبا للوصول إلى واجهات برمجة التطبيقات المضمنة في هذا المنتج. إذا كان صحيحا، يشار إلى المنتج باسم "محمي" ومفتاح اشتراك صالح مطلوب لطلب واجهة برمجة تطبيقات مضمنة في المنتج للنجاح. إذا كان خطأ، يشار إلى المنتج باسم "فتح" ويمكن إجراء طلبات إلى واجهة برمجة تطبيقات مضمنة في المنتج دون مفتاح اشتراك. إذا تم حذف الخاصية عند إنشاء منتج جديد، افتراض أن القيمة صحيحة.

subscriptionRequired?: boolean

قيمة الخاصية

boolean

subscriptionsLimit

ما إذا كان عدد الاشتراكات التي يمكن أن يمتلكها المستخدم لهذا المنتج في نفس الوقت. اضبط على null أو احذف للسماح باشتراكات غير محدودة لكل مستخدم. يمكن أن تكون موجودة فقط إذا كانت الخاصية subscriptionRequired موجودة ولها قيمة خطأ.

subscriptionsLimit?: number

قيمة الخاصية

number

terms

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

terms?: 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