public final class RoleAssignmentsClient extends Object
Modifier and Type | Method and Description |
---|---|
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.
|
com.azure.core.http.rest.Response<CheckPrincipalAccessResponse> |
checkPrincipalAccessWithResponse(SubjectInfo subject,
List<RequiredAction> actions,
String scope,
com.azure.core.util.Context context)
Check if the given principalId has access to perform list of actions at a given scope.
|
RoleAssignmentDetails |
createRoleAssignment(String roleAssignmentId,
UUID roleId,
UUID principalId,
String scope)
Create role assignment.
|
RoleAssignmentDetails |
createRoleAssignment(String roleAssignmentId,
UUID roleId,
UUID principalId,
String scope,
String principalType)
Create role assignment.
|
com.azure.core.http.rest.Response<RoleAssignmentDetails> |
createRoleAssignmentWithResponse(String roleAssignmentId,
UUID roleId,
UUID principalId,
String scope,
String principalType,
com.azure.core.util.Context context)
Create role assignment.
|
void |
deleteRoleAssignmentById(String roleAssignmentId)
Delete role assignment by role assignment Id.
|
void |
deleteRoleAssignmentById(String roleAssignmentId,
String scope)
Delete role assignment by role assignment Id.
|
com.azure.core.http.rest.Response<Void> |
deleteRoleAssignmentByIdWithResponse(String roleAssignmentId,
String scope,
com.azure.core.util.Context context)
Delete role assignment by role assignment Id.
|
RoleAssignmentDetails |
getRoleAssignmentById(String roleAssignmentId)
Get role assignment by role assignment Id.
|
com.azure.core.http.rest.Response<RoleAssignmentDetails> |
getRoleAssignmentByIdWithResponse(String roleAssignmentId,
com.azure.core.util.Context context)
Get role assignment by role assignment Id.
|
RoleAssignmentDetailsList |
listRoleAssignments()
List role assignments.
|
RoleAssignmentDetailsList |
listRoleAssignments(String roleId,
String principalId,
String scope,
String continuationToken)
List role assignments.
|
RoleAssignmentsListRoleAssignmentsResponse |
listRoleAssignmentsWithResponse(String roleId,
String principalId,
String scope,
String continuationToken,
com.azure.core.util.Context context)
List role assignments.
|
public CheckPrincipalAccessResponse checkPrincipalAccess(SubjectInfo subject, List<RequiredAction> actions, String scope)
subject
- Subject details.actions
- List of actions.scope
- Scope at which the check access is done.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.public com.azure.core.http.rest.Response<CheckPrincipalAccessResponse> checkPrincipalAccessWithResponse(SubjectInfo subject, List<RequiredAction> actions, String scope, com.azure.core.util.Context context)
subject
- Subject details.actions
- List of actions.scope
- Scope at which the check access is done.context
- The context to associate with this operation.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.public RoleAssignmentDetailsList listRoleAssignments(String roleId, String principalId, String scope, String continuationToken)
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.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.public RoleAssignmentDetailsList listRoleAssignments()
ErrorContractException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.public RoleAssignmentsListRoleAssignmentsResponse listRoleAssignmentsWithResponse(String roleId, String principalId, String scope, String continuationToken, com.azure.core.util.Context context)
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.context
- The context to associate with this operation.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.public RoleAssignmentDetails createRoleAssignment(String roleAssignmentId, UUID roleId, UUID principalId, String scope, String principalType)
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.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.public RoleAssignmentDetails createRoleAssignment(String roleAssignmentId, UUID roleId, UUID principalId, String scope)
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.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.public com.azure.core.http.rest.Response<RoleAssignmentDetails> createRoleAssignmentWithResponse(String roleAssignmentId, UUID roleId, UUID principalId, String scope, String principalType, com.azure.core.util.Context context)
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.context
- The context to associate with this operation.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.public RoleAssignmentDetails getRoleAssignmentById(String roleAssignmentId)
roleAssignmentId
- The ID of the role assignment.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.public com.azure.core.http.rest.Response<RoleAssignmentDetails> getRoleAssignmentByIdWithResponse(String roleAssignmentId, com.azure.core.util.Context context)
roleAssignmentId
- The ID of the role assignment.context
- The context to associate with this operation.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.public void deleteRoleAssignmentById(String roleAssignmentId, String scope)
roleAssignmentId
- The ID of the role assignment.scope
- Scope of the Synapse Built-in Role.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.public void deleteRoleAssignmentById(String roleAssignmentId)
roleAssignmentId
- The ID of the role assignment.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.public com.azure.core.http.rest.Response<Void> deleteRoleAssignmentByIdWithResponse(String roleAssignmentId, String scope, com.azure.core.util.Context context)
roleAssignmentId
- The ID of the role assignment.scope
- Scope of the Synapse Built-in Role.context
- The context to associate with this operation.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.Copyright © 2021 Microsoft Corporation. All rights reserved.