GatewayApi interface

Package:

@azure/arm-apimanagement

Interface representing a GatewayApi.

Methods

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)	Adds an API to the specified Gateway.
delete(string, string, string, string, GatewayApiDeleteOptionalParams)	Deletes the specified API from the specified Gateway.
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)	Checks that API entity specified by identifier is associated with the Gateway entity.
listByService(string, string, string, GatewayApiListByServiceOptionalParams)	Lists a collection of the APIs associated with a gateway.

Method Details

createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)

Adds an API to the specified Gateway.

function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

gatewayId

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

apiId

string

API identifier. Must be unique in the current API Management service instance.

options

GatewayApiCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiContract>

delete(string, string, string, string, GatewayApiDeleteOptionalParams)

Deletes the specified API from the specified Gateway.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

gatewayId

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

apiId

string

API identifier. Must be unique in the current API Management service instance.

options

GatewayApiDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)

Checks that API entity specified by identifier is associated with the Gateway entity.

function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

gatewayId

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

apiId

string

API identifier. Must be unique in the current API Management service instance.

options

GatewayApiGetEntityTagOptionalParams

The options parameters.

Returns

Promise<GatewayApiGetEntityTagHeaders>

listByService(string, string, string, GatewayApiListByServiceOptionalParams)

Lists a collection of the APIs associated with a gateway.

function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

gatewayId

string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

options

GatewayApiListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>