Backend interface
Interface representing a Backend.
Methods
| create |
Creates or Updates a backend. |
| delete(string, string, string, string, Backend |
Deletes the specified backend. |
| get(string, string, string, Backend |
Gets the details of the backend specified by its identifier. |
| get |
Gets the entity state (Etag) version of the backend specified by its identifier. |
| list |
Lists a collection of backends in the specified service instance. |
| reconnect(string, string, string, Backend |
Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used. |
| update(string, string, string, string, Backend |
Updates an existing backend. |
Method Details
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Creates or Updates a backend.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Deletes the specified backend.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): 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.
- 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.
- options
- BackendDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Gets the details of the backend specified by its identifier.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- BackendGetOptionalParams
The options parameters.
Returns
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the backend specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Lists a collection of backends in the specified service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
reconnect(string, string, string, BackendReconnectOptionalParams)
Notifies the API Management gateway to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): 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.
- backendId
-
string
Identifier of the Backend entity. Must be unique in the current API Management service instance.
- options
- BackendReconnectOptionalParams
The options parameters.
Returns
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Updates an existing backend.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- BackendUpdateOptionalParams
The options parameters.
Returns
Promise<BackendUpdateResponse>