Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AppBackgroundTaskResourcePolicy

Set-AppBackgroundTaskResourcePolicy

microsoft.windows.appbackgroundtask.commands.dll

Synopsis

Configures the use of global pool by background tasks.

Syntax

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

Detailed Description

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

Parameters

-Mode <String>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Set global resource policy to conservative mode

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

PS C:\> Set-AppBackgroundTaskResourcePolicy -Mode Conservative 

Example 2: Set global resource policy to normal mode

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

PS C:\>Set-AppBackgroundTaskResourcePolicy -Mode Normal 

Online Version