Package com.azure.resourcemanager.synapse.fluent

Interface SqlPoolsClient

public interface SqlPoolsClient

An instance of this class provides access to all the operations defined in SqlPoolsClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SqlPoolInner>,SqlPoolInner>	beginCreate(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolInner sqlPoolInfo)	Create a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SqlPoolInner>,SqlPoolInner>	beginCreate(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolInner sqlPoolInfo, com.azure.core.util.Context context)	Create a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginDelete(String resourceGroupName, String workspaceName, String sqlPoolName)	Delete a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginDelete(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Delete a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginPause(String resourceGroupName, String workspaceName, String sqlPoolName)	Pause a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginPause(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Pause a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginResume(String resourceGroupName, String workspaceName, String sqlPoolName)	Resume a SQL pool.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object>	beginResume(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Resume a SQL pool.
SqlPoolInner	create(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolInner sqlPoolInfo)	Create a SQL pool.
SqlPoolInner	create(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolInner sqlPoolInfo, com.azure.core.util.Context context)	Create a SQL pool.
Object	delete(String resourceGroupName, String workspaceName, String sqlPoolName)	Delete a SQL pool.
Object	delete(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Delete a SQL pool.
SqlPoolInner	get(String resourceGroupName, String workspaceName, String sqlPoolName)	Get SQL pool properties.
com.azure.core.http.rest.Response<SqlPoolInner>	getWithResponse(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Get SQL pool properties.
com.azure.core.http.rest.PagedIterable<SqlPoolInner>	listByWorkspace(String resourceGroupName, String workspaceName)	List all SQL pools.
com.azure.core.http.rest.PagedIterable<SqlPoolInner>	listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	List all SQL pools.
Object	pause(String resourceGroupName, String workspaceName, String sqlPoolName)	Pause a SQL pool.
Object	pause(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Pause a SQL pool.
void	rename(String resourceGroupName, String workspaceName, String sqlPoolName, ResourceMoveDefinition parameters)	Rename a SQL pool.
com.azure.core.http.rest.Response<Void>	renameWithResponse(String resourceGroupName, String workspaceName, String sqlPoolName, ResourceMoveDefinition parameters, com.azure.core.util.Context context)	Rename a SQL pool.
Object	resume(String resourceGroupName, String workspaceName, String sqlPoolName)	Resume a SQL pool.
Object	resume(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Resume a SQL pool.
SqlPoolInner	update(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolPatchInfo sqlPoolInfo)	Apply a partial update to a SQL pool.
com.azure.core.http.rest.Response<SqlPoolInner>	updateWithResponse(String resourceGroupName, String workspaceName, String sqlPoolName, SqlPoolPatchInfo sqlPoolInfo, com.azure.core.util.Context context)	Apply a partial update to a SQL pool.

Method Detail

get

SqlPoolInner get(String resourceGroupName,
                 String workspaceName,
                 String sqlPoolName)

Get SQL pool properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

sQL pool properties.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

getWithResponse

com.azure.core.http.rest.Response<SqlPoolInner> getWithResponse(String resourceGroupName,
                                                                String workspaceName,
                                                                String sqlPoolName,
                                                                com.azure.core.util.Context context)

Get SQL pool properties.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

sQL pool properties along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

update

SqlPoolInner update(String resourceGroupName,
                    String workspaceName,
                    String sqlPoolName,
                    SqlPoolPatchInfo sqlPoolInfo)

Apply a partial update to a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The updated SQL pool properties.

Returns:

sQL pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

updateWithResponse

com.azure.core.http.rest.Response<SqlPoolInner> updateWithResponse(String resourceGroupName,
                                                                   String workspaceName,
                                                                   String sqlPoolName,
                                                                   SqlPoolPatchInfo sqlPoolInfo,
                                                                   com.azure.core.util.Context context)

Apply a partial update to a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The updated SQL pool properties.

context - The context to associate with this operation.

Returns:

sQL pool along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginCreate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SqlPoolInner>,SqlPoolInner> beginCreate(String resourceGroupName,
                                                                                                                                  String workspaceName,
                                                                                                                                  String sqlPoolName,
                                                                                                                                  SqlPoolInner sqlPoolInfo)

Create a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The SQL pool to create.

Returns:

the SyncPoller for polling of sQL pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginCreate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<SqlPoolInner>,SqlPoolInner> beginCreate(String resourceGroupName,
                                                                                                                                  String workspaceName,
                                                                                                                                  String sqlPoolName,
                                                                                                                                  SqlPoolInner sqlPoolInfo,
                                                                                                                                  com.azure.core.util.Context context)

Create a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The SQL pool to create.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of sQL pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

create

SqlPoolInner create(String resourceGroupName,
                    String workspaceName,
                    String sqlPoolName,
                    SqlPoolInner sqlPoolInfo)

Create a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The SQL pool to create.

Returns:

sQL pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

create

SqlPoolInner create(String resourceGroupName,
                    String workspaceName,
                    String sqlPoolName,
                    SqlPoolInner sqlPoolInfo,
                    com.azure.core.util.Context context)

Create a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

sqlPoolInfo - The SQL pool to create.

context - The context to associate with this operation.

Returns:

sQL pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginDelete(String resourceGroupName,
                                                                                                                      String workspaceName,
                                                                                                                      String sqlPoolName)

Delete a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginDelete(String resourceGroupName,
                                                                                                                      String workspaceName,
                                                                                                                      String sqlPoolName,
                                                                                                                      com.azure.core.util.Context context)

Delete a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

delete

Object delete(String resourceGroupName,
              String workspaceName,
              String sqlPoolName)

Delete a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

delete

Object delete(String resourceGroupName,
              String workspaceName,
              String sqlPoolName,
              com.azure.core.util.Context context)

Delete a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

listByWorkspace

com.azure.core.http.rest.PagedIterable<SqlPoolInner> listByWorkspace(String resourceGroupName,
                                                                     String workspaceName)

List all SQL pools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

Returns:

sQL pool collection as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

listByWorkspace

com.azure.core.http.rest.PagedIterable<SqlPoolInner> listByWorkspace(String resourceGroupName,
                                                                     String workspaceName,
                                                                     com.azure.core.util.Context context)

List all SQL pools.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

context - The context to associate with this operation.

Returns:

sQL pool collection as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginPause

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginPause(String resourceGroupName,
                                                                                                                     String workspaceName,
                                                                                                                     String sqlPoolName)

Pause a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginPause

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginPause(String resourceGroupName,
                                                                                                                     String workspaceName,
                                                                                                                     String sqlPoolName,
                                                                                                                     com.azure.core.util.Context context)

Pause a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

pause

Object pause(String resourceGroupName,
             String workspaceName,
             String sqlPoolName)

Pause a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

pause

Object pause(String resourceGroupName,
             String workspaceName,
             String sqlPoolName,
             com.azure.core.util.Context context)

Pause a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginResume

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginResume(String resourceGroupName,
                                                                                                                      String workspaceName,
                                                                                                                      String sqlPoolName)

Resume a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

beginResume

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Object>,Object> beginResume(String resourceGroupName,
                                                                                                                      String workspaceName,
                                                                                                                      String sqlPoolName,
                                                                                                                      com.azure.core.util.Context context)

Resume a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

resume

Object resume(String resourceGroupName,
              String workspaceName,
              String sqlPoolName)

Resume a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

resume

Object resume(String resourceGroupName,
              String workspaceName,
              String sqlPoolName,
              com.azure.core.util.Context context)

Resume a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

context - The context to associate with this operation.

Returns:

any object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

rename

void rename(String resourceGroupName,
            String workspaceName,
            String sqlPoolName,
            ResourceMoveDefinition parameters)

Rename a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

parameters - The resource move definition for renaming this Sql pool.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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

renameWithResponse

com.azure.core.http.rest.Response<Void> renameWithResponse(String resourceGroupName,
                                                           String workspaceName,
                                                           String sqlPoolName,
                                                           ResourceMoveDefinition parameters,
                                                           com.azure.core.util.Context context)

Rename a SQL pool.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

workspaceName - The name of the workspace.

sqlPoolName - SQL pool name.

parameters - The resource move definition for renaming this Sql pool.

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

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