Export (0) Print
Expand All
0 out of 2 rated this helpful - Rate this topic

Get-AppBackgroundTask

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-AppBackgroundTask

Gets background task information.

Syntax

Parameter Set: Get0
Get-AppBackgroundTask [-AsJob] [-CimSession <CimSession[]> ] [-IncludeResourceUsage] [-PackageFamilyName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-AppBackgroundTask cmdlet gets background task information for a task specified in the PackageFamilyName parameter. A background task performs an activity for an application, such as downloading a file. You must have administrator access to get background information.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeResourceUsage

Indicates that the cmdlet displays detailed resource usage data for a background task.


Aliases

iru

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PackageFamilyName<String>

Specifies the package family name for which to display background task information.


Aliases

pfn

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance# MSFT_BackgroundTask[]

Examples

Example 1: Display background tasks

This command displays the registered background tasks that belong to the Microsoft.BingSports_8wekyb3d8bbwe package family.


PS C:\> Get-AppBackgroundTask -PackageFamilyName "Microsoft.BingSports_8wekyb3d8bbwe "

Example 2: Display background tasks with resource usage data

This command displays the registered background tasks that belong to the Microsoft.BingSports_8wekyb3d8bbwe package family, including detailed resource usage information.


PS C:\> Get-AppBackgroundTask -PackageFamilyName "Microsoft.BingSports_8wekyb3d8bbwe " -IncludeResourceUsage

Example 3: Display all background tasks for a user

This command displays all registered background tasks for the current user.


PS C:\> Get-AppBackgroundTask

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.