Site icon TOSS

Start-AppBackgroundTask

powershell

Start-AppBackgroundTask is accessible with the help of AppBackgroundTask module. To configure AppBackgroundTask, go through this link.

Synopsis

Starts a background task.

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 PowerShell® background jobs, see about_Jobs.

    Required?                    false
    Position?                    named
    Default value                
    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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-TaskID <String[]>
    Specifies a TaskID, in GUID format, for a background task.

    Required?                    true
    Position?                    named
    Default value                
    Accept pipeline input?       True (ByPropertyName)
    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.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-Confirm <SwitchParameter>
    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

Syntax

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

—————-Example 1—————-
Start a background task
PS C:> Start-AppBackgroundTask -TaskID <Task ID>
This command starts a registered background task that has the TaskID <Task ID>.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Start-AppBackgroundTask

You can also read about

To know more PowerShell cmdlets(Commands) on AppBackgroundTask click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Exit mobile version