BigDataPools | @azure/arm-synapse

Interface representing a BigDataPools.

Hierarchy

BigDataPools

Implemented by

BigDataPoolsImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/bigDataPools.ts:75
Create a new Big Data pool.

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.
- Optional options: BigDataPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<BigDataPoolsCreateOrUpdateResponse>, BigDataPoolsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/bigDataPools.ts:95
Create a new Big Data pool.

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.
- Optional options: BigDataPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<BigDataPoolsCreateOrUpdateResponse>

beginDelete

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

- Defined in operationsInterfaces/bigDataPools.ts:109
Delete a Big Data pool from the workspace.

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
- Optional options: BigDataPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<BigDataPoolsDeleteResponse>, BigDataPoolsDeleteResponse>>

beginDeleteAndWait

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

- Defined in operationsInterfaces/bigDataPools.ts:127
Delete a Big Data pool from the workspace.

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
- Optional options: BigDataPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<BigDataPoolsDeleteResponse>

get

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

- Defined in operationsInterfaces/bigDataPools.ts:46
Get a Big Data pool.

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
- Optional options: BigDataPoolsGetOptionalParams
  
  The options parameters.
Returns Promise<BigDataPoolsGetResponse>

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: BigDataPoolsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<BigDataPoolResourceInfo>

- Defined in operationsInterfaces/bigDataPools.ts:34
List Big Data pools in a workspace.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: BigDataPoolsListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<BigDataPoolResourceInfo>

update

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

- Defined in operationsInterfaces/bigDataPools.ts:60
Patch a Big Data pool.

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
- Optional options: BigDataPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<BigDataPoolsUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

bigDataPoolInfo: BigDataPoolResourceInfo

Optional options: BigDataPoolsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<BigDataPoolsCreateOrUpdateResponse>, BigDataPoolsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

bigDataPoolInfo: BigDataPoolResourceInfo

Optional options: BigDataPoolsCreateOrUpdateOptionalParams

Returns Promise<BigDataPoolsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

Optional options: BigDataPoolsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

Optional options: BigDataPoolsDeleteOptionalParams

Returns Promise<BigDataPoolsDeleteResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

Optional options: BigDataPoolsGetOptionalParams

Returns Promise<BigDataPoolsGetResponse>

listByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

Optional options: BigDataPoolsListByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<BigDataPoolResourceInfo>

update

Parameters

resourceGroupName: string

workspaceName: string

bigDataPoolName: string

bigDataPoolPatchInfo: BigDataPoolPatchInfo

Optional options: BigDataPoolsUpdateOptionalParams

Returns Promise<BigDataPoolsUpdateResponse>