Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. SqlPoolWorkloadGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.SqlPoolWorkloadGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Workload group operations for a sql pool Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-03-01.

    Other available API versions: 2021-06-01-preview.

    Example Usage

    Create a workload group with all properties specified.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlPoolWorkloadGroup = new AzureNative.Synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", new()
    {
        Importance = "normal",
        MaxResourcePercent = 100,
        MaxResourcePercentPerRequest = 3,
        MinResourcePercent = 0,
        MinResourcePercentPerRequest = 3,
        QueryExecutionTimeout = 0,
        ResourceGroupName = "sqlcrudtest-6852",
        SqlPoolName = "sqlcrudtest-9187",
        WorkloadGroupName = "smallrc",
        WorkspaceName = "sqlcrudtest-2080",
    });

});

    package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewSqlPoolWorkloadGroup(ctx, "sqlPoolWorkloadGroup", &synapse.SqlPoolWorkloadGroupArgs{
			Importance:                   pulumi.String("normal"),
			MaxResourcePercent:           pulumi.Int(100),
			MaxResourcePercentPerRequest: pulumi.Float64(3),
			MinResourcePercent:           pulumi.Int(0),
			MinResourcePercentPerRequest: pulumi.Float64(3),
			QueryExecutionTimeout:        pulumi.Int(0),
			ResourceGroupName:            pulumi.String("sqlcrudtest-6852"),
			SqlPoolName:                  pulumi.String("sqlcrudtest-9187"),
			WorkloadGroupName:            pulumi.String("smallrc"),
			WorkspaceName:                pulumi.String("sqlcrudtest-2080"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.SqlPoolWorkloadGroup;
import com.pulumi.azurenative.synapse.SqlPoolWorkloadGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sqlPoolWorkloadGroup = new SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", SqlPoolWorkloadGroupArgs.builder()
            .importance("normal")
            .maxResourcePercent(100)
            .maxResourcePercentPerRequest(3)
            .minResourcePercent(0)
            .minResourcePercentPerRequest(3)
            .queryExecutionTimeout(0)
            .resourceGroupName("sqlcrudtest-6852")
            .sqlPoolName("sqlcrudtest-9187")
            .workloadGroupName("smallrc")
            .workspaceName("sqlcrudtest-2080")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlPoolWorkloadGroup = new azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", {
    importance: "normal",
    maxResourcePercent: 100,
    maxResourcePercentPerRequest: 3,
    minResourcePercent: 0,
    minResourcePercentPerRequest: 3,
    queryExecutionTimeout: 0,
    resourceGroupName: "sqlcrudtest-6852",
    sqlPoolName: "sqlcrudtest-9187",
    workloadGroupName: "smallrc",
    workspaceName: "sqlcrudtest-2080",
});

    import pulumi
import pulumi_azure_native as azure_native

sql_pool_workload_group = azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup",
    importance="normal",
    max_resource_percent=100,
    max_resource_percent_per_request=3,
    min_resource_percent=0,
    min_resource_percent_per_request=3,
    query_execution_timeout=0,
    resource_group_name="sqlcrudtest-6852",
    sql_pool_name="sqlcrudtest-9187",
    workload_group_name="smallrc",
    workspace_name="sqlcrudtest-2080")

    resources:
  sqlPoolWorkloadGroup:
    type: azure-native:synapse:SqlPoolWorkloadGroup
    properties:
      importance: normal
      maxResourcePercent: 100
      maxResourcePercentPerRequest: 3
      minResourcePercent: 0
      minResourcePercentPerRequest: 3
      queryExecutionTimeout: 0
      resourceGroupName: sqlcrudtest-6852
      sqlPoolName: sqlcrudtest-9187
      workloadGroupName: smallrc
      workspaceName: sqlcrudtest-2080

    Create a workload group with the required properties specified.

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var sqlPoolWorkloadGroup = new AzureNative.Synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", new()
    {
        MaxResourcePercent = 100,
        MinResourcePercent = 0,
        MinResourcePercentPerRequest = 3,
        ResourceGroupName = "sqlcrudtest-6852",
        SqlPoolName = "sqlcrudtest-9187",
        WorkloadGroupName = "smallrc",
        WorkspaceName = "sqlcrudtest-2080",
    });

});

    package main

