Microsoft.Sql servers/databases/workloadGroups 2022-02-01-preview

  • Article

Bicep resource definition

The servers/databases/workloadGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/workloadGroups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Sql/servers/databases/workloadGroups@2022-02-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    importance: 'string'
    maxResourcePercent: int
    maxResourcePercentPerRequest: int
    minResourcePercent: int
    minResourcePercentPerRequest: int
    queryExecutionTimeout: int
  }
}

Property values

servers/databases/workloadGroups

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databases
properties Resource properties. WorkloadGroupProperties

WorkloadGroupProperties

Name Description Value
importance The workload group importance level. string
maxResourcePercent The workload group cap percentage resource. int (required)
maxResourcePercentPerRequest The workload group request maximum grant percentage. int
minResourcePercent The workload group minimum percentage resource. int (required)
minResourcePercentPerRequest The workload group request minimum grant percentage. int (required)
queryExecutionTimeout The workload group query execution timeout. int

ARM template resource definition

The servers/databases/workloadGroups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/workloadGroups resource, add the following JSON to your template.

{
  "type": "Microsoft.Sql/servers/databases/workloadGroups",
  "apiVersion": "2022-02-01-preview",
  "name": "string",
  "properties": {
    "importance": "string",
    "maxResourcePercent": "int",
    "maxResourcePercentPerRequest": "int",
    "minResourcePercent": "int",
    "minResourcePercentPerRequest": "int",
    "queryExecutionTimeout": "int"
  }
}

Property values

servers/databases/workloadGroups

Name Description Value
type The resource type 'Microsoft.Sql/servers/databases/workloadGroups'
apiVersion The resource api version '2022-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Resource properties. WorkloadGroupProperties

WorkloadGroupProperties

Name Description Value
importance The workload group importance level. string
maxResourcePercent The workload group cap percentage resource. int (required)
maxResourcePercentPerRequest The workload group request maximum grant percentage. int
minResourcePercent The workload group minimum percentage resource. int (required)
minResourcePercentPerRequest The workload group request minimum grant percentage. int (required)
queryExecutionTimeout The workload group query execution timeout. int

Terraform (AzAPI provider) resource definition

The servers/databases/workloadGroups resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Sql/servers/databases/workloadGroups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/databases/workloadGroups@2022-02-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      importance = "string"
      maxResourcePercent = int
      maxResourcePercentPerRequest = int
      minResourcePercent = int
      minResourcePercentPerRequest = int
      queryExecutionTimeout = int
    }
  })
}

Property values

servers/databases/workloadGroups

Name Description Value
type The resource type "Microsoft.Sql/servers/databases/workloadGroups@2022-02-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databases
properties Resource properties. WorkloadGroupProperties

WorkloadGroupProperties

Name Description Value
importance The workload group importance level. string
maxResourcePercent The workload group cap percentage resource. int (required)
maxResourcePercentPerRequest The workload group request maximum grant percentage. int
minResourcePercent The workload group minimum percentage resource. int (required)
minResourcePercentPerRequest The workload group request minimum grant percentage. int (required)
queryExecutionTimeout The workload group query execution timeout. int