Interface UserGroupsClient
-
public interface UserGroupsClient
An instance of this class provides access to all the operations defined in UserGroupsClient.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.azure.core.http.rest.PagedIterable<GroupContractInner>
list(String resourceGroupName, String serviceName, String userId)
Lists all user groups.com.azure.core.http.rest.PagedIterable<GroupContractInner>
list(String resourceGroupName, String serviceName, String userId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
Lists all user groups.
-
-
-
Method Detail
-
list
com.azure.core.http.rest.PagedIterable<GroupContractInner> list(String resourceGroupName, String serviceName, String userId)
Lists all user groups.- Parameters:
resourceGroupName
- The name of the resource group.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
. - 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.
-
list
com.azure.core.http.rest.PagedIterable<GroupContractInner> list(String resourceGroupName, String serviceName, String userId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
Lists all user groups.- Parameters:
resourceGroupName
- The name of the resource group.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
. - 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.
-
-