Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. getWorkloadGroup
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.sql.getWorkloadGroup

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a workload group

    Uses Azure REST API version 2023-08-01.

    Other available API versions: 2019-06-01-preview, 2020-02-02-preview, 2020-08-01-preview, 2020-11-01-preview, 2021-02-01-preview, 2021-05-01-preview, 2021-08-01-preview, 2021-11-01, 2021-11-01-preview, 2022-02-01-preview, 2022-05-01-preview, 2022-08-01-preview, 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native sql [ApiVersion]. See the version guide for details.

    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>
    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]
    func LookupWorkloadGroup(ctx *Context, args *LookupWorkloadGroupArgs, opts ...InvokeOption) (*LookupWorkloadGroupResult, error)
func LookupWorkloadGroupOutput(ctx *Context, args *LookupWorkloadGroupOutputArgs, opts ...InvokeOption) LookupWorkloadGroupResultOutput

    > 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)
}
    public static CompletableFuture<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)
public static Output<GetWorkloadGroupResult> getWorkloadGroup(GetWorkloadGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:sql:getWorkloadGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database.
    ResourceGroupName 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 string
    The name of the server.
    WorkloadGroupName string
    The name of the workload group.
    DatabaseName string
    The name of the database.
    ResourceGroupName 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 string
    The name of the server.
    WorkloadGroupName string
    The name of the workload group.
    databaseName String
    The name of the database.
    resourceGroupName 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 String
    The name of the server.
    workloadGroupName String
    The name of the workload group.
    databaseName string
    The name of the database.
    resourceGroupName 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 string
    The name of the server.
    workloadGroupName string
    The name of the workload group.
    database_name str
    The name of the database.
    resource_group_name 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 str
    The name of the server.
    workload_group_name str
    The name of the workload group.
    databaseName String
    The name of the database.
    resourceGroupName 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 String
    The name of the server.
    workloadGroupName String
    The name of the workload group.

    getWorkloadGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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.
    azureApiVersion string
    The Azure API version of the resource.
    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.
    azure_api_version str
    The Azure API version of the resource.
    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.
    azureApiVersion String
    The Azure API version of the resource.
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native