Share via

Backends Interface

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1

Implements

com.microsoft.azure.arm.collection.SupportsCreating<Blank> com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.BackendsInner>

public interface Backends
extends com.microsoft.azure.arm.collection.SupportsCreating<Blank>, com.microsoft.azure.arm.model.HasInner<com.microsoft.azure.management.apimanagement.v2019_01_01.implementation.BackendsInner>

Type representing Backends.

Method Summary

Modifier and Type Method and Description
abstract rx.Completable deleteAsync(String resourceGroupName, String serviceName, String backendId, String ifMatch)

Deletes the specified backend.
abstract rx.Observable<BackendContract> getAsync(String resourceGroupName, String serviceName, String backendId)

Gets the details of the backend specified by its identifier.
abstract rx.Completable getEntityTagAsync(String resourceGroupName, String serviceName, String backendId)

Gets the entity state (Etag) version of the backend specified by its identifier.
abstract rx.Observable<BackendContract> listByServiceAsync(String resourceGroupName, String serviceName)

Lists a collection of backends in the specified service instance.
abstract rx.Completable reconnectAsync(String resourceGroupName, String serviceName, String backendId)

Notifies the APIM proxy to create a new connection to the backend after the specified timeout.

Method Details

deleteAsync

public abstract Completable deleteAsync(String resourceGroupName, String serviceName, String backendId, String ifMatch)

Deletes the specified backend.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.
ifMatch - 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.

Returns:

the observable for the request

getAsync

public abstract Observable<BackendContract> getAsync(String resourceGroupName, String serviceName, String backendId)

Gets the details of the backend specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

Returns:

the observable for the request

getEntityTagAsync

public abstract Completable getEntityTagAsync(String resourceGroupName, String serviceName, String backendId)

Gets the entity state (Etag) version of the backend specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.
backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

Returns:

the observable for the request

listByServiceAsync

public abstract Observable<BackendContract> listByServiceAsync(String resourceGroupName, String serviceName)

Lists a collection of backends in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group.
serviceName - The name of the API Management service.

Returns:

the observable for the request

reconnectAsync

public abstract Completable reconnectAsync(String resourceGroupName, String serviceName, String backendId)

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 - The name of the resource group.
serviceName - The name of the API Management service.
backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

Returns:

the observable for the request

Applies to