com.azure.analytics.synapse.accesscontrol

Class RoleAssignmentsAsyncClient

java.lang.Object

com.azure.analytics.synapse.accesscontrol.RoleAssignmentsAsyncClient

public final class RoleAssignmentsAsyncClient
extends Object

Initializes a new instance of the asynchronous AccessControlClient type.

Method Summary

Modifier and Type	Method and Description
Mono<CheckPrincipalAccessResponse>	checkPrincipalAccess(SubjectInfo subject, List<RequiredAction> actions, String scope) Check if the given principalId has access to perform list of actions at a given scope.
Mono<com.azure.core.http.rest.Response<CheckPrincipalAccessResponse>>	checkPrincipalAccessWithResponse(SubjectInfo subject, List<RequiredAction> actions, String scope) Check if the given principalId has access to perform list of actions at a given scope.
Mono<RoleAssignmentDetails>	createRoleAssignment(String roleAssignmentId, UUID roleId, UUID principalId, String scope) Create role assignment.
Mono<RoleAssignmentDetails>	createRoleAssignment(String roleAssignmentId, UUID roleId, UUID principalId, String scope, String principalType) Create role assignment.
Mono<com.azure.core.http.rest.Response<RoleAssignmentDetails>>	createRoleAssignmentWithResponse(String roleAssignmentId, UUID roleId, UUID principalId, String scope, String principalType) Create role assignment.
Mono<Void>	deleteRoleAssignmentById(String roleAssignmentId) Delete role assignment by role assignment Id.
Mono<Void>	deleteRoleAssignmentById(String roleAssignmentId, String scope) Delete role assignment by role assignment Id.
Mono<com.azure.core.http.rest.Response<Void>>	deleteRoleAssignmentByIdWithResponse(String roleAssignmentId, String scope) Delete role assignment by role assignment Id.
Mono<RoleAssignmentDetails>	getRoleAssignmentById(String roleAssignmentId) Get role assignment by role assignment Id.
Mono<com.azure.core.http.rest.Response<RoleAssignmentDetails>>	getRoleAssignmentByIdWithResponse(String roleAssignmentId) Get role assignment by role assignment Id.
Mono<RoleAssignmentDetailsList>	listRoleAssignments() List role assignments.
Mono<RoleAssignmentDetailsList>	listRoleAssignments(String roleId, String principalId, String scope, String continuationToken) List role assignments.
Mono<RoleAssignmentsListRoleAssignmentsResponse>	listRoleAssignmentsWithResponse(String roleId, String principalId, String scope, String continuationToken) List role assignments.

Methods inherited from class java.lang.Object

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

Method Detail

checkPrincipalAccessWithResponse

public Mono<com.azure.core.http.rest.Response<CheckPrincipalAccessResponse>> checkPrincipalAccessWithResponse(SubjectInfo subject,
                                                                                                              List<RequiredAction> actions,
                                                                                                              String scope)

Check if the given principalId has access to perform list of actions at a given scope.

Parameters:

subject - Subject details.

actions - List of actions.

scope - Scope at which the check access is done.

Returns:

check access response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkPrincipalAccess

public Mono<CheckPrincipalAccessResponse> checkPrincipalAccess(SubjectInfo subject,
                                                               List<RequiredAction> actions,
                                                               String scope)

Check if the given principalId has access to perform list of actions at a given scope.

Parameters:

subject - Subject details.

actions - List of actions.

scope - Scope at which the check access is done.

Returns:

check access response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listRoleAssignmentsWithResponse

public Mono<RoleAssignmentsListRoleAssignmentsResponse> listRoleAssignmentsWithResponse(String roleId,
                                                                                        String principalId,
                                                                                        String scope,
                                                                                        String continuationToken)

List role assignments.

Parameters:

roleId - Synapse Built-In Role Id.

principalId - Object ID of the AAD principal or security-group.

scope - Scope of the Synapse Built-in Role.

