IdentityProvider interface

الحزمة:

@azure/arm-apimanagement

واجهة تمثل IdentityProvider.

الأساليب

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	إنشاء تكوين IdentityProvider أو تحديثه.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	حذف تكوين موفر الهوية المحدد.
get(string, string, string, IdentityProviderGetOptionalParams)	يحصل على تفاصيل التكوين لموفر الهوية الذي تم تكوينه في مثيل خدمة محدد.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	يحصل على إصدار حالة الكيان (Etag) من identityProvider المحدد بواسطة المعرف الخاص به.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	يسرد مجموعة من موفر الهوية الذي تم تكوينه في مثيل الخدمة المحدد.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	يحصل على تفاصيل سر العميل لموفر الهوية.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	تحديث تكوين IdentityProvider موجود.

تفاصيل الأسلوب

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

إنشاء تكوين IdentityProvider أو تحديثه.

function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

parameters

IdentityProviderCreateContract

إنشاء معلمات.

options

IdentityProviderCreateOrUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<IdentityProviderCreateOrUpdateResponse>

delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

حذف تكوين موفر الهوية المحدد.

function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

ifMatch

string

ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.

options

IdentityProviderDeleteOptionalParams

معلمات الخيارات.

المرتجعات

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

يحصل على تفاصيل التكوين لموفر الهوية الذي تم تكوينه في مثيل خدمة محدد.

function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

options

IdentityProviderGetOptionalParams

معلمات الخيارات.

المرتجعات

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

يحصل على إصدار حالة الكيان (Etag) من identityProvider المحدد بواسطة المعرف الخاص به.

function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

options

IdentityProviderGetEntityTagOptionalParams

معلمات الخيارات.

المرتجعات

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

يسرد مجموعة من موفر الهوية الذي تم تكوينه في مثيل الخدمة المحدد.

function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

options

IdentityProviderListByServiceOptionalParams

معلمات الخيارات.

المرتجعات

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

يحصل على تفاصيل سر العميل لموفر الهوية.

function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

options

IdentityProviderListSecretsOptionalParams

معلمات الخيارات.

المرتجعات

Promise<IdentityProviderListSecretsResponse>

update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

تحديث تكوين IdentityProvider موجود.

function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>

المعلمات

resourceGroupName

string

اسم مجموعة الموارد. الاسم غير حساس لحالة الأحرف.

serviceName

string

اسم خدمة APIM.

identityProviderName

string

معرف نوع موفر الهوية.

ifMatch

string

ETag للكيان. يجب أن يتطابق ETag مع حالة الكيان الحالية من استجابة العنوان لطلب GET أو يجب أن يكون * للتحديث غير المشروط.

parameters

IdentityProviderUpdateParameters

تحديث المعلمات.

options

IdentityProviderUpdateOptionalParams

معلمات الخيارات.

المرتجعات

Promise<IdentityProviderUpdateResponse>