GatewayApi interface
Rozhraní představující rozhraní GatewayApi.
Metody
create |
Přidá rozhraní API do zadané brány. |
delete(string, string, string, string, Gateway |
Odstraní zadané rozhraní API ze zadané brány. |
get |
Zkontroluje, jestli je entita rozhraní API určená identifikátorem přidružená k entitě brány. |
list |
Vypíše kolekci rozhraní API přidruženou k bráně. |
Podrobnosti metody
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Přidá rozhraní API do zadané brány.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- gatewayId
-
string
Identifikátor entity brány. Musí být jedinečný v aktuální instanci služby Gestione API. Nesmí mít hodnotu managed.
- apiId
-
string
Identifikátor rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API.
Parametry možností.
Návraty
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Odstraní zadané rozhraní API ze zadané brány.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- gatewayId
-
string
Identifikátor entity brány. Musí být jedinečný v aktuální instanci služby Gestione API. Nesmí mít hodnotu managed.
- apiId
-
string
Identifikátor rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API.
- options
- GatewayApiDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Zkontroluje, jestli je entita rozhraní API určená identifikátorem přidružená k entitě brány.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- gatewayId
-
string
Identifikátor entity brány. Musí být jedinečný v aktuální instanci služby Gestione API. Nesmí mít hodnotu managed.
- apiId
-
string
Identifikátor rozhraní API. Musí být jedinečný v aktuální instanci služby Gestione API.
Parametry možností.
Návraty
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Vypíše kolekci rozhraní API přidruženou k bráně.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>
Parametry
- resourceGroupName
-
string
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
- serviceName
-
string
Název služby Gestione API.
- gatewayId
-
string
Identifikátor entity brány. Musí být jedinečný v aktuální instanci služby Gestione API. Nesmí mít hodnotu managed.
Parametry možností.