import (
	synapse "github.com/pulumi/pulumi-azure-native-sdk/synapse/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := synapse.NewSqlPoolWorkloadGroup(ctx, "sqlPoolWorkloadGroup", &synapse.SqlPoolWorkloadGroupArgs{
			MaxResourcePercent:           pulumi.Int(100),
			MinResourcePercent:           pulumi.Int(0),
			MinResourcePercentPerRequest: pulumi.Float64(3),
			ResourceGroupName:            pulumi.String("sqlcrudtest-6852"),
			SqlPoolName:                  pulumi.String("sqlcrudtest-9187"),
			WorkloadGroupName:            pulumi.String("smallrc"),
			WorkspaceName:                pulumi.String("sqlcrudtest-2080"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.synapse.SqlPoolWorkloadGroup;
import com.pulumi.azurenative.synapse.SqlPoolWorkloadGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sqlPoolWorkloadGroup = new SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", SqlPoolWorkloadGroupArgs.builder()
            .maxResourcePercent(100)
            .minResourcePercent(0)
            .minResourcePercentPerRequest(3)
            .resourceGroupName("sqlcrudtest-6852")
            .sqlPoolName("sqlcrudtest-9187")
            .workloadGroupName("smallrc")
            .workspaceName("sqlcrudtest-2080")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const sqlPoolWorkloadGroup = new azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup", {
    maxResourcePercent: 100,
    minResourcePercent: 0,
    minResourcePercentPerRequest: 3,
    resourceGroupName: "sqlcrudtest-6852",
    sqlPoolName: "sqlcrudtest-9187",
    workloadGroupName: "smallrc",
    workspaceName: "sqlcrudtest-2080",
});

    import pulumi
import pulumi_azure_native as azure_native

sql_pool_workload_group = azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroup",
    max_resource_percent=100,
    min_resource_percent=0,
    min_resource_percent_per_request=3,
    resource_group_name="sqlcrudtest-6852",
    sql_pool_name="sqlcrudtest-9187",
    workload_group_name="smallrc",
    workspace_name="sqlcrudtest-2080")

    resources:
  sqlPoolWorkloadGroup:
    type: azure-native:synapse:SqlPoolWorkloadGroup
    properties:
      maxResourcePercent: 100
      minResourcePercent: 0
      minResourcePercentPerRequest: 3
      resourceGroupName: sqlcrudtest-6852
      sqlPoolName: sqlcrudtest-9187
      workloadGroupName: smallrc
      workspaceName: sqlcrudtest-2080

    Create SqlPoolWorkloadGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SqlPoolWorkloadGroup(name: string, args: SqlPoolWorkloadGroupArgs, opts?: CustomResourceOptions);
    @overload
def SqlPoolWorkloadGroup(resource_name: str,
                         args: SqlPoolWorkloadGroupArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def SqlPoolWorkloadGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         max_resource_percent: Optional[int] = None,
                         min_resource_percent: Optional[int] = None,
                         min_resource_percent_per_request: Optional[float] = None,
                         resource_group_name: Optional[str] = None,
                         sql_pool_name: Optional[str] = None,
                         workspace_name: Optional[str] = None,
                         importance: Optional[str] = None,
                         max_resource_percent_per_request: Optional[float] = None,
                         query_execution_timeout: Optional[int] = None,
                         workload_group_name: Optional[str] = None)
    func NewSqlPoolWorkloadGroup(ctx *Context, name string, args SqlPoolWorkloadGroupArgs, opts ...ResourceOption) (*SqlPoolWorkloadGroup, error)
    public SqlPoolWorkloadGroup(string name, SqlPoolWorkloadGroupArgs args, CustomResourceOptions? opts = null)
    public SqlPoolWorkloadGroup(String name, SqlPoolWorkloadGroupArgs args)
public SqlPoolWorkloadGroup(String name, SqlPoolWorkloadGroupArgs args, CustomResourceOptions options)

    type: azure-native:synapse:SqlPoolWorkloadGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SqlPoolWorkloadGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlPoolWorkloadGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlPoolWorkloadGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlPoolWorkloadGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlPoolWorkloadGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sqlPoolWorkloadGroupResource = new AzureNative.Synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", new()
{
    MaxResourcePercent = 0,
    MinResourcePercent = 0,
    MinResourcePercentPerRequest = 0,
    ResourceGroupName = "string",
    SqlPoolName = "string",
    WorkspaceName = "string",
    Importance = "string",
    MaxResourcePercentPerRequest = 0,
    QueryExecutionTimeout = 0,
    WorkloadGroupName = "string",
});

    example, err := synapse.NewSqlPoolWorkloadGroup(ctx, "sqlPoolWorkloadGroupResource", &synapse.SqlPoolWorkloadGroupArgs{
	MaxResourcePercent:           pulumi.Int(0),
	MinResourcePercent:           pulumi.Int(0),
	MinResourcePercentPerRequest: pulumi.Float64(0),
	ResourceGroupName:            pulumi.String("string"),
	SqlPoolName:                  pulumi.String("string"),
	WorkspaceName:                pulumi.String("string"),
	Importance:                   pulumi.String("string"),
	MaxResourcePercentPerRequest: pulumi.Float64(0),
	QueryExecutionTimeout:        pulumi.Int(0),
	WorkloadGroupName:            pulumi.String("string"),
})

    var sqlPoolWorkloadGroupResource = new SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", SqlPoolWorkloadGroupArgs.builder()
    .maxResourcePercent(0)
    .minResourcePercent(0)
    .minResourcePercentPerRequest(0)
    .resourceGroupName("string")
    .sqlPoolName("string")
    .workspaceName("string")
    .importance("string")
    .maxResourcePercentPerRequest(0)
    .queryExecutionTimeout(0)
    .workloadGroupName("string")
    .build());

    sql_pool_workload_group_resource = azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource",
    max_resource_percent=0,
    min_resource_percent=0,
    min_resource_percent_per_request=0,
    resource_group_name="string",
    sql_pool_name="string",
    workspace_name="string",
    importance="string",
    max_resource_percent_per_request=0,
    query_execution_timeout=0,
    workload_group_name="string")

    const sqlPoolWorkloadGroupResource = new azure_native.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", {
    maxResourcePercent: 0,
    minResourcePercent: 0,
    minResourcePercentPerRequest: 0,
    resourceGroupName: "string",
    sqlPoolName: "string",
    workspaceName: "string",
    importance: "string",
    maxResourcePercentPerRequest: 0,
    queryExecutionTimeout: 0,
    workloadGroupName: "string",
});

    type: azure-native:synapse:SqlPoolWorkloadGroup
