Package com.azure.resourcemanager.synapse.models

Interface SqlPools

public interface SqlPools

Resource collection API of SqlPools.

Method Summary

Modifier and Type	Method	Description
SqlPool.DefinitionStages.Blank	define(String name)	Begins definition for a new SqlPool resource.
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.
Object	deleteById(String id)	Delete a SQL pool.
Object	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a SQL pool.
SqlPool	get(String resourceGroupName, String workspaceName, String sqlPoolName)	Get SQL pool properties.
SqlPool	getById(String id)	Get SQL pool properties.
com.azure.core.http.rest.Response<SqlPool>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get SQL pool properties.
com.azure.core.http.rest.Response<SqlPool>	getWithResponse(String resourceGroupName, String workspaceName, String sqlPoolName, com.azure.core.util.Context context)	Get SQL pool properties.
com.azure.core.http.rest.PagedIterable<SqlPool>	listByWorkspace(String resourceGroupName, String workspaceName)	List all SQL pools.
com.azure.core.http.rest.PagedIterable<SqlPool>	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.

Method Detail

get

SqlPool 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<SqlPool> 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.

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<SqlPool> 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<SqlPool> 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.

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.

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.

getById

SqlPool getById(String id)

Get SQL pool properties.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<SqlPool> getByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Get SQL pool properties.

Parameters:

id - the resource ID.

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.

deleteById

Object deleteById(String id)

Delete a SQL pool.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

Object deleteByIdWithResponse(String id,
                              com.azure.core.util.Context context)

Delete a SQL pool.

Parameters:

id - the resource ID.

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.

define

SqlPool.DefinitionStages.Blank define(String name)

Begins definition for a new SqlPool resource.

Parameters:

name - resource name.

Returns:

the first stage of the new SqlPool definition.