GatewayApiImpl | @azure/arm-apimanagement

Class containing GatewayApi operations.

Hierarchy

GatewayApiImpl

Implements

GatewayApi

Index

Constructors

constructor

Methods

Constructors

constructor

new GatewayApiImpl(client: ApiManagementClientContext): GatewayApiImpl

- Defined in operations/gatewayApi.ts:31
Initialize a new instance of the class GatewayApi class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns GatewayApiImpl

Methods

createOrUpdate

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

Implementation of GatewayApi.createOrUpdate
- Defined in operations/gatewayApi.ts:173
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

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

Implementation of GatewayApi.delete
- Defined in operations/gatewayApi.ts:195
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

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

Implementation of GatewayApi.getEntityTag
- Defined in operations/gatewayApi.ts:151
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

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

Implementation of GatewayApi.listByService
- Defined in operations/gatewayApi.ts:49
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>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns GatewayApiImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

apiId: string

Optional options: GatewayApiCreateOrUpdateOptionalParams

Returns Promise<GatewayApiCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

apiId: string

Optional options: GatewayApiDeleteOptionalParams

Returns Promise<void>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

apiId: string

Optional options: GatewayApiGetEntityTagOptionalParams

Returns Promise<GatewayApiGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

gatewayId: string

Optional options: GatewayApiListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ApiContract>