BackendImpl | @azure/arm-apimanagement

Class containing Backend operations.

Hierarchy

BackendImpl

Implements

Backend

Index

Constructors

constructor

Methods

Constructors

constructor

new BackendImpl(client: ApiManagementClientContext): BackendImpl

- Defined in operations/backend.ts:37
Initialize a new instance of the class Backend class.

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

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>

Implementation of Backend.createOrUpdate
- Defined in operations/backend.ts:184
Creates or Updates a backend.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- parameters: BackendContract
  
  Create parameters.
- Optional options: BackendCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<BackendCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>

Implementation of Backend.delete
- Defined in operations/backend.ts:239
Deletes the specified backend.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- Optional options: BackendDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>

Implementation of Backend.get
- Defined in operations/backend.ts:163
Gets the details of the backend specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Optional options: BackendGetOptionalParams
  
  The options parameters.
Returns Promise<BackendGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagResponse>

Implementation of Backend.getEntityTag
- Defined in operations/backend.ts:143
Gets the entity state (Etag) version of the backend specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Optional options: BackendGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<BackendGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract>

Implementation of Backend.listByService
- Defined in operations/backend.ts:53
Lists a collection of backends in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: BackendListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<BackendContract>

reconnect

reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>

Implementation of Backend.reconnect
- Defined in operations/backend.ts:261
Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- Optional options: BackendReconnectOptionalParams
  
  The options parameters.
Returns Promise<void>

update

update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>

Implementation of Backend.update
- Defined in operations/backend.ts:208
Updates an existing backend.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- backendId: string
  
  Identifier of the Backend entity. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters: BackendUpdateParameters
  
  Update parameters.
- Optional options: BackendUpdateOptionalParams
  
  The options parameters.
Returns Promise<BackendUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns BackendImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

backendId: string

parameters: BackendContract

Optional options: BackendCreateOrUpdateOptionalParams

Returns Promise<BackendCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

backendId: string

ifMatch: string

Optional options: BackendDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

backendId: string

Optional options: BackendGetOptionalParams

Returns Promise<BackendGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

backendId: string

Optional options: BackendGetEntityTagOptionalParams

Returns Promise<BackendGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: BackendListByServiceOptionalParams

Returns PagedAsyncIterableIterator<BackendContract>

reconnect

Parameters

resourceGroupName: string

serviceName: string

backendId: string

Optional options: BackendReconnectOptionalParams

Returns Promise<void>

update

Parameters

resourceGroupName: string

serviceName: string

backendId: string

ifMatch: string

parameters: BackendUpdateParameters

Optional options: BackendUpdateOptionalParams

Returns Promise<BackendUpdateResponse>