sql_pool_workload_classifier

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

Overview

Name	sql_pool_workload_classifier
Type	Resource
Id	azure.synapse.sql_pool_workload_classifier

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.
context	string	The workload classifier context.
endTime	string	The workload classifier end time for classification.
importance	string	The workload classifier importance.
label	string	The workload classifier label.
memberName	string	The workload classifier member name.
startTime	string	The workload classifier start time for classification.
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.
context	string	The workload classifier context.
endTime	string	The workload classifier end time for classification.
importance	string	The workload classifier importance.
label	string	The workload classifier label.
memberName	string	The workload classifier member name.
startTime	string	The workload classifier start time for classification.
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, workload_classifier_name, subscription_id		Get workload classifier. Get a workload classifier of Sql pool's workload group.
list	select	resource_group_name, workspace_name, sql_pool_name, workload_group_name, subscription_id		Sql pool's workload classifier. Get list of Sql pool's workload classifier for workload groups.
create_or_update	insert	resource_group_name, workspace_name, sql_pool_name, workload_group_name, workload_classifier_name, subscription_id		Create Or Update workload classifier. Create Or Update workload classifier for a Sql pool's workload group.
create_or_update	replace	resource_group_name, workspace_name, sql_pool_name, workload_group_name, workload_classifier_name, subscription_id		Create Or Update workload classifier. Create Or Update workload classifier for a Sql pool's workload group.
delete	delete	resource_group_name, workspace_name, sql_pool_name, workload_group_name, workload_classifier_name, subscription_id		Remove workload classifier. 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
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_classifier_name	string	The name of the workload classifier. Required.
workload_group_name	string	The name of the workload group. Required.
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

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

SELECT
id,
name,
context,
endTime,
importance,
label,
memberName,
startTime,
type
FROM azure.synapse.sql_pool_workload_classifier
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 workload_classifier_name = '{{ workload_classifier_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
context,
endTime,
importance,
label,
memberName,
startTime,
type
FROM azure.synapse.sql_pool_workload_classifier
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
;

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: sql_pool_workload_classifier
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: workload_group_name
    value: "{{ workload_group_name }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: workload_classifier_name
    value: "{{ workload_classifier_name }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pool_workload_classifier resource.
  - name: properties
    value:
      memberName: "{{ memberName }}"
      label: "{{ label }}"
      context: "{{ context }}"
      startTime: "{{ startTime }}"
      endTime: "{{ endTime }}"
      importance: "{{ importance }}"

REPLACE examples

create_or_update

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

REPLACE azure.synapse.sql_pool_workload_classifier
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 workload_classifier_name = '{{ workload_classifier_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

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

DELETE FROM azure.synapse.sql_pool_workload_classifier
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 workload_classifier_name = '{{ workload_classifier_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;