IdentityProvider interface

Paket:

@azure/arm-apimanagement

Antarmuka yang mewakili IdentityProvider.

Metode

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Membuat atau Memperbarui konfigurasi IdentityProvider.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Menghapus konfigurasi penyedia identitas yang ditentukan.
get(string, string, string, IdentityProviderGetOptionalParams)	Mendapatkan detail konfigurasi IdP yang dikonfigurasi dalam instans layanan tertentu.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Mendapatkan versi status entitas (Etag) dari identityProvider yang ditentukan oleh pengidentifikasinya.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Mencantumkan kumpulan Penyedia Identitas yang dikonfigurasi dalam instans layanan yang ditentukan.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Mendapatkan detail rahasia klien dari Penyedia Identitas.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Memperbarui konfigurasi IdentityProvider yang ada.

Detail Metode

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

Membuat atau Memperbarui konfigurasi IdentityProvider.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

parameters

IdentityProviderCreateContract

Buat parameter.

options

IdentityProviderCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<IdentityProviderCreateOrUpdateResponse>

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

Menghapus konfigurasi penyedia identitas yang ditentukan.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

options

IdentityProviderDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Mendapatkan detail konfigurasi IdP yang dikonfigurasi dalam instans layanan tertentu.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

options

IdentityProviderGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Mendapatkan versi status entitas (Etag) dari identityProvider yang ditentukan oleh pengidentifikasinya.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

options

IdentityProviderGetEntityTagOptionalParams

Parameter opsi.

Mengembalikan

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Mencantumkan kumpulan Penyedia Identitas yang dikonfigurasi dalam instans layanan yang ditentukan.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

options

IdentityProviderListByServiceOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Mendapatkan detail rahasia klien dari Penyedia Identitas.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

options

IdentityProviderListSecretsOptionalParams

Parameter opsi.

Mengembalikan

Promise<IdentityProviderListSecretsResponse>

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

Memperbarui konfigurasi IdentityProvider yang ada.

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

Parameter

resourceGroupName

string

Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.

serviceName

string

Nama layanan API Management.

identityProviderName

string

Pengidentifikasi Jenis Penyedia Identitas.

ifMatch

string

ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

parameters

IdentityProviderUpdateParameters

Perbarui parameter.

options

IdentityProviderUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<IdentityProviderUpdateResponse>