1. Packages
  2. Azure Classic
  3. API Docs
  4. synapse
  5. SqlPoolWorkloadGroup

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.synapse.SqlPoolWorkloadGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages a Synapse SQL Pool Workload Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example",
        location: "west europe",
    });
    const exampleAccount = new azure.storage.Account("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        accountKind: "BlobStorage",
        accountTier: "Standard",
        accountReplicationType: "LRS",
    });
    const exampleDataLakeGen2Filesystem = new azure.storage.DataLakeGen2Filesystem("example", {
        name: "example",
        storageAccountId: exampleAccount.id,
    });
    const exampleWorkspace = new azure.synapse.Workspace("example", {
        name: "example",
        resourceGroupName: example.name,
        location: example.location,
        storageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.id,
        sqlAdministratorLogin: "sqladminuser",
        sqlAdministratorLoginPassword: "H@Sh1CoR3!",
        identity: {
            type: "SystemAssigned",
        },
    });
    const exampleSqlPool = new azure.synapse.SqlPool("example", {
        name: "example",
        synapseWorkspaceId: exampleWorkspace.id,
        skuName: "DW100c",
        createMode: "Default",
    });
    const exampleSqlPoolWorkloadGroup = new azure.synapse.SqlPoolWorkloadGroup("example", {
        name: "example",
        sqlPoolId: exampleSqlPool.id,
        importance: "normal",
        maxResourcePercent: 100,
        minResourcePercent: 0,
        maxResourcePercentPerRequest: 3,
        minResourcePercentPerRequest: 3,
        queryExecutionTimeoutInSeconds: 0,
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example",
        location="west europe")
    example_account = azure.storage.Account("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        account_kind="BlobStorage",
        account_tier="Standard",
        account_replication_type="LRS")
    example_data_lake_gen2_filesystem = azure.storage.DataLakeGen2Filesystem("example",
        name="example",
        storage_account_id=example_account.id)
    example_workspace = azure.synapse.Workspace("example",
        name="example",
        resource_group_name=example.name,
        location=example.location,
        storage_data_lake_gen2_filesystem_id=example_data_lake_gen2_filesystem.id,
        sql_administrator_login="sqladminuser",
        sql_administrator_login_password="H@Sh1CoR3!",
        identity=azure.synapse.WorkspaceIdentityArgs(
            type="SystemAssigned",
        ))
    example_sql_pool = azure.synapse.SqlPool("example",
        name="example",
        synapse_workspace_id=example_workspace.id,
        sku_name="DW100c",
        create_mode="Default")
    example_sql_pool_workload_group = azure.synapse.SqlPoolWorkloadGroup("example",
        name="example",
        sql_pool_id=example_sql_pool.id,
        importance="normal",
        max_resource_percent=100,
        min_resource_percent=0,
        max_resource_percent_per_request=3,
        min_resource_percent_per_request=3,
        query_execution_timeout_in_seconds=0)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/synapse"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("west europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
    			Name:                   pulumi.String("example"),
    			ResourceGroupName:      example.Name,
    			Location:               example.Location,
    			AccountKind:            pulumi.String("BlobStorage"),
    			AccountTier:            pulumi.String("Standard"),
    			AccountReplicationType: pulumi.String("LRS"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleDataLakeGen2Filesystem, err := storage.NewDataLakeGen2Filesystem(ctx, "example", &storage.DataLakeGen2FilesystemArgs{
    			Name:             pulumi.String("example"),
    			StorageAccountId: exampleAccount.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := synapse.NewWorkspace(ctx, "example", &synapse.WorkspaceArgs{
    			Name:                            pulumi.String("example"),
    			ResourceGroupName:               example.Name,
    			Location:                        example.Location,
    			StorageDataLakeGen2FilesystemId: exampleDataLakeGen2Filesystem.ID(),
    			SqlAdministratorLogin:           pulumi.String("sqladminuser"),
    			SqlAdministratorLoginPassword:   pulumi.String("H@Sh1CoR3!"),
    			Identity: &synapse.WorkspaceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleSqlPool, err := synapse.NewSqlPool(ctx, "example", &synapse.SqlPoolArgs{
    			Name:               pulumi.String("example"),
    			SynapseWorkspaceId: exampleWorkspace.ID(),
    			SkuName:            pulumi.String("DW100c"),
    			CreateMode:         pulumi.String("Default"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = synapse.NewSqlPoolWorkloadGroup(ctx, "example", &synapse.SqlPoolWorkloadGroupArgs{
    			Name:                           pulumi.String("example"),
    			SqlPoolId:                      exampleSqlPool.ID(),
    			Importance:                     pulumi.String("normal"),
    			MaxResourcePercent:             pulumi.Int(100),
    			MinResourcePercent:             pulumi.Int(0),
    			MaxResourcePercentPerRequest:   pulumi.Float64(3),
    			MinResourcePercentPerRequest:   pulumi.Float64(3),
    			QueryExecutionTimeoutInSeconds: pulumi.Int(0),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example",
            Location = "west europe",
        });
    
        var exampleAccount = new Azure.Storage.Account("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            AccountKind = "BlobStorage",
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
    
        var exampleDataLakeGen2Filesystem = new Azure.Storage.DataLakeGen2Filesystem("example", new()
        {
            Name = "example",
            StorageAccountId = exampleAccount.Id,
        });
    
        var exampleWorkspace = new Azure.Synapse.Workspace("example", new()
        {
            Name = "example",
            ResourceGroupName = example.Name,
            Location = example.Location,
            StorageDataLakeGen2FilesystemId = exampleDataLakeGen2Filesystem.Id,
            SqlAdministratorLogin = "sqladminuser",
            SqlAdministratorLoginPassword = "H@Sh1CoR3!",
            Identity = new Azure.Synapse.Inputs.WorkspaceIdentityArgs
            {
                Type = "SystemAssigned",
            },
        });
    
        var exampleSqlPool = new Azure.Synapse.SqlPool("example", new()
        {
            Name = "example",
            SynapseWorkspaceId = exampleWorkspace.Id,
            SkuName = "DW100c",
            CreateMode = "Default",
        });
    
        var exampleSqlPoolWorkloadGroup = new Azure.Synapse.SqlPoolWorkloadGroup("example", new()
        {
            Name = "example",
            SqlPoolId = exampleSqlPool.Id,
            Importance = "normal",
            MaxResourcePercent = 100,
            MinResourcePercent = 0,
            MaxResourcePercentPerRequest = 3,
            MinResourcePercentPerRequest = 3,
            QueryExecutionTimeoutInSeconds = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.storage.Account;
    import com.pulumi.azure.storage.AccountArgs;
    import com.pulumi.azure.storage.DataLakeGen2Filesystem;
    import com.pulumi.azure.storage.DataLakeGen2FilesystemArgs;
    import com.pulumi.azure.synapse.Workspace;
    import com.pulumi.azure.synapse.WorkspaceArgs;
    import com.pulumi.azure.synapse.inputs.WorkspaceIdentityArgs;
    import com.pulumi.azure.synapse.SqlPool;
    import com.pulumi.azure.synapse.SqlPoolArgs;
    import com.pulumi.azure.synapse.SqlPoolWorkloadGroup;
    import com.pulumi.azure.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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example")
                .location("west europe")
                .build());
    
            var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .accountKind("BlobStorage")
                .accountTier("Standard")
                .accountReplicationType("LRS")
                .build());
    
            var exampleDataLakeGen2Filesystem = new DataLakeGen2Filesystem("exampleDataLakeGen2Filesystem", DataLakeGen2FilesystemArgs.builder()
                .name("example")
                .storageAccountId(exampleAccount.id())
                .build());
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
                .name("example")
                .resourceGroupName(example.name())
                .location(example.location())
                .storageDataLakeGen2FilesystemId(exampleDataLakeGen2Filesystem.id())
                .sqlAdministratorLogin("sqladminuser")
                .sqlAdministratorLoginPassword("H@Sh1CoR3!")
                .identity(WorkspaceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .build());
    
            var exampleSqlPool = new SqlPool("exampleSqlPool", SqlPoolArgs.builder()
                .name("example")
                .synapseWorkspaceId(exampleWorkspace.id())
                .skuName("DW100c")
                .createMode("Default")
                .build());
    
            var exampleSqlPoolWorkloadGroup = new SqlPoolWorkloadGroup("exampleSqlPoolWorkloadGroup", SqlPoolWorkloadGroupArgs.builder()
                .name("example")
                .sqlPoolId(exampleSqlPool.id())
                .importance("normal")
                .maxResourcePercent(100)
                .minResourcePercent(0)
                .maxResourcePercentPerRequest(3)
                .minResourcePercentPerRequest(3)
                .queryExecutionTimeoutInSeconds(0)
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example
          location: west europe
      exampleAccount:
        type: azure:storage:Account
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          accountKind: BlobStorage
          accountTier: Standard
          accountReplicationType: LRS
      exampleDataLakeGen2Filesystem:
        type: azure:storage:DataLakeGen2Filesystem
        name: example
        properties:
          name: example
          storageAccountId: ${exampleAccount.id}
      exampleWorkspace:
        type: azure:synapse:Workspace
        name: example
        properties:
          name: example
          resourceGroupName: ${example.name}
          location: ${example.location}
          storageDataLakeGen2FilesystemId: ${exampleDataLakeGen2Filesystem.id}
          sqlAdministratorLogin: sqladminuser
          sqlAdministratorLoginPassword: H@Sh1CoR3!
          identity:
            type: SystemAssigned
      exampleSqlPool:
        type: azure:synapse:SqlPool
        name: example
        properties:
          name: example
          synapseWorkspaceId: ${exampleWorkspace.id}
          skuName: DW100c
          createMode: Default
      exampleSqlPoolWorkloadGroup:
        type: azure:synapse:SqlPoolWorkloadGroup
        name: example
        properties:
          name: example
          sqlPoolId: ${exampleSqlPool.id}
          importance: normal
          maxResourcePercent: 100
          minResourcePercent: 0
          maxResourcePercentPerRequest: 3
          minResourcePercentPerRequest: 3
          queryExecutionTimeoutInSeconds: 0
    

    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,
                             sql_pool_id: Optional[str] = None,
                             importance: Optional[str] = None,
                             max_resource_percent_per_request: Optional[float] = None,
                             min_resource_percent_per_request: Optional[float] = None,
                             name: Optional[str] = None,
                             query_execution_timeout_in_seconds: Optional[int] = 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: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.

    Example

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

    var sqlPoolWorkloadGroupResource = new Azure.Synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", new()
    {
        MaxResourcePercent = 0,
        MinResourcePercent = 0,
        SqlPoolId = "string",
        Importance = "string",
        MaxResourcePercentPerRequest = 0,
        MinResourcePercentPerRequest = 0,
        Name = "string",
        QueryExecutionTimeoutInSeconds = 0,
    });
    
    example, err := synapse.NewSqlPoolWorkloadGroup(ctx, "sqlPoolWorkloadGroupResource", &synapse.SqlPoolWorkloadGroupArgs{
    	MaxResourcePercent:             pulumi.Int(0),
    	MinResourcePercent:             pulumi.Int(0),
    	SqlPoolId:                      pulumi.String("string"),
    	Importance:                     pulumi.String("string"),
    	MaxResourcePercentPerRequest:   pulumi.Float64(0),
    	MinResourcePercentPerRequest:   pulumi.Float64(0),
    	Name:                           pulumi.String("string"),
    	QueryExecutionTimeoutInSeconds: pulumi.Int(0),
    })
    
    var sqlPoolWorkloadGroupResource = new SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", SqlPoolWorkloadGroupArgs.builder()
        .maxResourcePercent(0)
        .minResourcePercent(0)
        .sqlPoolId("string")
        .importance("string")
        .maxResourcePercentPerRequest(0)
        .minResourcePercentPerRequest(0)
        .name("string")
        .queryExecutionTimeoutInSeconds(0)
        .build());
    
    sql_pool_workload_group_resource = azure.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource",
        max_resource_percent=0,
        min_resource_percent=0,
        sql_pool_id="string",
        importance="string",
        max_resource_percent_per_request=0,
        min_resource_percent_per_request=0,
        name="string",
        query_execution_timeout_in_seconds=0)
    
    const sqlPoolWorkloadGroupResource = new azure.synapse.SqlPoolWorkloadGroup("sqlPoolWorkloadGroupResource", {
        maxResourcePercent: 0,
        minResourcePercent: 0,
        sqlPoolId: "string",
        importance: "string",
        maxResourcePercentPerRequest: 0,
        minResourcePercentPerRequest: 0,
        name: "string",
        queryExecutionTimeoutInSeconds: 0,
    });
    
    type: azure:synapse:SqlPoolWorkloadGroup
    properties:
        importance: string
        maxResourcePercent: 0
        maxResourcePercentPerRequest: 0
        minResourcePercent: 0
        minResourcePercentPerRequest: 0
        name: string
        queryExecutionTimeoutInSeconds: 0
        sqlPoolId: 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

    The SqlPoolWorkloadGroup resource accepts the following input properties:

    MaxResourcePercent int
    The workload group cap percentage resource.
    MinResourcePercent int
    The workload group minimum percentage resource.
    SqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    Importance string
    The workload group importance level. Defaults to normal.
    MaxResourcePercentPerRequest double
    The workload group request maximum grant percentage. Defaults to 3.
    MinResourcePercentPerRequest double
    The workload group request minimum grant percentage.
    Name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    QueryExecutionTimeoutInSeconds int
    The workload group query execution timeout.
    MaxResourcePercent int
    The workload group cap percentage resource.
    MinResourcePercent int
    The workload group minimum percentage resource.
    SqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    Importance string
    The workload group importance level. Defaults to normal.
    MaxResourcePercentPerRequest float64
    The workload group request maximum grant percentage. Defaults to 3.
    MinResourcePercentPerRequest float64
    The workload group request minimum grant percentage.
    Name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    QueryExecutionTimeoutInSeconds int
    The workload group query execution timeout.
    maxResourcePercent Integer
    The workload group cap percentage resource.
    minResourcePercent Integer
    The workload group minimum percentage resource.
    sqlPoolId String
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance String
    The workload group importance level. Defaults to normal.
    maxResourcePercentPerRequest Double
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercentPerRequest Double
    The workload group request minimum grant percentage.
    name String
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds Integer
    The workload group query execution timeout.
    maxResourcePercent number
    The workload group cap percentage resource.
    minResourcePercent number
    The workload group minimum percentage resource.
    sqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance string
    The workload group importance level. Defaults to normal.
    maxResourcePercentPerRequest number
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercentPerRequest number
    The workload group request minimum grant percentage.
    name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds number
    The workload group query execution timeout.
    max_resource_percent int
    The workload group cap percentage resource.
    min_resource_percent int
    The workload group minimum percentage resource.
    sql_pool_id str
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance str
    The workload group importance level. Defaults to normal.
    max_resource_percent_per_request float
    The workload group request maximum grant percentage. Defaults to 3.
    min_resource_percent_per_request float
    The workload group request minimum grant percentage.
    name str
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    query_execution_timeout_in_seconds int
    The workload group query execution timeout.
    maxResourcePercent Number
    The workload group cap percentage resource.
    minResourcePercent Number
    The workload group minimum percentage resource.
    sqlPoolId String
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance String
    The workload group importance level. Defaults to normal.
    maxResourcePercentPerRequest Number
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercentPerRequest Number
    The workload group request minimum grant percentage.
    name String
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds Number
    The workload group query execution timeout.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlPoolWorkloadGroup Resource

    Get an existing SqlPoolWorkloadGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SqlPoolWorkloadGroupState, opts?: CustomResourceOptions): SqlPoolWorkloadGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            importance: Optional[str] = None,
            max_resource_percent: Optional[int] = None,
            max_resource_percent_per_request: Optional[float] = None,
            min_resource_percent: Optional[int] = None,
            min_resource_percent_per_request: Optional[float] = None,
            name: Optional[str] = None,
            query_execution_timeout_in_seconds: Optional[int] = None,
            sql_pool_id: Optional[str] = None) -> SqlPoolWorkloadGroup
    func GetSqlPoolWorkloadGroup(ctx *Context, name string, id IDInput, state *SqlPoolWorkloadGroupState, opts ...ResourceOption) (*SqlPoolWorkloadGroup, error)
    public static SqlPoolWorkloadGroup Get(string name, Input<string> id, SqlPoolWorkloadGroupState? state, CustomResourceOptions? opts = null)
    public static SqlPoolWorkloadGroup get(String name, Output<String> id, SqlPoolWorkloadGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Importance string
    The workload group importance level. Defaults to normal.
    MaxResourcePercent int
    The workload group cap percentage resource.
    MaxResourcePercentPerRequest double
    The workload group request maximum grant percentage. Defaults to 3.
    MinResourcePercent int
    The workload group minimum percentage resource.
    MinResourcePercentPerRequest double
    The workload group request minimum grant percentage.
    Name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    QueryExecutionTimeoutInSeconds int
    The workload group query execution timeout.
    SqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    Importance string
    The workload group importance level. Defaults to normal.
    MaxResourcePercent int
    The workload group cap percentage resource.
    MaxResourcePercentPerRequest float64
    The workload group request maximum grant percentage. Defaults to 3.
    MinResourcePercent int
    The workload group minimum percentage resource.
    MinResourcePercentPerRequest float64
    The workload group request minimum grant percentage.
    Name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    QueryExecutionTimeoutInSeconds int
    The workload group query execution timeout.
    SqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance String
    The workload group importance level. Defaults to normal.
    maxResourcePercent Integer
    The workload group cap percentage resource.
    maxResourcePercentPerRequest Double
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercent Integer
    The workload group minimum percentage resource.
    minResourcePercentPerRequest Double
    The workload group request minimum grant percentage.
    name String
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds Integer
    The workload group query execution timeout.
    sqlPoolId String
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance string
    The workload group importance level. Defaults to normal.
    maxResourcePercent number
    The workload group cap percentage resource.
    maxResourcePercentPerRequest number
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercent number
    The workload group minimum percentage resource.
    minResourcePercentPerRequest number
    The workload group request minimum grant percentage.
    name string
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds number
    The workload group query execution timeout.
    sqlPoolId string
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance str
    The workload group importance level. Defaults to normal.
    max_resource_percent int
    The workload group cap percentage resource.
    max_resource_percent_per_request float
    The workload group request maximum grant percentage. Defaults to 3.
    min_resource_percent int
    The workload group minimum percentage resource.
    min_resource_percent_per_request float
    The workload group request minimum grant percentage.
    name str
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    query_execution_timeout_in_seconds int
    The workload group query execution timeout.
    sql_pool_id str
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    importance String
    The workload group importance level. Defaults to normal.
    maxResourcePercent Number
    The workload group cap percentage resource.
    maxResourcePercentPerRequest Number
    The workload group request maximum grant percentage. Defaults to 3.
    minResourcePercent Number
    The workload group minimum percentage resource.
    minResourcePercentPerRequest Number
    The workload group request minimum grant percentage.
    name String
    The name which should be used for this Synapse SQL Pool Workload Group. Changing this forces a new Synapse SQL Pool Workload Group to be created.
    queryExecutionTimeoutInSeconds Number
    The workload group query execution timeout.
    sqlPoolId String
    The ID of the Synapse SQL Pool. Changing this forces a new Synapse SQL Pool Workload Group to be created.

    Import

    Synapse SQL Pool Workload Groups can be imported using the resource id, e.g.

    $ pulumi import azure:synapse/sqlPoolWorkloadGroup:SqlPoolWorkloadGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.Synapse/workspaces/workspace1/sqlPools/sqlPool1/workloadGroups/workloadGroup1
    

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi