Resume-BitsTransfer
Resume-BitsTransfer
Resumes a Background Intelligent Transfer Service (BITS) transfer job.
構文
Parameter Set: Default
Resume-BitsTransfer [-BitsJob] <BitsJob[]> [-Asynchronous] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Resume-BitsTransfer cmdlet resumes one or more suspended BITS transfer jobs. If the BITS transfer is already in process, the cmdlet does nothing. You can view the current state of a transfer job by using the Get-BitsTransfer cmdlet.
Important: By default, the Resume-BitsTransfer cmdlet restarts the transfer job synchronously even if the original job was specified as an asynchronous transfer job. You could use this behavior to convert an asynchronous transfer job into a synchronous transfer job. You could do this if either of the following conditions is true:
- The asynchronous transfer job was created outside cmdlets.
- The asynchronous transfer job was created by using the Start-BitsTransfer cmdlet.
If you want to restart the transfer job as an asynchronous transfer, use the Asynchronous parameter.
パラメーター
-Asynchronous
Allows the BITS transfer job to be processed in the background. The command prompt reappears immediately after the BITS transfer job is resumed. The returned BitsJob object can be used to monitor status and progress.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-BitsJob<BitsJob[]>
Specifies the BITS transfer jobs to resume. You can pipe a value to this parameter from other cmdlets that return BitsJob objects, such as Get-BitsTransfer.
エイリアス |
なし |
必須? |
true |
位置は? |
1 |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドレットを実行する前に、ユーザーに確認を求めます。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]
This cmdlet accepts one or more BitsJob objects as input that populates the BitsJob parameter.
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob[]
When called with the Asynchronous parameter, this cmdlet sends the BitsJob object that is associated with the resumed BITS transfer job as output. Otherwise, no output is generated.
注
- You can cancel a transfer job that is running in synchronous mode (foreground priority) by pressing CTRL+C.
例
EXAMPLE 1
This command resumes all the BITS transfer jobs that are owned by the current user.
The command prompt returns after the jobs are complete or after the jobs enter an error state. The output of the Get-BitsTransfer cmdlet is a set of BitsJob objects. This output is piped to the Resume-BitsTransfer cmdlet. If any of the BITS transfer jobs are already active, they will continue to run.
PS C:\>Get-BitsTransfer | Resume-BitsTransfer
EXAMPLE 2
This command resumes a new BITS transfer job that was initially suspended, and it returns the command prompt immediately.
The first command creates a new BitsJob object in a suspended state and then stores it in the $b variable.
The second command adds a file to the transfer queue of the new BitsJob object that is stored in the $b variable.
The third command uses the BitsJob parameter to pass the BitsJob object that is stored in the $b parameter to the Resume-BitsTransfer cmdlet. This command starts the BITS transfer job.
PS C:\>$b = Start-BitsTransfer -DisplayName "MyJob" -Suspended
PS C:\>Add-BitsTransfer -BitsJob $b -ClientFileName C:\myFile -ServerFileName http://www.mysite.com/file1
PS C:\>Resume-BitsTransfer -BitsJob $b -Asynchronous
EXAMPLE 3
This command resumes the BITS transfer that is identified by the specified display name.
The command prompt returns after the job is complete or after the job enters an error state. The output of the Get-BitsTransfer cmdlet is a BitsJob object. This output is piped to the Resume-BitsTransfer cmdlet. If the BITS transfer job is already active, it will continue to run.
PS C:\>Get-BitsTransfer -Name testjob1 | Resume-BitsTransfer