SubscriptionUpdateParameters interface
تفاصيل تحديث الاشتراك.
الخصائص
| allow |
تحديد ما إذا كان يمكن تمكين التتبع |
| display |
اسم الاشتراك. |
| expiration |
تاريخ انتهاء صلاحية الاشتراك. الإعداد مخصص لأغراض التدقيق فقط ولا تنتهي صلاحية الاشتراك تلقائيا. يمكن إدارة دورة حياة الاشتراك باستخدام خاصية |
| owner |
مسار معرف المستخدم: /users/{userId} |
| primary |
مفتاح الاشتراك الأساسي. |
| scope | نطاق مثل /products/{productId} أو /apis أو /apis/{apiId} |
| secondary |
مفتاح الاشتراك الثانوي. |
| state | حالة الاشتراك. الحالات المحتملة * نشطة – الاشتراك نشط، * معلق – تم حظر الاشتراك، ولا يمكن للمشترك الاتصال بأي واجهات برمجة تطبيقات للمنتج، * تم إرساله – تم تقديم طلب الاشتراك من قبل المطور، ولكن لم تتم الموافقة عليه أو رفضه بعد، * تم رفضه – تم رفض طلب الاشتراك من قبل مسؤول، * تم إلغاؤه – تم إلغاء الاشتراك من قبل المطور أو المسؤول، * منتهية الصلاحية – وصل الاشتراك إلى تاريخ انتهاء صلاحيته وتم إلغاء تنشيطه. |
| state |
التعليقات التي تصف تغيير حالة الاشتراك من قبل المسؤول عند تغيير الحالة إلى "مرفوض". |
تفاصيل الخاصية
allowTracing
تحديد ما إذا كان يمكن تمكين التتبع
allowTracing?: boolean
قيمة الخاصية
boolean
displayName
اسم الاشتراك.
displayName?: string
قيمة الخاصية
string
expirationDate
تاريخ انتهاء صلاحية الاشتراك. الإعداد مخصص لأغراض التدقيق فقط ولا تنتهي صلاحية الاشتراك تلقائيا. يمكن إدارة دورة حياة الاشتراك باستخدام خاصية state. يتوافق التاريخ مع التنسيق التالي: yyyy-MM-ddTHH:mm:ssZ كما هو محدد بواسطة معيار ISO 8601.
expirationDate?: Date
قيمة الخاصية
Date
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
قيمة الخاصية
stateComment
التعليقات التي تصف تغيير حالة الاشتراك من قبل المسؤول عند تغيير الحالة إلى "مرفوض".
stateComment?: string
قيمة الخاصية
string