Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. sql
  5. getWorkloadGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.sql.getWorkloadGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a workload group Azure REST API version: 2021-11-01.

Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview.

Using getWorkloadGroup

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 getWorkloadGroup(args: GetWorkloadGroupArgs, opts?: InvokeOptions): Promise<GetWorkloadGroupResult>
function getWorkloadGroupOutput(args: GetWorkloadGroupOutputArgs, opts?: InvokeOptions): Output<GetWorkloadGroupResult>
Copy
def get_workload_group(database_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       workload_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetWorkloadGroupResult
def get_workload_group_output(database_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       server_name: Optional[pulumi.Input[str]] = None,
                       workload_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetWorkloadGroupResult]
Copy
func LookupWorkloadGroup(ctx *Context, args *LookupWorkloadGroupArgs, opts ...InvokeOption) (*LookupWorkloadGroupResult, error)
func LookupWorkloadGroupOutput(ctx *Context, args *LookupWorkloadGroupOutputArgs, opts ...InvokeOption) LookupWorkloadGroupResultOutput
Copy

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

public static class GetWorkloadGroup 
{
    public static Task<GetWorkloadGroupResult> InvokeAsync(GetWorkloadGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkloadGroupResult> Invoke(GetWorkloadGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)
public static Output<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:sql:getWorkloadGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
WorkloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
WorkloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workload group.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the workload group.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
workload_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the workload group.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
workloadGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the workload group.

getWorkloadGroup Result

The following output properties are available:

Id string
Resource ID.
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
Resource name.
Type string
Resource type.
Importance string
The workload group importance level.
MaxResourcePercentPerRequest double
The workload group request maximum grant percentage.
QueryExecutionTimeout int
The workload group query execution timeout.
Id string
Resource ID.
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
Resource name.
Type string
Resource type.
Importance string
The workload group importance level.
MaxResourcePercentPerRequest float64
The workload group request maximum grant percentage.
QueryExecutionTimeout int
The workload group query execution timeout.
id String
Resource ID.
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
Resource name.
type String
Resource type.
importance String
The workload group importance level.
maxResourcePercentPerRequest Double
The workload group request maximum grant percentage.
queryExecutionTimeout Integer
The workload group query execution timeout.
id string
Resource ID.
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
Resource name.
type string
Resource type.
importance string
The workload group importance level.
maxResourcePercentPerRequest number
The workload group request maximum grant percentage.
queryExecutionTimeout number
The workload group query execution timeout.
id str
Resource ID.
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
Resource name.
type str
Resource type.
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.
id String
Resource ID.
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
Resource name.
type String
Resource type.
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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native