Package com.azure.resourcemanager.apimanagement.fluent

Interface ProductGroupsClient

public interface ProductGroupsClient

An instance of this class provides access to all the operations defined in ProductGroupsClient.

Method Summary

Modifier and Type	Method	Description
void	checkEntityExists(String resourceGroupName, String serviceName, String productId, String groupId)	Checks that Group entity specified by identifier is associated with the Product entity.
com.azure.core.http.rest.Response<Void>	checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, com.azure.core.util.Context context)	Checks that Group entity specified by identifier is associated with the Product entity.
GroupContractInner	createOrUpdate(String resourceGroupName, String serviceName, String productId, String groupId)	Adds the association between the specified developer group with the specified product.
com.azure.core.http.rest.Response<GroupContractInner>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, com.azure.core.util.Context context)	Adds the association between the specified developer group with the specified product.
void	delete(String resourceGroupName, String serviceName, String productId, String groupId)	Deletes the association between the specified group and product.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, com.azure.core.util.Context context)	Deletes the association between the specified group and product.
com.azure.core.http.rest.PagedIterable<GroupContractInner>	listByProduct(String resourceGroupName, String serviceName, String productId)	Lists the collection of developer groups associated with the specified product.
com.azure.core.http.rest.PagedIterable<GroupContractInner>	listByProduct(String resourceGroupName, String serviceName, String productId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists the collection of developer groups associated with the specified product.

Method Detail

listByProduct

com.azure.core.http.rest.PagedIterable<GroupContractInner> listByProduct(String resourceGroupName,
                                                                         String serviceName,
                                                                         String productId)

Lists the collection of developer groups associated with the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

Returns:

paged Group 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<GroupContractInner> listByProduct(String resourceGroupName,
                                                                         String serviceName,
                                                                         String productId,
                                                                         String filter,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         com.azure.core.util.Context context)

Lists the collection of developer groups associated with the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | |</br>| displayName | filter | eq, ne | |</br>| description | filter | eq, ne | |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Group 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.

checkEntityExists

void checkEntityExists(String resourceGroupName,
                       String serviceName,
                       String productId,
                       String groupId)

Checks that Group entity specified by identifier is associated with the Product entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group 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.

checkEntityExistsWithResponse

com.azure.core.http.rest.Response<Void> checkEntityExistsWithResponse(String resourceGroupName,
                                                                      String serviceName,
                                                                      String productId,
                                                                      String groupId,
                                                                      com.azure.core.util.Context context)

Checks that Group entity specified by identifier is associated with the Product entity.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group 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.

createOrUpdate

GroupContractInner createOrUpdate(String resourceGroupName,
                                  String serviceName,
                                  String productId,
                                  String groupId)

Adds the association between the specified developer group with the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group identifier. Must be unique in the current API Management service instance.

Returns:

contract 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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<GroupContractInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                 String serviceName,
                                                                                 String productId,
                                                                                 String groupId,
                                                                                 com.azure.core.util.Context context)

Adds the association between the specified developer group with the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

contract 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.

delete

void delete(String resourceGroupName,
            String serviceName,
            String productId,
            String groupId)

Deletes the association between the specified group and product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group 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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String productId,
                                                           String groupId,
                                                           com.azure.core.util.Context context)

Deletes the association between the specified group and product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

groupId - Group 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.