workload_classifiers

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

Overview

Name	workload_classifiers
Type	Resource
Id	azure.sql.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_by_workload_group

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	resourceGroupName, serverName, databaseName, workloadGroupName, workloadClassifierName, subscriptionId		Gets a workload classifier
list_by_workload_group	select	resourceGroupName, serverName, databaseName, workloadGroupName, subscriptionId		Gets the list of workload classifiers for a workload group
create_or_update	insert	resourceGroupName, serverName, databaseName, workloadGroupName, workloadClassifierName, subscriptionId		Creates or updates a workload classifier.
delete	delete	resourceGroupName, serverName, databaseName, workloadGroupName, workloadClassifierName, subscriptionId		Deletes a workload classifier.

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
databaseName	string	The name of the database.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.
workloadClassifierName	string	The name of the workload classifier to delete.
workloadGroupName	string	The name of the workload group from which to receive the classifier from.

SELECT examples

get

Gets a workload classifier

SELECT
properties
FROM azure.sql.workload_classifiers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND workloadGroupName = '{{ workloadGroupName }}' -- required
AND workloadClassifierName = '{{ workloadClassifierName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_workload_group

Gets the list of workload classifiers for a workload group

SELECT
properties
FROM azure.sql.workload_classifiers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND workloadGroupName = '{{ workloadGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workload classifier.

INSERT INTO azure.sql.workload_classifiers (
data__properties,
resourceGroupName,
serverName,
databaseName,
workloadGroupName,
workloadClassifierName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ workloadGroupName }}',
'{{ workloadClassifierName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

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

DELETE examples

delete

Deletes a workload classifier.

DELETE FROM azure.sql.workload_classifiers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND workloadGroupName = '{{ workloadGroupName }}' --required
AND workloadClassifierName = '{{ workloadClassifierName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;