sql_pool_workload_groups

Creates, updates, deletes, gets or lists a sql_pool_workload_groups resource.

Overview

Name	sql_pool_workload_groups
Type	Resource
Id	azure.synapse.sql_pool_workload_groups

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specifies workload group.

Name	Datatype	Description
properties	object	Resource properties.

list

Successfully retrieved the list of workload groups.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName		Get a Sql pool's workload group.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get list of Sql pool's workload groups.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName		Create Or Update a Sql pool's workload group.
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName		Remove Sql pool's workload group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workloadGroupName	string	The name of the workload group.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a Sql pool's workload group.

SELECT
properties
FROM azure.synapse.sql_pool_workload_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND workloadGroupName = '{{ workloadGroupName }}' -- required
;

list

Get list of Sql pool's workload groups.

SELECT
properties
FROM azure.synapse.sql_pool_workload_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

INSERT examples

create_or_update

Create Or Update a Sql pool's workload group.

INSERT INTO azure.synapse.sql_pool_workload_groups (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName,
workloadGroupName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}',
'{{ workloadGroupName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_workload_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_workload_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_workload_groups resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_workload_groups resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_workload_groups resource.
    - name: workloadGroupName
      value: string
      description: Required parameter for the sql_pool_workload_groups resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Remove Sql pool's workload group.

DELETE FROM azure.synapse.sql_pool_workload_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required
AND workloadGroupName = '{{ workloadGroupName }}' --required
;