properties:
    importance: string
    maxResourcePercent: 0
    maxResourcePercentPerRequest: 0
    minResourcePercent: 0
    minResourcePercentPerRequest: 0
    queryExecutionTimeout: 0
    resourceGroupName: string
    sqlPoolName: string
    workloadGroupName: string
    workspaceName: string

    SqlPoolWorkloadGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SqlPoolWorkloadGroup resource accepts the following input properties:

    MaxResourcePercent int
    The workload group cap percentage resource.
    MinResourcePercent int
    The workload group minimum percentage resource.
    MinResourcePercentPerRequest double
    The workload group request minimum grant percentage.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SqlPoolName string
    SQL pool name
    WorkspaceName string
    The name of the workspace.
    Importance string
    The workload group importance level.
    MaxResourcePercentPerRequest double
    The workload group request maximum grant percentage.
    QueryExecutionTimeout int
    The workload group query execution timeout.
    WorkloadGroupName string
    The name of the workload group.
    MaxResourcePercent int
    The workload group cap percentage resource.
    MinResourcePercent int
    The workload group minimum percentage resource.
    MinResourcePercentPerRequest float64
    The workload group request minimum grant percentage.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SqlPoolName string
    SQL pool name
    WorkspaceName string
    The name of the workspace.
    Importance string
    The workload group importance level.
    MaxResourcePercentPerRequest float64
    The workload group request maximum grant percentage.
    QueryExecutionTimeout int
    The workload group query execution timeout.
    WorkloadGroupName string
    The name of the workload group.
    maxResourcePercent Integer
    The workload group cap percentage resource.
    minResourcePercent Integer
    The workload group minimum percentage resource.
    minResourcePercentPerRequest Double
    The workload group request minimum grant percentage.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sqlPoolName String
    SQL pool name
    workspaceName String
    The name of the workspace.
    importance String
    The workload group importance level.
    maxResourcePercentPerRequest Double
    The workload group request maximum grant percentage.
    queryExecutionTimeout Integer
    The workload group query execution timeout.
    workloadGroupName String
    The name of the workload group.
    maxResourcePercent number
    The workload group cap percentage resource.
    minResourcePercent number
    The workload group minimum percentage resource.
    minResourcePercentPerRequest number
    The workload group request minimum grant percentage.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    sqlPoolName string
    SQL pool name
    workspaceName string
    The name of the workspace.
    importance string
    The workload group importance level.
    maxResourcePercentPerRequest number
    The workload group request maximum grant percentage.
    queryExecutionTimeout number
    The workload group query execution timeout.
    workloadGroupName string
    The name of the workload group.
    max_resource_percent int
    The workload group cap percentage resource.
    min_resource_percent int
    The workload group minimum percentage resource.
    min_resource_percent_per_request float
    The workload group request minimum grant percentage.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    sql_pool_name str
    SQL pool name
    workspace_name str
    The name of the workspace.
    importance str
    The workload group importance level.
    max_resource_percent_per_request float
    The workload group request maximum grant percentage.
    query_execution_timeout int
    The workload group query execution timeout.
    workload_group_name str
    The name of the workload group.
    maxResourcePercent Number
    The workload group cap percentage resource.
    minResourcePercent Number
    The workload group minimum percentage resource.
    minResourcePercentPerRequest Number
    The workload group request minimum grant percentage.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    sqlPoolName String
    SQL pool name
    workspaceName String
    The name of the workspace.
    importance String
    The workload group importance level.
    maxResourcePercentPerRequest Number
    The workload group request maximum grant percentage.
    queryExecutionTimeout Number
    The workload group query execution timeout.
    workloadGroupName String
    The name of the workload group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlPoolWorkloadGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:synapse:SqlPoolWorkloadGroup smallrc /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/workloadGroups/{workloadGroupName}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native