Set-DbaRgWorkloadGroup

Want to see the source code for this command? Check out Set-DbaRgWorkloadGroup on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaRgWorkloadGroup.

Synopsis

Modifies Resource Governor workload group settings to control query resource consumption and limits.

Description

Modifies configuration settings for Resource Governor workload groups, which control how SQL Server allocates CPU, memory, and parallelism resources to different categories of queries and connections.
Use this function to adjust resource limits for specific workload groups when you need to prioritize critical applications, limit resource-hungry queries, or enforce service level agreements through resource allocation policies.
Changes automatically trigger a Resource Governor reconfiguration unless skipped, and plan-affecting settings only apply to new query plans after clearing the procedure cache.
Supports both internal resource pools (standard workloads) and external resource pools (R/Python integration scenarios).

Syntax

Set-DbaRgWorkloadGroup
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-WorkloadGroup] <String[]>]
    [[-ResourcePool] <String>]
    [[-ResourcePoolType] <String>]
    [[-Importance] <String>]
    [[-RequestMaximumMemoryGrantPercentage] <Int32>]
    [[-RequestMaximumCpuTimeInSeconds] <Int32>]
    [[-RequestMemoryGrantTimeoutInSeconds] <Int32>]
    [[-MaximumDegreeOfParallelism] <Int32>]
    [[-GroupMaximumRequests] <Int32>]
    [-SkipReconfigure]
    [[-InputObject] <WorkloadGroup[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Set-DbaRgWorkloadGroup -SqlInstance sql2016 -WorkloadGroup "groupAdmin" -ResourcePool "poolAdmin"

Configures a workload group named "groupAdmin" in the resource pool "poolAdmin" for the instance sql2016.

Example: 2

PS C:\> Get-DbaRgWorkloadGroup | Where-Object Name -eq "groupSuperUsers" | Set-DbaRgWorkloadGroup -GroupMaximumRequests 2

Configures a workload group named "groupSuperUsers" by setting the maximum number of group requests to 2 for the instance sql2016.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

-SqlCredential

Credential object used to connect to the Windows server as a different user

-WorkloadGroup

Name of the specific workload group to modify within the resource pool.
Use this to target individual workload groups when you need to adjust resource limits for specific application categories or user groups.

-ResourcePool

Name of the resource pool that contains the workload group to be modified.
Required when specifying WorkloadGroup by name rather than piping from Get-DbaRgWorkloadGroup.

-ResourcePoolType

Specifies whether to target Internal resource pools (standard SQL workloads) or External resource pools (R/Python integration scenarios).
Choose Internal for typical database workloads, or External when managing Machine Learning Services resource allocation.

-Importance

Sets the relative priority level for requests within this workload group compared to other groups in the same resource pool.
Use HIGH for critical business applications, MEDIUM for standard workloads, or LOW for background processes that can tolerate delays.

-RequestMaximumMemoryGrantPercentage

Sets the maximum percentage of the resource pool's memory that any single query can request for operations like sorting and hashing.
Values range from 1-100 percent. Use lower values to prevent single queries from monopolizing memory resources.

-RequestMaximumCpuTimeInSeconds

Defines the maximum CPU time in seconds that any single request can consume before being terminated.
Set this to prevent runaway queries from consuming excessive CPU resources. Use 0 for unlimited CPU time.

-RequestMemoryGrantTimeoutInSeconds

Sets how long queries can wait for memory grants before timing out with insufficient memory errors.
Increase this for environments with heavy memory contention, or decrease to fail fast when memory is unavailable.

-MaximumDegreeOfParallelism

Controls the maximum number of parallel processors that queries in this workload group can use.
Override the server-level MAXDOP setting for specific workload groups to optimize resource allocation based on workload characteristics.

-GroupMaximumRequests

Limits the total number of concurrent requests that can execute simultaneously within this workload group.
Use this to prevent resource pool saturation by limiting how many queries from this group can run at once.

-SkipReconfigure

Prevents automatic Resource Governor reconfiguration after making workload group changes.
Use this when making multiple configuration changes and you want to reconfigure manually once at the end to minimize disruption.

-InputObject

Accepts workload group objects piped from Get-DbaRgWorkloadGroup for bulk configuration operations.
Allows you to modify multiple workload groups across different instances in a single pipeline operation.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.