NAME
Start-AppBackgroundTask
SYNOPSIS
Starts a background task.SYNTAX
Start-AppBackgroundTask [-AsJob] [-CimSession
] [-ThrottleLimit ] -TaskID [-Confirm] [-WhatIf] [
] DESCRIPTION
The Start-AppBackgroundTask cmdlet starts a background task. A background task performs an activity for an
application, such as downloading a file. You must have administrator access to start a background task.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, suchas 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-TaskID
Specifies a TaskID, in GUID format, for a background task. Required? true Position? named Default valueAccept pipeline input? True (ByPropertyName)
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-Confirm [
Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false] -WhatIf [
Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value false 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
Example 1: Start a background task
PS C:\> Start-AppBackgroundTask -TaskID 6D99C4A8-839E-5440-BEFD-2A8DB30A6461
This command starts a registered background task that has the TaskID 6D99C4A8-839E-5440-BEFD-2A8DB30A6461.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=296778Get-AppBackgroundTask
Unregister-AppBackgroundTask