Gateway interface

Paket:

@azure/arm-apimanagement

Antarmuka yang mewakili Gateway.

Metode

createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)	Membuat atau memperbarui Gateway yang akan digunakan dalam instans Api Management.
delete(string, string, string, string, GatewayDeleteOptionalParams)	Menghapus Gateway tertentu.
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)	Mendapatkan Token Otorisasi Akses Bersama untuk gateway.
get(string, string, string, GatewayGetOptionalParams)	Mendapatkan detail Gateway yang ditentukan oleh pengidentifikasinya.
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)	Mendapatkan versi status entitas (Etag) gateway yang ditentukan oleh pengidentifikasinya.
invalidateDebugCredentials(string, string, string, GatewayInvalidateDebugCredentialsOptionalParams)	Tindakan membatalkan semua kredensial debug yang dikeluarkan untuk gateway.
listByService(string, string, GatewayListByServiceOptionalParams)	Mencantumkan kumpulan gateway yang terdaftar dengan instans layanan.
listDebugCredentials(string, string, string, GatewayListDebugCredentialsContract, GatewayListDebugCredentialsOptionalParams)	Buat kredensial debug baru untuk gateway.
listKeys(string, string, string, GatewayListKeysOptionalParams)	Mengambil kunci gateway.
listTrace(string, string, string, GatewayListTraceContract, GatewayListTraceOptionalParams)	Mengambil jejak yang dikumpulkan oleh gateway.
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)	Meregenerasi kunci gateway tertentu yang membatalkan token apa pun yang dibuat dengannya.
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)	Memperbarui detail gateway yang ditentukan oleh pengidentifikasinya.

Detail Metode

createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)

Membuat atau memperbarui Gateway yang akan digunakan dalam instans Api Management.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

parameters

GatewayContract

Detail gateway.

options

GatewayCreateOrUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayCreateOrUpdateResponse>

delete(string, string, string, string, GatewayDeleteOptionalParams)

Menghapus Gateway tertentu.

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

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

ifMatch

string

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

options

GatewayDeleteOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)

Mendapatkan Token Otorisasi Akses Bersama untuk gateway.

function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

parameters

GatewayTokenRequestContract

Properti kontrak permintaan token gateway.

options

GatewayGenerateTokenOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayTokenContract>

get(string, string, string, GatewayGetOptionalParams)

Mendapatkan detail Gateway yang ditentukan oleh pengidentifikasinya.

function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

options

GatewayGetOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayGetResponse>

getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

options

GatewayGetEntityTagOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayGetEntityTagHeaders>

invalidateDebugCredentials(string, string, string, GatewayInvalidateDebugCredentialsOptionalParams)

Tindakan membatalkan semua kredensial debug yang dikeluarkan untuk gateway.

function invalidateDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayInvalidateDebugCredentialsOptionalParams): Promise<void>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

options

GatewayInvalidateDebugCredentialsOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

listByService(string, string, GatewayListByServiceOptionalParams)

Mencantumkan kumpulan gateway yang terdaftar dengan instans layanan.

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

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

options

GatewayListByServiceOptionalParams

Parameter opsi.

Mengembalikan

PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>

listDebugCredentials(string, string, string, GatewayListDebugCredentialsContract, GatewayListDebugCredentialsOptionalParams)

Buat kredensial debug baru untuk gateway.

function listDebugCredentials(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListDebugCredentialsContract, options?: GatewayListDebugCredentialsOptionalParams): Promise<GatewayDebugCredentialsContract>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

parameters

GatewayListDebugCredentialsContract

Mencantumkan properti kredensial debug.

options

GatewayListDebugCredentialsOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayDebugCredentialsContract>

listKeys(string, string, string, GatewayListKeysOptionalParams)

Mengambil kunci gateway.

function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

options

GatewayListKeysOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayListKeysResponse>

listTrace(string, string, string, GatewayListTraceContract, GatewayListTraceOptionalParams)

Mengambil jejak yang dikumpulkan oleh gateway.

function listTrace(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayListTraceContract, options?: GatewayListTraceOptionalParams): Promise<GatewayListTraceResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

parameters

GatewayListTraceContract

Mencantumkan properti pelacakan.

options

GatewayListTraceOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayListTraceResponse>

regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)

Meregenerasi kunci gateway tertentu yang membatalkan token apa pun yang dibuat dengannya.

function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

parameters

GatewayKeyRegenerationRequestContract

Properti kontrak permintaan regenerasi kunci gateway.

options

GatewayRegenerateKeyOptionalParams

Parameter opsi.

Mengembalikan

Promise<void>

update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)

Memperbarui detail gateway yang ditentukan oleh pengidentifikasinya.

function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>

Parameter

resourceGroupName

string

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

serviceName

string

Nama layanan API Management.

gatewayId

string

Pengidentifikasi entitas gateway. Harus unik dalam instans layanan API Management saat ini. Tidak boleh memiliki nilai 'terkelola'

ifMatch

string

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

parameters

GatewayContract

Detail gateway.

options

GatewayUpdateOptionalParams

Parameter opsi.

Mengembalikan

Promise<GatewayUpdateResponse>