sql_pool_workload_classifiers

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

Overview

Name	sql_pool_workload_classifiers
Type	Resource
Id	azure.synapse.sql_pool_workload_classifiers

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the specifies workload classifier.

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, workloadClassifierName		Get a workload classifier of Sql pool's workload group.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName		Get list of Sql pool's workload classifier for workload groups.
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName, workloadClassifierName		Create Or Update workload classifier for a Sql pool's workload group.
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, workloadGroupName, workloadClassifierName		Remove workload classifier of a 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.
workloadClassifierName	string	The name of the workload classifier.
workloadGroupName	string	The name of the workload group.
workspaceName	string	The name of the workspace.

SELECT examples

get

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

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

list

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

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

INSERT examples

create_or_update

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

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

Manifest

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

DELETE examples

delete

Remove workload classifier of a Sql pool's workload group.

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