SqlPoolWorkloadGroupImpl | @azure/arm-synapse

Class containing SqlPoolWorkloadGroup operations.

Hierarchy

SqlPoolWorkloadGroupImpl

Implements

SqlPoolWorkloadGroup

Index

Constructors

constructor

Methods

Constructors

constructor

new SqlPoolWorkloadGroupImpl(client: SynapseManagementClient): SqlPoolWorkloadGroupImpl

- Defined in operations/sqlPoolWorkloadGroup.ts:33
Initialize a new instance of the class SqlPoolWorkloadGroup class.

Parameters
- client: SynapseManagementClient
  
  Reference to the service client
Returns SqlPoolWorkloadGroupImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, workspaceName: string, sqlPoolName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SqlPoolWorkloadGroupCreateOrUpdateResponse>, SqlPoolWorkloadGroupCreateOrUpdateResponse>>

Implementation of SqlPoolWorkloadGroup.beginCreateOrUpdate
- Defined in operations/sqlPoolWorkloadGroup.ts:159
Create Or Update a Sql pool's workload group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- workloadGroupName: string
  
  The name of the workload group.
- parameters: WorkloadGroup
  
  The requested workload group state.
- Optional options: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SqlPoolWorkloadGroupCreateOrUpdateResponse>, SqlPoolWorkloadGroupCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, workloadGroupName: string, parameters: WorkloadGroup, options?: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams): Promise<SqlPoolWorkloadGroupCreateOrUpdateResponse>

Implementation of SqlPoolWorkloadGroup.beginCreateOrUpdateAndWait
- Defined in operations/sqlPoolWorkloadGroup.ts:240
Create Or Update a Sql pool's workload group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- workloadGroupName: string
  
  The name of the workload group.
- parameters: WorkloadGroup
  
  The requested workload group state.
- Optional options: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SqlPoolWorkloadGroupCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, workspaceName: string, sqlPoolName: string, workloadGroupName: string, options?: SqlPoolWorkloadGroupDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of SqlPoolWorkloadGroup.beginDelete
- Defined in operations/sqlPoolWorkloadGroup.ts:267
Remove Sql pool's workload group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- workloadGroupName: string
  
  The name of the workload group.
- Optional options: SqlPoolWorkloadGroupDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, workloadGroupName: string, options?: SqlPoolWorkloadGroupDeleteOptionalParams): Promise<void>

Implementation of SqlPoolWorkloadGroup.beginDeleteAndWait
- Defined in operations/sqlPoolWorkloadGroup.ts:340
Remove Sql pool's workload group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- workloadGroupName: string
  
  The name of the workload group.
- Optional options: SqlPoolWorkloadGroupDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, workspaceName: string, sqlPoolName: string, workloadGroupName: string, options?: SqlPoolWorkloadGroupGetOptionalParams): Promise<SqlPoolWorkloadGroupGetResponse>

Implementation of SqlPoolWorkloadGroup.get
- Defined in operations/sqlPoolWorkloadGroup.ts:131
Get a Sql pool's workload group.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- workloadGroupName: string
  
  The name of the workload group.
- Optional options: SqlPoolWorkloadGroupGetOptionalParams
  
  The options parameters.
Returns Promise<SqlPoolWorkloadGroupGetResponse>

list

list(resourceGroupName: string, workspaceName: string, sqlPoolName: string, options?: SqlPoolWorkloadGroupListOptionalParams): PagedAsyncIterableIterator<WorkloadGroup>

Implementation of SqlPoolWorkloadGroup.list
- Defined in operations/sqlPoolWorkloadGroup.ts:50
Get list of Sql pool's workload groups.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- sqlPoolName: string
  
  SQL pool name
- Optional options: SqlPoolWorkloadGroupListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<WorkloadGroup>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SynapseManagementClient

Returns SqlPoolWorkloadGroupImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

workloadGroupName: string

parameters: WorkloadGroup

Optional options: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SqlPoolWorkloadGroupCreateOrUpdateResponse>, SqlPoolWorkloadGroupCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

workloadGroupName: string

parameters: WorkloadGroup

Optional options: SqlPoolWorkloadGroupCreateOrUpdateOptionalParams

Returns Promise<SqlPoolWorkloadGroupCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

workloadGroupName: string

Optional options: SqlPoolWorkloadGroupDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

workloadGroupName: string

Optional options: SqlPoolWorkloadGroupDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

workloadGroupName: string

Optional options: SqlPoolWorkloadGroupGetOptionalParams

Returns Promise<SqlPoolWorkloadGroupGetResponse>

list

Parameters

resourceGroupName: string

workspaceName: string

sqlPoolName: string

Optional options: SqlPoolWorkloadGroupListOptionalParams

Returns PagedAsyncIterableIterator<WorkloadGroup>