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

vw_sql_pool_workload_groups

Name	Datatype	Description
importance	text	field from the properties object
max_resource_percent	text	field from the properties object
max_resource_percent_per_request	text	field from the properties object
min_resource_percent	text	field from the properties object
min_resource_percent_per_request	text	field from the properties object
query_execution_timeout	text	field from the properties object
resourceGroupName	text	field from the properties object
sqlPoolName	text	field from the properties object
subscriptionId	text	field from the properties object
workloadGroupName	text	field from the properties object
workspaceName	text	field from the properties object

sql_pool_workload_groups

Name	Datatype	Description
properties	object	Workload group definition. For more information look at sys.workload_management_workload_groups (DMV).

Methods

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

SELECT examples

Get list of Sql pool's workload groups.

vw_sql_pool_workload_groups

SELECT
importance,
max_resource_percent,
max_resource_percent_per_request,
min_resource_percent,
min_resource_percent_per_request,
query_execution_timeout,
resourceGroupName,
sqlPoolName,
subscriptionId,
workloadGroupName,
workspaceName
FROM azure.synapse.vw_sql_pool_workload_groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

sql_pool_workload_groups

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_pool_workload_groups resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.sql_pool_workload_groups (
resourceGroupName,
sqlPoolName,
subscriptionId,
workloadGroupName,
workspaceName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ sqlPoolName }}',
'{{ subscriptionId }}',
'{{ workloadGroupName }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: minResourcePercent
          value: integer
        - name: maxResourcePercent
          value: integer
        - name: minResourcePercentPerRequest
          value: number
        - name: maxResourcePercentPerRequest
          value: number
        - name: importance
          value: string
        - name: queryExecutionTimeout
          value: integer

DELETE example

Deletes the specified sql_pool_workload_groups resource.

/*+ delete */
DELETE FROM azure.synapse.sql_pool_workload_groups
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workloadGroupName = '{{ workloadGroupName }}'
AND workspaceName = '{{ workspaceName }}';