UserGroups Interface

public interface UserGroups

Resource collection API of UserGroups.

Method Summary

Modifier and Type Method and Description
abstract PagedIterable<GroupContract> list(String resourceGroupName, String serviceName, String userId)

Lists all user groups.

abstract PagedIterable<GroupContract> list(String resourceGroupName, String serviceName, String userId, String filter, Integer top, Integer skip, Context context)

Lists all user groups.

Method Details

list

public abstract PagedIterable list(String resourceGroupName, String serviceName, String userId)

Lists all user groups.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
userId - User identifier. Must be unique in the current API Management service instance.

Returns:

paged Group list representation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String resourceGroupName, String serviceName, String userId, String filter, Integer top, Integer skip, Context context)

Lists all user groups.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
userId - User 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 | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | 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 Group list representation as paginated response with PagedIterable<T>.

Applies to