continuationToken - Continuation token.

Returns:

role Assignment response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listRoleAssignments

public Mono<RoleAssignmentDetailsList> listRoleAssignments(String roleId,
                                                           String principalId,
                                                           String scope,
                                                           String continuationToken)

List role assignments.

Parameters:

roleId - Synapse Built-In Role Id.

principalId - Object ID of the AAD principal or security-group.

scope - Scope of the Synapse Built-in Role.

continuationToken - Continuation token.

Returns:

role Assignment response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listRoleAssignments

public Mono<RoleAssignmentDetailsList> listRoleAssignments()

List role assignments.

Returns:

role Assignment response details.

Throws:

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createRoleAssignmentWithResponse

public Mono<com.azure.core.http.rest.Response<RoleAssignmentDetails>> createRoleAssignmentWithResponse(String roleAssignmentId,
                                                                                                       UUID roleId,
                                                                                                       UUID principalId,
                                                                                                       String scope,
                                                                                                       String principalType)

Create role assignment.

Parameters:

roleAssignmentId - The ID of the role assignment.

roleId - Role ID of the Synapse Built-In Role.

principalId - Object ID of the AAD principal or security-group.

scope - Scope at which the role assignment is created.

principalType - Type of the principal Id: User, Group or ServicePrincipal.

Returns:

role Assignment response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createRoleAssignment

public Mono<RoleAssignmentDetails> createRoleAssignment(String roleAssignmentId,
                                                        UUID roleId,
                                                        UUID principalId,
                                                        String scope,
                                                        String principalType)

Create role assignment.

Parameters:

roleAssignmentId - The ID of the role assignment.

roleId - Role ID of the Synapse Built-In Role.

principalId - Object ID of the AAD principal or security-group.

scope - Scope at which the role assignment is created.

principalType - Type of the principal Id: User, Group or ServicePrincipal.

Returns:

role Assignment response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createRoleAssignment

public Mono<RoleAssignmentDetails> createRoleAssignment(String roleAssignmentId,
                                                        UUID roleId,
                                                        UUID principalId,
                                                        String scope)

Create role assignment.

Parameters:

roleAssignmentId - The ID of the role assignment.

roleId - Role ID of the Synapse Built-In Role.

principalId - Object ID of the AAD principal or security-group.

scope - Scope at which the role assignment is created.

Returns:

role Assignment response details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRoleAssignmentByIdWithResponse

public Mono<com.azure.core.http.rest.Response<RoleAssignmentDetails>> getRoleAssignmentByIdWithResponse(String roleAssignmentId)

Get role assignment by role assignment Id.

Parameters:

roleAssignmentId - The ID of the role assignment.

Returns:

role assignment by role assignment Id.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRoleAssignmentById

public Mono<RoleAssignmentDetails> getRoleAssignmentById(String roleAssignmentId)

Get role assignment by role assignment Id.

Parameters:

roleAssignmentId - The ID of the role assignment.

Returns:

role assignment by role assignment Id.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteRoleAssignmentByIdWithResponse

public Mono<com.azure.core.http.rest.Response<Void>> deleteRoleAssignmentByIdWithResponse(String roleAssignmentId,
                                                                                          String scope)

Delete role assignment by role assignment Id.

Parameters:

roleAssignmentId - The ID of the role assignment.

scope - Scope of the Synapse Built-in Role.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteRoleAssignmentById

public Mono<Void> deleteRoleAssignmentById(String roleAssignmentId,
                                           String scope)

Delete role assignment by role assignment Id.

Parameters:

roleAssignmentId - The ID of the role assignment.

scope - Scope of the Synapse Built-in Role.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteRoleAssignmentById

public Mono<Void> deleteRoleAssignmentById(String roleAssignmentId)

Delete role assignment by role assignment Id.

Parameters:

roleAssignmentId - The ID of the role assignment.

Returns:

the completion.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

ErrorContractException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.