public interface UsersClient
Modifier and Type | Method and Description |
---|---|
UserInner |
create(UserCreateParameters parameters)
Create a new user.
|
Mono<UserInner> |
createAsync(UserCreateParameters parameters)
Create a new user.
|
com.azure.core.http.rest.Response<UserInner> |
createWithResponse(UserCreateParameters parameters,
com.azure.core.util.Context context)
Create a new user.
|
Mono<com.azure.core.http.rest.Response<UserInner>> |
createWithResponseAsync(UserCreateParameters parameters)
Create a new user.
|
void |
delete(String upnOrObjectId)
Delete a user.
|
Mono<Void> |
deleteAsync(String upnOrObjectId)
Delete a user.
|
com.azure.core.http.rest.Response<Void> |
deleteWithResponse(String upnOrObjectId,
com.azure.core.util.Context context)
Delete a user.
|
Mono<com.azure.core.http.rest.Response<Void>> |
deleteWithResponseAsync(String upnOrObjectId)
Delete a user.
|
UserInner |
get(String upnOrObjectId)
Gets user information from the directory.
|
Mono<UserInner> |
getAsync(String upnOrObjectId)
Gets user information from the directory.
|
com.azure.core.http.rest.PagedIterable<String> |
getMemberGroups(String objectId,
boolean securityEnabledOnly)
Gets a collection that contains the object IDs of the groups of which the user is a member.
|
com.azure.core.http.rest.PagedIterable<String> |
getMemberGroups(String objectId,
boolean securityEnabledOnly,
com.azure.core.util.Context context)
Gets a collection that contains the object IDs of the groups of which the user is a member.
|
com.azure.core.http.rest.PagedFlux<String> |
getMemberGroupsAsync(String objectId,
boolean securityEnabledOnly)
Gets a collection that contains the object IDs of the groups of which the user is a member.
|
com.azure.core.http.rest.Response<UserInner> |
getWithResponse(String upnOrObjectId,
com.azure.core.util.Context context)
Gets user information from the directory.
|
Mono<com.azure.core.http.rest.Response<UserInner>> |
getWithResponseAsync(String upnOrObjectId)
Gets user information from the directory.
|
com.azure.core.http.rest.PagedIterable<UserInner> |
list()
Gets list of users for the current tenant.
|
com.azure.core.http.rest.PagedIterable<UserInner> |
list(String filter,
String expand,
com.azure.core.util.Context context)
Gets list of users for the current tenant.
|
com.azure.core.http.rest.PagedFlux<UserInner> |
listAsync()
Gets list of users for the current tenant.
|
com.azure.core.http.rest.PagedFlux<UserInner> |
listAsync(String filter,
String expand)
Gets list of users for the current tenant.
|
void |
update(String upnOrObjectId,
UserUpdateParameters parameters)
Updates a user.
|
Mono<Void> |
updateAsync(String upnOrObjectId,
UserUpdateParameters parameters)
Updates a user.
|
com.azure.core.http.rest.Response<Void> |
updateWithResponse(String upnOrObjectId,
UserUpdateParameters parameters,
com.azure.core.util.Context context)
Updates a user.
|
Mono<com.azure.core.http.rest.Response<Void>> |
updateWithResponseAsync(String upnOrObjectId,
UserUpdateParameters parameters)
Updates a user.
|
Mono<com.azure.core.http.rest.Response<UserInner>> createWithResponseAsync(UserCreateParameters parameters)
parameters
- Request parameters for creating a new work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<UserInner> createAsync(UserCreateParameters parameters)
parameters
- Request parameters for creating a new work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.UserInner create(UserCreateParameters parameters)
parameters
- Request parameters for creating a new work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.Response<UserInner> createWithResponse(UserCreateParameters parameters, com.azure.core.util.Context context)
parameters
- Request parameters for creating a new work or school account user.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedFlux<UserInner> listAsync(String filter, String expand)
filter
- The filter to apply to the operation.expand
- The expand value for the operation result.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedFlux<UserInner> listAsync()
GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedIterable<UserInner> list(String filter, String expand, com.azure.core.util.Context context)
filter
- The filter to apply to the operation.expand
- The expand value for the operation result.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedIterable<UserInner> list()
GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<com.azure.core.http.rest.Response<UserInner>> getWithResponseAsync(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user for which to get information.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<UserInner> getAsync(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user for which to get information.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.UserInner get(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user for which to get information.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.Response<UserInner> getWithResponse(String upnOrObjectId, com.azure.core.util.Context context)
upnOrObjectId
- The object ID or principal name of the user for which to get information.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<com.azure.core.http.rest.Response<Void>> updateWithResponseAsync(String upnOrObjectId, UserUpdateParameters parameters)
upnOrObjectId
- The object ID or principal name of the user to update.parameters
- Request parameters for updating an existing work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<Void> updateAsync(String upnOrObjectId, UserUpdateParameters parameters)
upnOrObjectId
- The object ID or principal name of the user to update.parameters
- Request parameters for updating an existing work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.void update(String upnOrObjectId, UserUpdateParameters parameters)
upnOrObjectId
- The object ID or principal name of the user to update.parameters
- Request parameters for updating an existing work or school account user.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.Response<Void> updateWithResponse(String upnOrObjectId, UserUpdateParameters parameters, com.azure.core.util.Context context)
upnOrObjectId
- The object ID or principal name of the user to update.parameters
- Request parameters for updating an existing work or school account user.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<com.azure.core.http.rest.Response<Void>> deleteWithResponseAsync(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user to delete.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Mono<Void> deleteAsync(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user to delete.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.void delete(String upnOrObjectId)
upnOrObjectId
- The object ID or principal name of the user to delete.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.Response<Void> deleteWithResponse(String upnOrObjectId, com.azure.core.util.Context context)
upnOrObjectId
- The object ID or principal name of the user to delete.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedFlux<String> getMemberGroupsAsync(String objectId, boolean securityEnabledOnly)
objectId
- The object ID of the user for which to get group membership.securityEnabledOnly
- If true, only membership in security-enabled groups should be checked. Otherwise,
membership in all groups should be checked.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedIterable<String> getMemberGroups(String objectId, boolean securityEnabledOnly)
objectId
- The object ID of the user for which to get group membership.securityEnabledOnly
- If true, only membership in security-enabled groups should be checked. Otherwise,
membership in all groups should be checked.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.com.azure.core.http.rest.PagedIterable<String> getMemberGroups(String objectId, boolean securityEnabledOnly, com.azure.core.util.Context context)
objectId
- The object ID of the user for which to get group membership.securityEnabledOnly
- If true, only membership in security-enabled groups should be checked. Otherwise,
membership in all groups should be checked.context
- The context to associate with this operation.IllegalArgumentException
- thrown if parameters fail the validation.GraphErrorException
- thrown if the request is rejected by
server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.Copyright © 2020 Microsoft Corporation. All rights reserved.