SqlPoolWorkloadGroup interface

Package:

@azure/arm-synapse

Interface representing a SqlPoolWorkloadGroup.

Methods

beginCreateOrUpdate(string, string, string, string, WorkloadGroup, SqlPoolWorkloadGroupCreateOrUpdateOptionalParams)	Create Or Update a Sql pool's workload group.
beginCreateOrUpdateAndWait(string, string, string, string, WorkloadGroup, SqlPoolWorkloadGroupCreateOrUpdateOptionalParams)	Create Or Update a Sql pool's workload group.
beginDelete(string, string, string, string, SqlPoolWorkloadGroupDeleteOptionalParams)	Remove Sql pool's workload group.
beginDeleteAndWait(string, string, string, string, SqlPoolWorkloadGroupDeleteOptionalParams)	Remove Sql pool's workload group.
get(string, string, string, string, SqlPoolWorkloadGroupGetOptionalParams)	Get a Sql pool's workload group.
list(string, string, string, SqlPoolWorkloadGroupListOptionalParams)	Get list of Sql pool's workload groups.

Method Details

beginCreateOrUpdate(string, string, string, string, WorkloadGroup, SqlPoolWorkloadGroupCreateOrUpdateOptionalParams)

Create Or Update a Sql pool's workload group.

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

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.

options

SqlPoolWorkloadGroupCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<WorkloadGroup>, WorkloadGroup>>

beginCreateOrUpdateAndWait(string, string, string, string, WorkloadGroup, SqlPoolWorkloadGroupCreateOrUpdateOptionalParams)

Create Or Update a Sql pool's workload group.

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

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.

options

SqlPoolWorkloadGroupCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkloadGroup>

beginDelete(string, string, string, string, SqlPoolWorkloadGroupDeleteOptionalParams)

Remove Sql pool's workload group.

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

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.

options

SqlPoolWorkloadGroupDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, SqlPoolWorkloadGroupDeleteOptionalParams)

Remove Sql pool's workload group.

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

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.

options

SqlPoolWorkloadGroupDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, SqlPoolWorkloadGroupGetOptionalParams)

Get a Sql pool's workload group.

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

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.

options

SqlPoolWorkloadGroupGetOptionalParams

The options parameters.

Returns

Promise<WorkloadGroup>

list(string, string, string, SqlPoolWorkloadGroupListOptionalParams)

Get list of Sql pool's workload groups.

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

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

options

SqlPoolWorkloadGroupListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkloadGroup, WorkloadGroup[], PageSettings>