WorkspaceSubscription interface
واجهة تمثل WorkspaceSubscription.
الأساليب
تفاصيل الأسلوب
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
إنشاء اشتراك مستخدم محدد أو تحديثه إلى المنتج المحدد.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- parameters
- SubscriptionCreateParameters
إنشاء معلمات.
معلمات الخيارات.
المرتجعات
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
حذف الاشتراك المحدد.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
يحصل على كيان الاشتراك المحدد.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
يحصل على إصدار حالة الكيان (Etag) من اشتراك apimanagement المحدد بواسطة المعرف الخاص به.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
يسرد جميع اشتراكات مساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
معلمات الخيارات.
المرتجعات
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
الحصول على مفاتيح الاشتراك المحددة.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
يعيد إنشاء المفتاح الأساسي للاشتراك الحالي لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
يعيد إنشاء المفتاح الثانوي للاشتراك الحالي لمساحة العمل في مثيل خدمة إدارة واجهة برمجة التطبيقات.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<void>
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
تحديث تفاصيل الاشتراك المحدد بواسطة معرفه.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>
المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- workspaceId
-
string
معرف مساحة العمل. يجب أن يكون فريدا في مثيل خدمة APIM الحالي.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- SubscriptionUpdateParameters
تحديث المعلمات.
معلمات الخيارات.
المرتجعات
Promise<WorkspaceSubscriptionUpdateResponse>