Package org.azd.memberentitlementmanagement.serviceprincipalentitlements

Class ServicePrincipalEntitlementsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.memberentitlementmanagement.serviceprincipalentitlements.ServicePrincipalEntitlementsRequestBuilder

public class ServicePrincipalEntitlementsRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Members Api.

Nested Class Summary

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
ServicePrincipalEntitlementsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
ServicePrincipalEntitlementsPostResponse	add(ServicePrincipalEntitlement servicePrincipalEntitlement)	Add a service principal, assign license and extensions and make them a member of a project group in an account.
CompletableFuture<ServicePrincipalEntitlementsPostResponse>	addAsync(ServicePrincipalEntitlement servicePrincipalEntitlement)	Add a service principal, assign license and extensions and make them a member of a project group in an account.
Void	delete(String servicePrincipalId)	Delete a service principal from the account.
CompletableFuture<Void>	deleteAsync(String servicePrincipalId)	Delete a service principal from the account.
ServicePrincipalEntitlement	get(String servicePrincipalId)	Get Service principal Entitlement for a service principal.
CompletableFuture<ServicePrincipalEntitlement>	getAsync(String servicePrincipalId)	Get Service principal Entitlement for a service principal.
ServicePrincipalEntitlementsPatchResponse	update(String servicePrincipalId, JsonPatchDocument jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for a service principal.
ServicePrincipalEntitlementOperationReference	update(JsonPatchDocument jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more service principals.
CompletableFuture<ServicePrincipalEntitlementsPatchResponse>	updateAsync(String servicePrincipalId, List<JsonPatchDocument> jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for a service principal.
CompletableFuture<ServicePrincipalEntitlementOperationReference>	updateAsync(List<JsonPatchDocument> jsonPatchDocument)	Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more service principals.

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

ServicePrincipalEntitlementsRequestBuilder

public ServicePrincipalEntitlementsRequestBuilder(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<ServicePrincipalEntitlementsPostResponse> addAsync(ServicePrincipalEntitlement servicePrincipalEntitlement)
                                                                     throws AzDException

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

NOTE: If you are working with AAD app registration, you can find service principal of your app in enterprise applications, and make sure to use service principal's object id as originId parameter in the request body

Parameters:

servicePrincipalEntitlement - Request body of service principal object ServicePrincipalEntitlement

Returns:

Post response of service principal entitlement ServicePrincipalEntitlementsPostResponse

Throws:

AzDException - Default Api exception handler.

deleteAsync

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

Delete a service principal from the account.

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

Parameters:

servicePrincipalId - ID of the service principal.

Throws:

AzDException - Default Api exception handler.

getAsync

public CompletableFuture<ServicePrincipalEntitlement> getAsync(String servicePrincipalId)
                                                        throws AzDException

Get Service principal Entitlement for a service principal.

Parameters:

servicePrincipalId - ID of the service principal.

Returns:

ServicePrincipalEntitlement object ServicePrincipalEntitlement

Throws:

AzDException - Default Api exception handler.

updateAsync

public CompletableFuture<ServicePrincipalEntitlementsPatchResponse> updateAsync(String servicePrincipalId,
 List<JsonPatchDocument> jsonPatchDocument)
                                                                         throws AzDException

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

Parameters:

servicePrincipalId - ID of the service principal.

jsonPatchDocument - Parameters for update operation.

Returns:

ServicePrincipalEntitlement object ServicePrincipalEntitlement

Throws:

AzDException - Default Api exception handler.

updateAsync

public CompletableFuture<ServicePrincipalEntitlementOperationReference> updateAsync(List<JsonPatchDocument> jsonPatchDocument)
                                                                             throws AzDException

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

Parameters:

jsonPatchDocument - Parameters for update operation.

Returns:

ServicePrincipalEntitlementOperationReference object ServicePrincipalEntitlementOperationReference

Throws:

AzDException - Default Api exception handler.

add

public ServicePrincipalEntitlementsPostResponse add(ServicePrincipalEntitlement servicePrincipalEntitlement)
                                             throws AzDException

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

NOTE: If you are working with AAD app registration, you can find service principal of your app in enterprise applications, and make sure to use service principal's object id as originId parameter in the request body

Parameters:

servicePrincipalEntitlement - Request body of service principal object ServicePrincipalEntitlement

Returns:

Post response of service principal entitlement ServicePrincipalEntitlementsPostResponse

Throws:

AzDException - Default Api exception handler.

delete

public Void delete(String servicePrincipalId)
            throws AzDException

Delete a service principal from the account.

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

Parameters:

servicePrincipalId - ID of the service principal.

Throws:

AzDException - Default Api exception handler.

get

public ServicePrincipalEntitlement get(String servicePrincipalId)
                                throws AzDException

Get Service principal Entitlement for a service principal.

Parameters:

servicePrincipalId - ID of the service principal.

Returns:

ServicePrincipalEntitlement object ServicePrincipalEntitlement

Throws:

AzDException - Default Api exception handler.

update

public ServicePrincipalEntitlementsPatchResponse update(String servicePrincipalId,
 JsonPatchDocument jsonPatchDocument)
                                                 throws AzDException

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

Parameters:

servicePrincipalId - ID of the service principal.

jsonPatchDocument - Parameters for update operation.

Returns:

ServicePrincipalEntitlement object ServicePrincipalEntitlement

Throws:

AzDException - Default Api exception handler.

update

public ServicePrincipalEntitlementOperationReference update(JsonPatchDocument jsonPatchDocument)
                                                     throws AzDException

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

Parameters:

jsonPatchDocument - Parameters for update operation.

Returns:

ServicePrincipalEntitlementOperationReference object ServicePrincipalEntitlementOperationReference

Throws:

AzDException - Default Api exception handler.