Package com.azure.resourcemanager.synapse.models

Interface BigDataPools

public interface BigDataPools

Resource collection API of BigDataPools.

Method Summary

Modifier and Type	Method	Description
BigDataPoolResourceInfo.DefinitionStages.Blank	define(String name)	Begins definition for a new BigDataPoolResourceInfo resource.
Object	delete(String resourceGroupName, String workspaceName, String bigDataPoolName)	Delete a Big Data pool from the workspace.
Object	delete(String resourceGroupName, String workspaceName, String bigDataPoolName, com.azure.core.util.Context context)	Delete a Big Data pool from the workspace.
Object	deleteById(String id)	Delete a Big Data pool from the workspace.
Object	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a Big Data pool from the workspace.
BigDataPoolResourceInfo	get(String resourceGroupName, String workspaceName, String bigDataPoolName)	Get a Big Data pool.
BigDataPoolResourceInfo	getById(String id)	Get a Big Data pool.
com.azure.core.http.rest.Response<BigDataPoolResourceInfo>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a Big Data pool.
com.azure.core.http.rest.Response<BigDataPoolResourceInfo>	getWithResponse(String resourceGroupName, String workspaceName, String bigDataPoolName, com.azure.core.util.Context context)	Get a Big Data pool.
com.azure.core.http.rest.PagedIterable<BigDataPoolResourceInfo>	listByWorkspace(String resourceGroupName, String workspaceName)	List Big Data pools in a workspace.
com.azure.core.http.rest.PagedIterable<BigDataPoolResourceInfo>	listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	List Big Data pools in a workspace.

Method Detail

get

BigDataPoolResourceInfo get(String resourceGroupName,
                            String workspaceName,
                            String bigDataPoolName)

Get a Big Data pool.

Parameters:

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

workspaceName - The name of the workspace.

bigDataPoolName - Big Data pool name.

Returns:

a Big Data 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.

getWithResponse

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

Get a Big Data pool.

Parameters:

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

workspaceName - The name of the workspace.

bigDataPoolName - Big Data pool name.

context - The context to associate with this operation.

Returns:

a Big Data 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.

delete

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

Delete a Big Data pool from the workspace.

Parameters:

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

workspaceName - The name of the workspace.

bigDataPoolName - Big Data 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 bigDataPoolName,
              com.azure.core.util.Context context)

Delete a Big Data pool from the workspace.

Parameters:

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

workspaceName - The name of the workspace.

bigDataPoolName - Big Data 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<BigDataPoolResourceInfo> listByWorkspace(String resourceGroupName,
                                                                                String workspaceName)

List Big Data pools in a workspace.

Parameters:

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

workspaceName - The name of the workspace.

Returns:

collection of Big Data pools 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<BigDataPoolResourceInfo> listByWorkspace(String resourceGroupName,
                                                                                String workspaceName,
                                                                                com.azure.core.util.Context context)

List Big Data pools in a workspace.

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:

collection of Big Data pools 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.

getById

BigDataPoolResourceInfo getById(String id)

Get a Big Data pool.

Parameters:

id - the resource ID.

Returns:

a Big Data 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.

getByIdWithResponse

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

Get a Big Data pool.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a Big Data 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.

deleteById

Object deleteById(String id)

Delete a Big Data pool from the workspace.

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 Big Data pool from the workspace.

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

BigDataPoolResourceInfo.DefinitionStages.Blank define(String name)

Begins definition for a new BigDataPoolResourceInfo resource.

Parameters:

name - resource name.

Returns:

the first stage of the new BigDataPoolResourceInfo definition.