Backends Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Backends

Resource collection API of Backends.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new BackendContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String backendId, String ifMatch) Deletes the specified backend.
abstract void	deleteById(String id) Deletes the specified backend.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified backend.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String backendId, String ifMatch, Context context) Deletes the specified backend.
abstract BackendContract	get(String resourceGroupName, String serviceName, String backendId) Gets the details of the backend specified by its identifier.
abstract BackendContract	getById(String id) Gets the details of the backend specified by its identifier.
abstract Response<BackendContract>	getByIdWithResponse(String id, Context context) Gets the details of the backend specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String backendId) Gets the entity state (Etag) version of the backend specified by its identifier.
abstract BackendsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String backendId, Context context) Gets the entity state (Etag) version of the backend specified by its identifier.
abstract Response<BackendContract>	getWithResponse(String resourceGroupName, String serviceName, String backendId, Context context) Gets the details of the backend specified by its identifier.
abstract PagedIterable<BackendContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of backends in the specified service instance.
abstract PagedIterable<BackendContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context) Lists a collection of backends in the specified service instance.
abstract void	reconnect(String resourceGroupName, String serviceName, String backendId) Notifies the API Management gateway to create a new connection to the backend after the specified timeout.
abstract Response<Void>	reconnectWithResponse(String resourceGroupName, String serviceName, String backendId, BackendReconnectContract parameters, Context context) Notifies the API Management gateway to create a new connection to the backend after the specified timeout.

Method Details

define

public abstract BackendContract.DefinitionStages.Blank define(String name)

Begins definition for a new BackendContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new BackendContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String backendId, String ifMatch)

Deletes the specified backend.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

deleteById

public abstract void deleteById(String id)

Deletes the specified backend.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes the specified backend.

Parameters:

id - the resource ID.

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.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String backendId, String ifMatch, Context context)

Deletes the specified backend.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract BackendContract get(String resourceGroupName, String serviceName, String backendId)

Gets the details of the backend specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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 details of the backend specified by its identifier.

getById

public abstract BackendContract getById(String id)

Gets the details of the backend specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the backend specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the backend specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the backend specified by its identifier.

getEntityTag

public abstract void getEntityTag(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. The name is case insensitive.

serviceName - The name of the API Management service.

backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

getEntityTagWithResponse

public abstract BackendsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String backendId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String backendId, Context context)

Gets the details of the backend specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the backend specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of backends in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

paged Backend list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Context context)

Lists a collection of backends in the specified service instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Backend list representation as paginated response with PagedIterable<T>.

reconnect

public abstract void reconnect(String resourceGroupName, String serviceName, String backendId)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

reconnectWithResponse

public abstract Response reconnectWithResponse(String resourceGroupName, String serviceName, String backendId, BackendReconnectContract parameters, Context context)

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.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

backendId - Identifier of the Backend entity. Must be unique in the current API Management service instance.

parameters - Reconnect request parameters.

context - The context to associate with this operation.

Returns:

the Response<T>.