Windows PowerShell command on Get-command Get-AppBackgroundTask
MyWebUniversity

Windows PowerShell command on Get-command Get-AppBackgroundTask

NAME

Get-AppBackgroundTask

SYNOPSIS

Gets background task information.

SYNTAX

Get-AppBackgroundTask [-AsJob] [-CimSession ] [-IncludeResourceUsage] [-PackageFamilyName ]

[-ThrottleLimit ] []

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 PowerShellr background jobs, see about_Jobs. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-IncludeResourceUsage []

Indicates that the cmdlet displays detailed resource usage data for a background task. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-PackageFamilyName

Specifies the package family name for which to display background task information. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-ThrottleLimit

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 PowerShellr 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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance# MSFT_BackgroundTask[]

Example 1: Display background tasks

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

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

Example 2: Display background tasks with resource usage data

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

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

Example 3: Display all background tasks for a user

PS C:\>Get-AppBackgroundTask

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

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=296777

Start-AppBackgroundTask

Unregister-AppBackgroundTask



Contact us      |      About us      |      Term of use      |       Copyright © 2000-2019 OurUNIX.com ™