GatewayApi interface
GatewayApi-t képviselő felület.
Metódusok
| create |
Hozzáad egy API-t a megadott átjáróhoz. |
| delete(string, string, string, string, Gateway |
Törli a megadott API-t a megadott átjáróból. |
| get |
Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e az Átjáró entitással. |
| list |
Az átjáróhoz társított API-k gyűjteményét sorolja fel. |
Metódus adatai
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Hozzáad egy API-t a megadott átjáróhoz.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- gatewayId
-
string
Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték
- apiId
-
string
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
A beállítások paraméterei.
Válaszok
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Törli a megadott API-t a megadott átjáróból.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- gatewayId
-
string
Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték
- apiId
-
string
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
- options
- GatewayApiDeleteOptionalParams
A beállítások paraméterei.
Válaszok
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Ellenőrzi, hogy az azonosító által megadott API-entitás társítva van-e az Átjáró entitással.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- gatewayId
-
string
Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték
- apiId
-
string
API-azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
A beállítások paraméterei.
Válaszok
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Az átjáróhoz társított API-k gyűjteményét sorolja fel.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>
Paraméterek
- resourceGroupName
-
string
Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
- serviceName
-
string
Az API Management szolgáltatás neve.
- gatewayId
-
string
Átjáró entitásazonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. Nem lehet "felügyelt" érték
A beállítások paraméterei.