GatewayApi interface
Antarmuka yang mewakili GatewayApi.
Metode
| create |
Menambahkan API ke Gateway yang ditentukan. |
| delete(string, string, string, string, Gateway |
Menghapus API yang ditentukan dari Gateway yang ditentukan. |
| get |
Memeriksa apakah entitas API yang ditentukan oleh pengidentifikasi dikaitkan dengan entitas Gateway. |
| list |
Mencantumkan kumpulan API yang terkait dengan gateway. |
Detail Metode
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Menambahkan API ke Gateway yang ditentukan.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>
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'
- apiId
-
string
Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini.
Parameter opsi.
Mengembalikan
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Menghapus API yang ditentukan dari Gateway yang ditentukan.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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'
- apiId
-
string
Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini.
- options
- GatewayApiDeleteOptionalParams
Parameter opsi.
Mengembalikan
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Memeriksa apakah entitas API yang ditentukan oleh pengidentifikasi dikaitkan dengan entitas Gateway.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>
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'
- apiId
-
string
Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini.
Parameter opsi.
Mengembalikan
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Mencantumkan kumpulan API yang terkait dengan gateway.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>
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'
Parameter opsi.