Package com.azure.resourcemanager.apimanagement.models

Interface GatewayApis

public interface GatewayApis
Resource collection API of GatewayApis.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<ApiContract> listByService(String resourceGroupName, String serviceName, String gatewayId)
      Lists a collection of the APIs associated with a gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      Returns:
      paged API 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<ApiContract> listByService(String resourceGroupName, String serviceName, String gatewayId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of the APIs associated with a gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | 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 API 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

      GatewayApisGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, String apiId, com.azure.core.util.Context context)
      Checks that API entity specified by identifier is associated with the Gateway entity.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. Must be unique in the current API Management service instance.
      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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String gatewayId, String apiId)
      Checks that API entity specified by identifier is associated with the Gateway entity.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. 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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<ApiContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String gatewayId, String apiId, AssociationContract parameters, com.azure.core.util.Context context)
      Adds an API to the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. Must be unique in the current API Management service instance.
      parameters - The parameters parameter.
      context - The context to associate with this operation.
      Returns:
      aPI details along with 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.

    • createOrUpdate

      ApiContract createOrUpdate(String resourceGroupName, String serviceName, String gatewayId, String apiId)
      Adds an API to the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. Must be unique in the current API Management service instance.
      Returns:
      aPI 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 gatewayId, String apiId, com.azure.core.util.Context context)
      Deletes the specified API from the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. Must be unique in the current API Management service instance.
      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 gatewayId, String apiId)
      Deletes the specified API from the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      apiId - API identifier. 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.