Interface GroupUsers


  • public interface GroupUsers
    Resource collection API of GroupUsers.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<UserContract> 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.
        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.
        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<UserContract> list​(String resourceGroupName,
                                                                  String serviceName,
                                                                  String groupId,
                                                                  String filter,
                                                                  Integer top,
                                                                  Integer skip,
                                                                  com.azure.core.util.Context context)
        Lists a collection of user entities associated with the group.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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

        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.
        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.
        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<Boolean> checkEntityExistsWithResponse​(String resourceGroupName,
                                                                                 String serviceName,
                                                                                 String groupId,
                                                                                 String userId,
                                                                                 com.azure.core.util.Context context)
        Checks that user entity specified by identifier is associated with the group entity.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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.
      • create

        UserContract create​(String resourceGroupName,
                            String serviceName,
                            String groupId,
                            String userId)
        Add existing user to existing group.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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.
      • createWithResponse

        com.azure.core.http.rest.Response<UserContract> createWithResponse​(String resourceGroupName,
                                                                           String serviceName,
                                                                           String groupId,
                                                                           String userId,
                                                                           com.azure.core.util.Context context)
        Add existing user to existing group.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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 groupId,
                    String userId)
        Remove existing user from existing group.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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 groupId,
                                                                   String userId,
                                                                   com.azure.core.util.Context context)
        Remove existing user from existing group.
        Parameters:
        resourceGroupName - The name of the resource group.
        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.
        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.