SubscriptionCreateParameters interface
تفاصيل إنشاء الاشتراك.
الخصائص
| allow |
تحديد ما إذا كان يمكن تمكين التتبع |
| display |
اسم الاشتراك. |
| owner |
المستخدم (مسار معرف المستخدم) الذي يتم إنشاء الاشتراك له في النموذج /users/{userId} |
| primary |
مفتاح الاشتراك الأساسي. إذا لم يتم تحديده أثناء مفتاح الطلب سيتم إنشاؤه تلقائيا. |
| scope | نطاق مثل /products/{productId} أو /apis أو /apis/{apiId}. |
| secondary |
مفتاح الاشتراك الثانوي. إذا لم يتم تحديده أثناء مفتاح الطلب سيتم إنشاؤه تلقائيا. |
| state | حالة الاشتراك الأولي. إذا لم يتم تحديد أي قيمة، يتم إنشاء الاشتراك بالحالة المرسلة. الحالات المحتملة * نشطة – الاشتراك نشط، * معلق – تم حظر الاشتراك، ولا يمكن للمشترك الاتصال بأي واجهات برمجة تطبيقات للمنتج، * تم إرساله – تم تقديم طلب الاشتراك من قبل المطور، ولكن لم تتم الموافقة عليه أو رفضه بعد، * تم رفضه – تم رفض طلب الاشتراك من قبل مسؤول، * تم إلغاؤه – تم إلغاء الاشتراك من قبل المطور أو المسؤول، * منتهية الصلاحية – وصل الاشتراك إلى تاريخ انتهاء صلاحيته وتم إلغاء تنشيطه. |
تفاصيل الخاصية
allowTracing
تحديد ما إذا كان يمكن تمكين التتبع
allowTracing?: boolean
قيمة الخاصية
boolean
displayName
اسم الاشتراك.
displayName?: string
قيمة الخاصية
string
ownerId
المستخدم (مسار معرف المستخدم) الذي يتم إنشاء الاشتراك له في النموذج /users/{userId}
ownerId?: string
قيمة الخاصية
string
primaryKey
مفتاح الاشتراك الأساسي. إذا لم يتم تحديده أثناء مفتاح الطلب سيتم إنشاؤه تلقائيا.
primaryKey?: string
قيمة الخاصية
string
scope
نطاق مثل /products/{productId} أو /apis أو /apis/{apiId}.
scope?: string
قيمة الخاصية
string
secondaryKey
مفتاح الاشتراك الثانوي. إذا لم يتم تحديده أثناء مفتاح الطلب سيتم إنشاؤه تلقائيا.
secondaryKey?: string
قيمة الخاصية
string
state
حالة الاشتراك الأولي. إذا لم يتم تحديد أي قيمة، يتم إنشاء الاشتراك بالحالة المرسلة. الحالات المحتملة * نشطة – الاشتراك نشط، * معلق – تم حظر الاشتراك، ولا يمكن للمشترك الاتصال بأي واجهات برمجة تطبيقات للمنتج، * تم إرساله – تم تقديم طلب الاشتراك من قبل المطور، ولكن لم تتم الموافقة عليه أو رفضه بعد، * تم رفضه – تم رفض طلب الاشتراك من قبل مسؤول، * تم إلغاؤه – تم إلغاء الاشتراك من قبل المطور أو المسؤول، * منتهية الصلاحية – وصل الاشتراك إلى تاريخ انتهاء صلاحيته وتم إلغاء تنشيطه.
state?: SubscriptionState