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

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. Required.
startTime	string	The workload classifier start time for classification.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workload_group

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. Required.
startTime	string	The workload classifier start time for classification.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, database_name, workload_group_name, workload_classifier_name, subscription_id		Gets a workload classifier.
list_by_workload_group	select	resource_group_name, server_name, database_name, workload_group_name, subscription_id		Gets the list of workload classifiers for a workload group.
create_or_update	insert	resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, subscription_id		Creates or updates a workload classifier.
create_or_update	replace	resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, subscription_id		Creates or updates a workload classifier.
delete	delete	resource_group_name, server_name, database_name, workload_group_name, workload_classifier_name, subscription_id		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
database_name	string	The name of the database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. 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.

SELECT examples

get

Gets a workload classifier.

SELECT
id,
name,
context,
endTime,
importance,
label,
memberName,
startTime,
systemData,
type
FROM azure.sql.workload_classifiers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_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_by_workload_group

Gets the list of workload classifiers for a workload group.

SELECT
id,
name,
context,
endTime,
importance,
label,
memberName,
startTime,
systemData,
type
FROM azure.sql.workload_classifiers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND workload_group_name = '{{ workload_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workload classifier.

INSERT INTO azure.sql.workload_classifiers (
properties,
resource_group_name,
server_name,
database_name,
workload_group_name,
workload_classifier_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ workload_group_name }}',
'{{ workload_classifier_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

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

REPLACE examples

create_or_update

Creates or updates a workload classifier.

REPLACE azure.sql.workload_classifiers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_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,
systemData,
type;

DELETE examples

delete

Deletes a workload classifier.

DELETE FROM azure.sql.workload_classifiers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND workload_group_name = '{{ workload_group_name }}' --required
AND workload_classifier_name = '{{ workload_classifier_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;