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

Successfully retrieved the specifies workload group.

Name	Datatype	Description
properties	object	Resource properties.

list_by_database

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, subscriptionId		Gets a workload group
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets the list of workload groups
create_or_update	insert	resourceGroupName, serverName, databaseName, workloadGroupName, subscriptionId		Creates or updates a workload group.
delete	delete	resourceGroupName, serverName, databaseName, workloadGroupName, subscriptionId		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
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.
workloadGroupName	string	The name of the workload group to delete.

SELECT examples

get

Gets a workload group

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

list_by_database

Gets the list of workload groups

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

INSERT examples

create_or_update

Creates or updates a workload group.

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

Manifest

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

DELETE examples

delete

Deletes a workload group.

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