Subscription interface
واجهة تمثل اشتراكا.
الأساليب
تفاصيل الأسلوب
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
إنشاء اشتراك مستخدم محدد أو تحديثه إلى المنتج المحدد.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- parameters
- SubscriptionCreateParameters
إنشاء معلمات.
معلمات الخيارات.
المرتجعات
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
حذف الاشتراك المحدد.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- options
- SubscriptionDeleteOptionalParams
معلمات الخيارات.
المرتجعات
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
يحصل على كيان الاشتراك المحدد.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- options
- SubscriptionGetOptionalParams
معلمات الخيارات.
المرتجعات
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
يحصل على إصدار حالة الكيان (Etag) من اشتراك apimanagement المحدد بواسطة المعرف الخاص به.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
يسرد جميع اشتراكات مثيل خدمة APIM.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- options
- SubscriptionListOptionalParams
معلمات الخيارات.
المرتجعات
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
الحصول على مفاتيح الاشتراك المحددة.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
إعادة إنشاء المفتاح الأساسي للاشتراك الحالي لمثيل خدمة APIM.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
إعادة إنشاء المفتاح الثانوي للاشتراك الحالي لمثيل خدمة APIM.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
معلمات الخيارات.
المرتجعات
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
تحديث تفاصيل الاشتراك المحدد بواسطة معرفه.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>المعلمات
- resourceGroupName
-
string
اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.
- serviceName
-
string
اسم خدمة APIM.
- sid
-
string
معرف كيان الاشتراك. يمثل الكيان الاقتران بين مستخدم ومنتج في APIM.
- ifMatch
-
string
ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.
- parameters
- SubscriptionUpdateParameters
تحديث المعلمات.
- options
- SubscriptionUpdateOptionalParams
معلمات الخيارات.
المرتجعات
Promise<SubscriptionUpdateResponse>