ProductGroups Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface ProductGroups

Resource collection API of ProductGroups.

Method Summary

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

Method Details

checkEntityExists

public abstract 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. The name is case insensitive.

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.

checkEntityExistsWithResponse

public abstract Response checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

createOrUpdate

public abstract GroupContract 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. The name is case insensitive.

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.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

delete

public abstract 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. The name is case insensitive.

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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String productId, String groupId, Context context)

Deletes the association between the specified group and product.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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

listByProduct

public abstract PagedIterable 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. The name is case insensitive.

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

listByProduct

public abstract PagedIterable listByProduct(String resourceGroupName, String serviceName, String productId, String filter, Integer top, Integer skip, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

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