Package org.azd.memberentitlementmanagement.userentitlements

Class UserEntitlementsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.memberentitlementmanagement.userentitlements.UserEntitlementsRequestBuilder

public class UserEntitlementsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with User entitlements Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserEntitlementsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	UserEntitlementsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
UserEntitlementsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
UserEntitlementsResponse	add(UserEntitlement userEntitlement)	Add a user, assign license and extensions and make them a member of a project group in an account.
CompletableFuture<UserEntitlementsResponse>	addAsync(UserEntitlement userEntitlement)	Add a user, assign license and extensions and make them a member of a project group in an account.
Void	delete(String userId)	Delete a user from the account.
CompletableFuture<Void>	deleteAsync(String userId)	Delete a user from the account.
UserEntitlement	get(String userId)	Get User Entitlement for a user.
CompletableFuture<UserEntitlement>	getAsync(String userId)	Get User Entitlement for a user.
PagedGraphMemberList	search()	Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.
PagedGraphMemberList	search(Consumer<UserEntitlementsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.
CompletableFuture<PagedGraphMemberList>	searchAsync()	Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.
CompletableFuture<PagedGraphMemberList>	searchAsync(Consumer<UserEntitlementsRequestBuilder.RequestConfiguration> requestConfiguration)	Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.
UserEntitlementsResponse	update(String userId, List<JsonPatchDocument> jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.
UserEntitlementOperationReference	update(List<JsonPatchDocument> jsonPatchDocument, boolean doNotSendInviteForNewUsers)	Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.
CompletableFuture<UserEntitlementsResponse>	updateAsync(String userId, List<JsonPatchDocument> jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.
CompletableFuture<UserEntitlementOperationReference>	updateAsync(List<JsonPatchDocument> jsonPatchDocument, boolean doNotSendInviteForNewUsers)	Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserEntitlementsRequestBuilder

public UserEntitlementsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

addAsync

public CompletableFuture<UserEntitlementsResponse> addAsync(UserEntitlement userEntitlement)
                                                     throws AzDException

Add a user, assign license and extensions and make them a member of a project group in an account.

Parameters:

userEntitlement - User entitlement object UserEntitlement

Returns:

User entitlements response object UserEntitlementsResponse

Throws:

AzDException - Default Api exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String userId)
                                    throws AzDException

Delete a user from the account.

The delete operation includes un-assigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

Parameters:

userId - ID of the user.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<UserEntitlement> getAsync(String userId)
                                            throws AzDException

Get User Entitlement for a user.

Parameters:

userId - ID of the user.

Returns:

User entitlement object UserEntitlement

Throws:

AzDException - Default Api exception handler.

searchAsync

public CompletableFuture<PagedGraphMemberList> searchAsync()
                                                    throws AzDException

Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.

Returns:

Paged list of members PagedGraphMemberList

Throws:

AzDException - Default Api exception handler.

searchAsync

public CompletableFuture<PagedGraphMemberList> searchAsync(Consumer<UserEntitlementsRequestBuilder.RequestConfiguration> requestConfiguration)
                                                    throws AzDException

Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.

Parameters:

requestConfiguration - Consumer of request configuration that represents the query parameters.

Returns:

Paged list of members PagedGraphMemberList * @throws AzDException Default Api exception handler.

Throws:

AzDException

updateAsync

public CompletableFuture<UserEntitlementsResponse> updateAsync(String userId,
 List<JsonPatchDocument> jsonPatchDocument)
                                                        throws AzDException

Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.

Parameters:

userId - ID of the user.

jsonPatchDocument - Request body to update parameters.

Returns:

User entitlement response object UserEntitlementsResponse

Throws:

AzDException - Default Api exception handler.

updateAsync

public CompletableFuture<UserEntitlementOperationReference> updateAsync(List<JsonPatchDocument> jsonPatchDocument,
 boolean doNotSendInviteForNewUsers)
                                                                 throws AzDException

Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.

Parameters:

jsonPatchDocument - Collection of patch objects to update

doNotSendInviteForNewUsers - Whether to send email invites to new users or not

Returns:

User entitlement operation reference UserEntitlementOperationReference

Throws:

AzDException - Default Api exception handler.

add

public UserEntitlementsResponse add(UserEntitlement userEntitlement)
                             throws AzDException

Add a user, assign license and extensions and make them a member of a project group in an account.

Parameters:

userEntitlement - User entitlement object UserEntitlement

Returns:

User entitlements response object UserEntitlementsResponse

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(String userId)
            throws AzDException

Delete a user from the account.

The delete operation includes un-assigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.

Parameters:

userId - ID of the user.

Throws:

AzDException - Default Api exception handler.

get

public UserEntitlement get(String userId)
                    throws AzDException

Get User Entitlement for a user.

Parameters:

userId - ID of the user.

Returns:

User entitlement object UserEntitlement

Throws:

AzDException - Default Api exception handler.

search

public PagedGraphMemberList search()
                            throws AzDException

Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.

Returns:

Paged list of members PagedGraphMemberList

Throws:

AzDException - Default Api exception handler.

search

public PagedGraphMemberList search(Consumer<UserEntitlementsRequestBuilder.RequestConfiguration> requestConfiguration)
                            throws AzDException

Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.

Parameters:

requestConfiguration - Consumer of request configuration that represents the query parameters.

Returns:

Paged list of members PagedGraphMemberList * @throws AzDException Default Api exception handler.

Throws:

AzDException

update

public UserEntitlementsResponse update(String userId,
 List<JsonPatchDocument> jsonPatchDocument)
                                throws AzDException

Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.

Parameters:

userId - ID of the user.

jsonPatchDocument - Request body to update parameters.

Returns:

User entitlement response object UserEntitlementsResponse

Throws:

AzDException - Default Api exception handler.

update

public UserEntitlementOperationReference update(List<JsonPatchDocument> jsonPatchDocument,
 boolean doNotSendInviteForNewUsers)
                                         throws AzDException

Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.

Parameters:

jsonPatchDocument - Collection of patch objects to update

doNotSendInviteForNewUsers - Whether to send email invites to new users or not

Returns:

User entitlement operation reference UserEntitlementOperationReference

Throws:

AzDException - Default Api exception handler.