Package com.azure.resourcemanager.apimanagement.fluent

Interface BackendsClient

public interface BackendsClient
An instance of this class provides access to all the operations defined in BackendsClient.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<BackendContractInner> 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByService

      com.azure.core.http.rest.PagedIterable<BackendContractInner> listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTagWithResponse

      BackendsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String backendId, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTag

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      BackendsGetResponse getWithResponse(String resourceGroupName, String serviceName, String backendId, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      BackendContractInner 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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      BackendsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String backendId, BackendContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or Updates a 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.
      parameters - Create parameters.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      backend details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      BackendContractInner createOrUpdate(String resourceGroupName, String serviceName, String backendId, BackendContractInner parameters)
      Creates or Updates a 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.
      parameters - Create parameters.
      Returns:
      backend details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • updateWithResponse

      BackendsUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String backendId, String ifMatch, BackendUpdateParameters parameters, com.azure.core.util.Context context)
      Updates an existing 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.
      parameters - Update parameters.
      context - The context to associate with this operation.
      Returns:
      backend details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • update

      BackendContractInner update(String resourceGroupName, String serviceName, String backendId, String ifMatch, BackendUpdateParameters parameters)
      Updates an existing 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.
      parameters - Update parameters.
      Returns:
      backend details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String backendId, String ifMatch, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reconnectWithResponse

      com.azure.core.http.rest.Response<Void> reconnectWithResponse(String resourceGroupName, String serviceName, String backendId, BackendReconnectContract parameters, com.azure.core.util.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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • reconnect

      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.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.