Package com.azure.resourcemanager.apimanagement.models

Interface WorkspaceProductGroupLinks

public interface WorkspaceProductGroupLinks
Resource collection API of WorkspaceProductGroupLinks.

  • Method Details

    • listByProduct

      com.azure.core.http.rest.PagedIterable<ProductGroupLinkContract> listByProduct(String resourceGroupName, String serviceName, String workspaceId, String productId)
      Lists a collection of the group links associated with a product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      Returns:
      paged Product-group link 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.

    • listByProduct

      com.azure.core.http.rest.PagedIterable<ProductGroupLinkContract> listByProduct(String resourceGroupName, String serviceName, String workspaceId, String productId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of the group links associated with a product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| groupId | 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 Product-group link 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.

    • getWithResponse

      com.azure.core.http.rest.Response<ProductGroupLinkContract> getWithResponse(String resourceGroupName, String serviceName, String workspaceId, String productId, String groupLinkId, com.azure.core.util.Context context)
      Gets the group link for the product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link identifier. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the group link for the product.
      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

      ProductGroupLinkContract get(String resourceGroupName, String serviceName, String workspaceId, String productId, String groupLinkId)
      Gets the group link for the product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link identifier. Must be unique in the current API Management service instance.
      Returns:
      the group link for the product.
      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<ProductGroupLinkContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceId, String productId, String groupLinkId, ProductGroupLinkContractInner parameters, com.azure.core.util.Context context)
      Adds a group to the specified product via link.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link identifier. Must be unique in the current API Management service instance.
      parameters - Create or update parameters.
      context - The context to associate with this operation.
      Returns:
      product-group link 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

      ProductGroupLinkContract createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, String productId, String groupLinkId, ProductGroupLinkContractInner parameters)
      Adds a group to the specified product via link.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link identifier. Must be unique in the current API Management service instance.
      parameters - Create or update parameters.
      Returns:
      product-group link 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 workspaceId, String productId, String groupLinkId, com.azure.core.util.Context context)
      Deletes the specified group from the specified product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link 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 workspaceId, String productId, String groupLinkId)
      Deletes the specified group from the specified product.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      productId - Product identifier. Must be unique in the current API Management service instance.
      groupLinkId - Product-Group link 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.