Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiProductsClient

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

  • Method Details

    • listByApis

      com.azure.core.http.rest.PagedIterable<ProductContractInner> listByApis(String resourceGroupName, String serviceName, String apiId)
      Lists all Products, which the API is part of.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      Returns:
      paged Products 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.

    • listByApis

      com.azure.core.http.rest.PagedIterable<ProductContractInner> listByApis(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists all Products, which the API is part of.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API identifier. Must be unique in the current API Management service instance.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| displayName | 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 Products 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.