workload_groups

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

Overview

Name	workload_groups
Type	Resource
Id	azure.sql.workload_groups

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. Required.
maxResourcePercentPerRequest	number	The workload group request maximum grant percentage.
minResourcePercent	integer	The workload group minimum percentage resource. Required.
minResourcePercentPerRequest	number	The workload group request minimum grant percentage. Required.
queryExecutionTimeout	integer	The workload group query execution timeout.
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_database

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. Required.
maxResourcePercentPerRequest	number	The workload group request maximum grant percentage.
minResourcePercent	integer	The workload group minimum percentage resource. Required.
minResourcePercentPerRequest	number	The workload group request minimum grant percentage. Required.
queryExecutionTimeout	integer	The workload group query execution timeout.
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, subscription_id		Gets a workload group.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets the list of workload groups.
create_or_update	insert	resource_group_name, server_name, database_name, workload_group_name, subscription_id		Creates or updates a workload group.
create_or_update	replace	resource_group_name, server_name, database_name, workload_group_name, subscription_id		Creates or updates a workload group.
delete	delete	resource_group_name, server_name, database_name, workload_group_name, subscription_id		Deletes a 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
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_group_name	string	The name of the workload group. Required.

SELECT examples

get

Gets a workload group.

SELECT
id,
name,
importance,
maxResourcePercent,
maxResourcePercentPerRequest,
minResourcePercent,
minResourcePercentPerRequest,
queryExecutionTimeout,
systemData,
type
FROM azure.sql.workload_groups
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
;

list_by_database

Gets the list of workload groups.

SELECT
id,
name,
importance,
maxResourcePercent,
maxResourcePercentPerRequest,
minResourcePercent,
minResourcePercentPerRequest,
queryExecutionTimeout,
systemData,
type
FROM azure.sql.workload_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a workload group.

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

Manifest

# Description fields are for documentation purposes
- name: workload_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workload_groups resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the workload_groups resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the workload_groups resource.
  - name: workload_group_name
    value: "{{ workload_group_name }}"
    description: Required parameter for the workload_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workload_groups resource.
  - name: properties
    description: |
      Resource properties.
    value:
      minResourcePercent: {{ minResourcePercent }}
      maxResourcePercent: {{ maxResourcePercent }}
      minResourcePercentPerRequest: {{ minResourcePercentPerRequest }}
      maxResourcePercentPerRequest: {{ maxResourcePercentPerRequest }}
      importance: "{{ importance }}"
      queryExecutionTimeout: {{ queryExecutionTimeout }}

REPLACE examples

create_or_update

Creates or updates a workload group.

REPLACE azure.sql.workload_groups
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a workload group.

DELETE FROM azure.sql.workload_groups
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
;