GroupUsers Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface GroupUsers

Resource collection API of GroupUsers.

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkEntityExists(String resourceGroupName, String serviceName, String groupId, String userId) Checks that user entity specified by identifier is associated with the group entity.
abstract Response<Boolean>	checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String groupId, String userId, Context context) Checks that user entity specified by identifier is associated with the group entity.
abstract UserContract	create(String resourceGroupName, String serviceName, String groupId, String userId) Add existing user to existing group.
abstract Response<UserContract>	createWithResponse(String resourceGroupName, String serviceName, String groupId, String userId, Context context) Add existing user to existing group.
abstract void	delete(String resourceGroupName, String serviceName, String groupId, String userId) Remove existing user from existing group.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String groupId, String userId, Context context) Remove existing user from existing group.
abstract PagedIterable<UserContract>	list(String resourceGroupName, String serviceName, String groupId) Lists a collection of user entities associated with the group.
abstract PagedIterable<UserContract>	list(String resourceGroupName, String serviceName, String groupId, String filter, Integer top, Integer skip, Context context) Lists a collection of user entities associated with the group.

Method Details

checkEntityExists

public abstract boolean checkEntityExists(String resourceGroupName, String serviceName, String groupId, String userId)

Checks that user entity specified by identifier is associated with the group entity.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

Returns:

whether resource exists.

checkEntityExistsWithResponse

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

Checks that user entity specified by identifier is associated with the group entity.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

create

public abstract UserContract create(String resourceGroupName, String serviceName, String groupId, String userId)

Add existing user to existing group.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

Returns:

user details.

createWithResponse

public abstract Response createWithResponse(String resourceGroupName, String serviceName, String groupId, String userId, Context context)

Add existing user to existing group.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

user details along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String serviceName, String groupId, String userId)

Remove existing user from existing group.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

deleteWithResponse

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

Remove existing user from existing group.

Parameters:

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

serviceName - The name of the API Management service.

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

userId - User identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the Response<T>.

list

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

Lists a collection of user entities associated with the group.

Parameters:

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

serviceName - The name of the API Management service.

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

Returns:

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

list

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

Lists a collection of user entities associated with the group.

Parameters:

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

serviceName - The name of the API Management service.

groupId - Group 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>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| registrationDate | filter | ge, le, eq, ne, gt, lt | |</br>| note | 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 Users list representation as paginated response with PagedIterable<T>.