Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GatewayApi

Package version

Interface representing a GatewayApi.

Hierarchy

  • GatewayApi

Implemented by

Index

Methods

Methods

createOrUpdate

  • Adds an API to the specified Gateway.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: GatewayApiCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<GatewayApiCreateOrUpdateResponse>

delete

  • Deletes the specified API from the specified Gateway.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: GatewayApiDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

getEntityTag

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: GatewayApiGetEntityTagOptionalParams

      The options parameters.

    Returns Promise<GatewayApiGetEntityTagResponse>

listByService

  • Lists a collection of the APIs associated with a gateway.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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'

    • Optional options: GatewayApiListByServiceOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ApiContract>

Generated using TypeDoc