Interface Backends


  • public interface Backends
    Resource collection API of Backends.
    • Method Detail

      • listByService

        com.azure.core.http.rest.PagedIterable<BackendContract> listByService​(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:
        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<BackendContract> 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.
        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.
      • 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.
        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.
      • 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.
        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.
      • get

        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.
        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.
      • getWithResponse

        com.azure.core.http.rest.Response<BackendContract> 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.
        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.
      • delete

        void delete​(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.
        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.
        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.
      • reconnect

        void reconnect​(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.
        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 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.
        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.
      • getById

        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.
        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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<BackendContract> getByIdWithResponse​(String id,
                                                                               com.azure.core.util.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.
        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.
      • deleteById

        void deleteById​(String id)
        Deletes the specified backend.
        Parameters:
        id - the resource ID.
        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.
      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       String ifMatch,
                                                                       com.azure.core.util.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.
        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.
      • define

        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.