GatewayApi interface
Gränssnitt som representerar en GatewayApi.
Metoder
| create |
Lägger till ett API i den angivna gatewayen. |
| delete(string, string, string, string, Gateway |
Tar bort det angivna API:et från den angivna gatewayen. |
| get |
Kontrollerar att API-entiteten som anges av identifieraren är associerad med gatewayentiteten. |
| list |
Visar en samling api:er som är associerade med en gateway. |
Metodinformation
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Lägger till ett API i den angivna gatewayen.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- gatewayId
-
string
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Tar bort det angivna API:et från den angivna gatewayen.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- gatewayId
-
string
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
- options
- GatewayApiDeleteOptionalParams
Alternativparametrarna.
Returer
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Kontrollerar att API-entiteten som anges av identifieraren är associerad med gatewayentiteten.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- gatewayId
-
string
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"
- apiId
-
string
API-identifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
Alternativparametrarna.
Returer
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Visar en samling api:er som är associerade med en gateway.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
- serviceName
-
string
Namnet på API Management-tjänsten.
- gatewayId
-
string
Gatewayentitetsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Får inte ha värdet "hanterat"
Alternativparametrarna.