Share via

BigDataPools interface

  • Reference
Package:
@azure/arm-synapse

Interface representing a BigDataPools.

Methods

beginCreateOrUpdate(string, string, string, BigDataPoolResourceInfo, BigDataPoolsCreateOrUpdateOptionalParams)

Create a new Big Data pool.
beginCreateOrUpdateAndWait(string, string, string, BigDataPoolResourceInfo, BigDataPoolsCreateOrUpdateOptionalParams)

Create a new Big Data pool.
beginDelete(string, string, string, BigDataPoolsDeleteOptionalParams)

Delete a Big Data pool from the workspace.
beginDeleteAndWait(string, string, string, BigDataPoolsDeleteOptionalParams)

Delete a Big Data pool from the workspace.
get(string, string, string, BigDataPoolsGetOptionalParams)

Get a Big Data pool.
listByWorkspace(string, string, BigDataPoolsListByWorkspaceOptionalParams)

List Big Data pools in a workspace.
update(string, string, string, BigDataPoolPatchInfo, BigDataPoolsUpdateOptionalParams)

Patch a Big Data pool.

Method Details

beginCreateOrUpdate(string, string, string, BigDataPoolResourceInfo, BigDataPoolsCreateOrUpdateOptionalParams)

Create a new Big Data pool.

function beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, bigDataPoolInfo: BigDataPoolResourceInfo, options?: BigDataPoolsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<BigDataPoolResourceInfo>, BigDataPoolResourceInfo>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

bigDataPoolInfo
BigDataPoolResourceInfo

The Big Data pool to create.

options
BigDataPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<BigDataPoolResourceInfo>, BigDataPoolResourceInfo>>

beginCreateOrUpdateAndWait(string, string, string, BigDataPoolResourceInfo, BigDataPoolsCreateOrUpdateOptionalParams)

Create a new Big Data pool.

function beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, bigDataPoolInfo: BigDataPoolResourceInfo, options?: BigDataPoolsCreateOrUpdateOptionalParams): Promise<BigDataPoolResourceInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

bigDataPoolInfo
BigDataPoolResourceInfo

The Big Data pool to create.

options
BigDataPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<BigDataPoolResourceInfo>

beginDelete(string, string, string, BigDataPoolsDeleteOptionalParams)

Delete a Big Data pool from the workspace.

function beginDelete(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, options?: BigDataPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<BigDataPoolsDeleteResponse>, BigDataPoolsDeleteResponse>>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

options
BigDataPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<BigDataPoolsDeleteResponse>, BigDataPoolsDeleteResponse>>

beginDeleteAndWait(string, string, string, BigDataPoolsDeleteOptionalParams)

Delete a Big Data pool from the workspace.

function beginDeleteAndWait(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, options?: BigDataPoolsDeleteOptionalParams): Promise<BigDataPoolsDeleteResponse>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

options
BigDataPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<BigDataPoolsDeleteResponse>

get(string, string, string, BigDataPoolsGetOptionalParams)

Get a Big Data pool.

function get(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, options?: BigDataPoolsGetOptionalParams): Promise<BigDataPoolResourceInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

options
BigDataPoolsGetOptionalParams

The options parameters.

Returns

Promise<BigDataPoolResourceInfo>

listByWorkspace(string, string, BigDataPoolsListByWorkspaceOptionalParams)

List Big Data pools in a workspace.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: BigDataPoolsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<BigDataPoolResourceInfo, BigDataPoolResourceInfo[], PageSettings>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

options
BigDataPoolsListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<BigDataPoolResourceInfo, BigDataPoolResourceInfo[], PageSettings>

update(string, string, string, BigDataPoolPatchInfo, BigDataPoolsUpdateOptionalParams)

Patch a Big Data pool.

function update(resourceGroupName: string, workspaceName: string, bigDataPoolName: string, bigDataPoolPatchInfo: BigDataPoolPatchInfo, options?: BigDataPoolsUpdateOptionalParams): Promise<BigDataPoolResourceInfo>

Parameters

resourceGroupName

string

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

workspaceName

string

The name of the workspace.

bigDataPoolName

string

Big Data pool name

bigDataPoolPatchInfo
BigDataPoolPatchInfo

The updated Big Data pool properties

options
BigDataPoolsUpdateOptionalParams

The options parameters.

Returns

Promise<BigDataPoolResourceInfo>