Start-AppBackgroundTask

Starts a background task.

Syntax

Start-AppBackgroundTask
     [-AsJob]
     [-CimSession <CimSession[]>]
     [-Confirm]
     -TaskID <String[]>
     [-ThrottleLimit <Int32>]
     [-WhatIf]
     [<CommonParameters>]

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.

Examples

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.

Required Parameters

-TaskID

Specifies a TaskID, in GUID format, for a background task. You can get the TaskID by using the Get-AppBackgroundTask cmdlet.

Type:String[]
Aliases:tid
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional 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.

Type:SwitchParameter
Position:Named
Default value:None
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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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 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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False