sql_pool_workload_group

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

Overview

Name	sql_pool_workload_group
Type	Resource
Id	azure.synapse.sql_pool_workload_group

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
importance	string	The workload group importance level.
maxResourcePercent	integer	The workload group cap percentage resource.
maxResourcePercentPerRequest	number	The workload group request maximum grant percentage.
minResourcePercent	integer	The workload group minimum percentage resource.
minResourcePercentPerRequest	number	The workload group request minimum grant percentage.
queryExecutionTimeout	integer	The workload group query execution timeout.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
importance	string	The workload group importance level.
maxResourcePercent	integer	The workload group cap percentage resource.
maxResourcePercentPerRequest	number	The workload group request maximum grant percentage.
minResourcePercent	integer	The workload group minimum percentage resource.
minResourcePercentPerRequest	number	The workload group request minimum grant percentage.
queryExecutionTimeout	integer	The workload group query execution timeout.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sql_pool_name, workload_group_name, subscription_id		Sql pool's workload group. Get a Sql pool's workload group.
list	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		Sql pool's workload groups. Get list of Sql pool's workload groups.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, workload_group_name, subscription_id		Create Or Update workload group. Create Or Update a Sql pool's workload group.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, workload_group_name, subscription_id		Create Or Update workload group. Create Or Update a Sql pool's workload group.
delete	delete	resource_group_name, workspace_name, sql_pool_name, workload_group_name, subscription_id		Remove workload group. 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workload_group_name	string	The name of the workload group. Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Sql pool's workload group. Get a Sql pool's workload group.

SELECT
id,
name,
importance,
maxResourcePercent,
maxResourcePercentPerRequest,
minResourcePercent,
minResourcePercentPerRequest,
queryExecutionTimeout,
type
FROM azure.synapse.sql_pool_workload_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND workload_group_name = '{{ workload_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Sql pool's workload groups. Get list of Sql pool's workload groups.

SELECT
id,
name,
importance,
maxResourcePercent,
maxResourcePercentPerRequest,
minResourcePercent,
minResourcePercentPerRequest,
queryExecutionTimeout,
type
FROM azure.synapse.sql_pool_workload_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Or Update workload group. Create Or Update a Sql pool's workload group.

INSERT INTO azure.synapse.sql_pool_workload_group (
properties,
resource_group_name,
workspace_name,
sql_pool_name,
workload_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ workload_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_workload_group
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_workload_group resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_workload_group resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_workload_group resource.
  - name: workload_group_name
    value: "{{ workload_group_name }}"
    description: Required parameter for the sql_pool_workload_group resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_workload_group resource.
  - name: properties
    value:
      minResourcePercent: {{ minResourcePercent }}
      maxResourcePercent: {{ maxResourcePercent }}
      minResourcePercentPerRequest: {{ minResourcePercentPerRequest }}
      maxResourcePercentPerRequest: {{ maxResourcePercentPerRequest }}
      importance: "{{ importance }}"
      queryExecutionTimeout: {{ queryExecutionTimeout }}

REPLACE examples

create_or_update

Create Or Update workload group. Create Or Update a Sql pool's workload group.

REPLACE azure.synapse.sql_pool_workload_group
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND workload_group_name = '{{ workload_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Remove workload group. Remove Sql pool's workload group.

DELETE FROM azure.synapse.sql_pool_workload_group
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND workload_group_name = '{{ workload_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;