Edit

Share via


Set-AppBackgroundTaskResourcePolicy

Configures the use of the global pool by background tasks.

Syntax

Default (Default)

Set-AppBackgroundTaskResourcePolicy
    -Mode <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AppBackgroundTaskResourcePolicy cmdlet configures the use of the global pool by background tasks. The global pool is a shared resource that provides CPU or network resources when an application requires additional resources to complete a task. You must have administrator access to set the background task resource policy.

Examples

Example 1: Set global resource policy to Conservative mode

PS C:\> Set-AppBackgroundTaskResourcePolicy -Mode Conservative

This command sets the global resource policy for background tasks to Conservative, which ensures that background tasks use the minimum CPU.

Example 2: Set global resource policy to Normal mode

PS C:\> Set-AppBackgroundTaskResourcePolicy -Mode Normal

This command sets the global resource policy for background tasks to Normal. A restart is required if the previous setting was Conservative.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Mode

Specifies the global pool settings for background tasks on the system. Valid values are Normal and Conservative. Use Normal to enable the global pool for all applications. Use Conservative to disable the global pool for all applications.

Parameter properties

Type:String
Default value:None
Accepted values:Normal, Conservative
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.