Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. synapse
  5. getSqlPoolWorkloadGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.synapse.getSqlPoolWorkloadGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Sql pool’s workload group.

Uses Azure REST API version 2021-06-01.

Other available API versions: 2021-04-01-preview, 2021-05-01, 2021-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native synapse [ApiVersion]. See the version guide for details.

Using getSqlPoolWorkloadGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSqlPoolWorkloadGroup(args: GetSqlPoolWorkloadGroupArgs, opts?: InvokeOptions): Promise<GetSqlPoolWorkloadGroupResult>
function getSqlPoolWorkloadGroupOutput(args: GetSqlPoolWorkloadGroupOutputArgs, opts?: InvokeOptions): Output<GetSqlPoolWorkloadGroupResult>
Copy
def get_sql_pool_workload_group(resource_group_name: Optional[str] = None,
                                sql_pool_name: Optional[str] = None,
                                workload_group_name: Optional[str] = None,
                                workspace_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetSqlPoolWorkloadGroupResult
def get_sql_pool_workload_group_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                sql_pool_name: Optional[pulumi.Input[str]] = None,
                                workload_group_name: Optional[pulumi.Input[str]] = None,
                                workspace_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetSqlPoolWorkloadGroupResult]
Copy
func LookupSqlPoolWorkloadGroup(ctx *Context, args *LookupSqlPoolWorkloadGroupArgs, opts ...InvokeOption) (*LookupSqlPoolWorkloadGroupResult, error)
func LookupSqlPoolWorkloadGroupOutput(ctx *Context, args *LookupSqlPoolWorkloadGroupOutputArgs, opts ...InvokeOption) LookupSqlPoolWorkloadGroupResultOutput
Copy

> Note: This function is named LookupSqlPoolWorkloadGroup in the Go SDK.

public static class GetSqlPoolWorkloadGroup 
{
    public static Task<GetSqlPoolWorkloadGroupResult> InvokeAsync(GetSqlPoolWorkloadGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlPoolWorkloadGroupResult> Invoke(GetSqlPoolWorkloadGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSqlPoolWorkloadGroupResult> getSqlPoolWorkloadGroup(GetSqlPoolWorkloadGroupArgs args, InvokeOptions options)
public static Output<GetSqlPoolWorkloadGroupResult> getSqlPoolWorkloadGroup(GetSqlPoolWorkloadGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:synapse:getSqlPoolWorkloadGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
WorkloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
WorkloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
String
SQL pool name
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workload group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
string
SQL pool name
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workspace.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
sql_pool_name
This property is required.
Changes to this property will trigger replacement.
str
SQL pool name
workload_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workload group.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workspace.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
sqlPoolName
This property is required.
Changes to this property will trigger replacement.
String
SQL pool name
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workload group.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workspace.

getSqlPoolWorkloadGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Importance string
The workload group importance level.
MaxResourcePercentPerRequest double
The workload group request maximum grant percentage.
QueryExecutionTimeout int
The workload group query execution timeout.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Importance string
The workload group importance level.
MaxResourcePercentPerRequest float64
The workload group request maximum grant percentage.
QueryExecutionTimeout int
The workload group query execution timeout.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
importance String
The workload group importance level.
maxResourcePercentPerRequest Double
The workload group request maximum grant percentage.
queryExecutionTimeout Integer
The workload group query execution timeout.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
importance string
The workload group importance level.
maxResourcePercentPerRequest number
The workload group request maximum grant percentage.
queryExecutionTimeout number
The workload group query execution timeout.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
importance String
The workload group importance level.
maxResourcePercentPerRequest Number
The workload group request maximum grant percentage.
queryExecutionTimeout Number
The workload group query execution timeout.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native