Package com.azure.analytics.synapse.accesscontrol

Class RoleDefinitionsClient

java.lang.Object
com.azure.analytics.synapse.accesscontrol.RoleDefinitionsClient
public final class RoleDefinitionsClient extends Object
Initializes a new instance of the synchronous AccessControlClient type.

  • Method Details

    • listRoleDefinitions

      public List<SynapseRoleDefinition> listRoleDefinitions(Boolean isBuiltIn, String scope)
      List role definitions.
      Parameters:
      isBuiltIn - Is a Synapse Built-In Role or not.
      scope - Scope of the Synapse Built-in Role.
      Returns:
      a list of Synapse roles available.
      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.

    • listRoleDefinitions

      public List<SynapseRoleDefinition> listRoleDefinitions()
      List role definitions.
      Returns:
      a list of Synapse roles available.
      Throws:
      ErrorContractException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listRoleDefinitionsWithResponse

      public Response<List<SynapseRoleDefinition>> listRoleDefinitionsWithResponse(Boolean isBuiltIn, String scope, Context context)
      List role definitions.
      Parameters:
      isBuiltIn - Is a Synapse Built-In Role or not.
      scope - Scope of the Synapse Built-in Role.
      context - The context to associate with this operation.
      Returns:
      a list of Synapse roles available.
      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.

    • getRoleDefinitionById

      public SynapseRoleDefinition getRoleDefinitionById(String roleDefinitionId)
      Get role definition by role definition Id.
      Parameters:
      roleDefinitionId - Synapse Built-In Role Definition Id.
      Returns:
      role definition by role definition 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.

    • getRoleDefinitionByIdWithResponse

      public Response<SynapseRoleDefinition> getRoleDefinitionByIdWithResponse(String roleDefinitionId, Context context)
      Get role definition by role definition Id.
      Parameters:
      roleDefinitionId - Synapse Built-In Role Definition Id.
      context - The context to associate with this operation.
      Returns:
      role definition by role definition 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.

    • listScopes

      public List<String> listScopes()
      List rbac scopes.
      Returns:
      a list of Synapse rbac scopes available.
      Throws:
      ErrorContractException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listScopesWithResponse

      public Response<List<String>> listScopesWithResponse(Context context)
      List rbac scopes.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      a list of Synapse rbac scopes available.
      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.