about_Jobs

[アーティクル]
11/06/2024

簡単な説明

PowerShell バックグラウンドジョブが、現在のセッションと対話せずにバックグラウンドでコマンドまたは式を実行する方法に関する情報を提供します。

詳細な説明

PowerShell は、ジョブを介してコマンドとスクリプトを同時に実行します。同時実行をサポートするために、PowerShell によって提供されるジョブの種類は 3 つあります。

RemoteJob - コマンドとスクリプトはリモートセッションで実行されます。詳細については、 about_Remote_Jobsを参照してください。
BackgroundJob - コマンドとスクリプトは、ローカルコンピューター上の別のプロセスで実行されます。
PSTaskJob または ThreadJob - コマンドとスクリプトは、ローカルコンピューター上の同じプロセス内の別のスレッドで実行されます。詳細については、「 about_Thread_Jobs」を参照してください。

スクリプトを別のコンピューターまたは別のプロセスでリモートで実行すると、優れた分離性が提供されます。リモートジョブで発生したエラーは、実行中の他のジョブや、ジョブを開始した親セッションには影響しません。ただし、リモート処理レイヤーでは、オブジェクトのシリアル化を含むオーバーヘッドが追加されます。親セッションとリモート (ジョブ) セッションの間で渡されると、すべてのオブジェクトがシリアル化および逆シリアル化されます。大規模な複雑なデータオブジェクトのシリアル化では、大量のコンピューティングリソースとメモリリソースが消費され、ネットワーク経由で大量のデータが転送される可能性があります。

スレッドベースのジョブは、異なるスレッドで同じプロセスで実行されるため、リモートジョブやバックグラウンドジョブほど堅牢ではありません。 1 つのジョブでプロセスがクラッシュする重大なエラーが発生した場合、プロセス内の他のすべてのジョブが終了します。

ただし、スレッドベースのジョブのオーバーヘッドは少なくなります。リモート処理レイヤーやシリアル化は使用しません。結果オブジェクトは、現在のセッションのライブオブジェクトへの参照として返されます。このオーバーヘッドがなければ、スレッドベースのジョブの実行速度が速くなり、他のジョブの種類よりも使用するリソースが少なくなります。

重要

また、ジョブを作成した親セッションは、ジョブの状態を監視し、パイプラインデータを収集します。ジョブの子プロセスは、ジョブが完了した状態に達すると、親プロセスによって終了されます。親セッションが終了すると、実行中のすべての子ジョブが子プロセスと共に終了します。

この状況を回避するには、次の 2 つの方法があります。

Invoke-Commandを使用して、切断されたセッションで実行されるジョブを作成します。詳細については、「 about_Remote_Jobs」を参照してください。
Start-Processを使用して、ジョブではなく新しいプロセスを作成します。詳細については、「Start-Process」を参照してください。

ジョブコマンドレット

Start-Job - ローカルコンピューターでバックグラウンドジョブを開始します。
Get-Job - 現在のセッションで開始されたバックグラウンドジョブを取得します。
Receive-Job - バックグラウンドジョブの結果を取得します。
Stop-Job - バックグラウンドジョブを停止します。
Wait-Job - 1 つまたはすべてのジョブが完了するまで、コマンドプロンプトを抑制します。
Remove-Job - バックグラウンドジョブを削除します。
Invoke-Command - AsJob パラメーターは、リモートコンピューターにバックグラウンドジョブを作成します。 Invoke-Commandを使用して、Start-Jobを含む任意のジョブコマンドをリモートで実行できます。

ローカルコンピューターでジョブを開始する方法

ローカルコンピューターでバックグラウンドジョブを開始するには、 Start-Job コマンドレットを使用します。

Start-Jobコマンドを記述するには、ジョブが実行するコマンドを中かっこ ({}) で囲みます。コマンドを指定するには、 ScriptBlock パラメーターを使用します。

次のコマンドは、ローカルコンピューターで Get-Process コマンドを実行するバックグラウンドジョブを開始します。

Start-Job -ScriptBlock {Get-Process}

バックグラウンドジョブを開始すると、ジョブの完了に時間がかかる場合でも、コマンドプロンプトはすぐに返されます。ジョブの実行中は、中断されることなく引き続きセッションで作業できます。

Start-Job コマンドは、ジョブを表すオブジェクトを返します。ジョブオブジェクトにはジョブに関する有用な情報が含まれていますが、ジョブの結果は含まれません。

ジョブオブジェクトを変数に保存し、他の Job コマンドレットと共に使用して、バックグラウンドジョブを管理できます。次のコマンドは、ジョブオブジェクトを開始し、結果のジョブオブジェクトを $job 変数に保存します。

$job = Start-Job -ScriptBlock {Get-Process}

PowerShell 6.0 以降では、パイプラインの末尾にあるバックグラウンド演算子 (&) を使用して、バックグラウンドジョブを開始できます。詳細については、「 background 演算子を参照してください。

バックグラウンド演算子の使用は、前の例の Start-Job コマンドレットの使用と機能的に同等です。

$job = Get-Process &

ジョブオブジェクトの取得

Get-Job コマンドレットは、現在のセッションで開始されたバックグラウンドジョブを表すオブジェクトを返します。パラメーターがない場合、 Get-Job は現在のセッションで開始されたすべてのジョブを返します。

Get-Job

ジョブオブジェクトには、ジョブが終了したかどうかを示すジョブの状態が含まれています。完了したジョブの状態は Complete または Failed です。ジョブは、 Blocked または Running である場合もあります。

Id  Name  PSJobTypeName State      HasMoreData  Location   Command
--  ----  ------------- -----      -----------  --------   -------
1   Job1  BackgroundJob Complete   True         localhost  Get-Process

ジョブオブジェクトを変数に保存し、それを使用して後のコマンドでジョブを表すことができます。次のコマンドは、ID 1 のジョブを取得し、 $job 変数に保存します。

$job = Get-Job -Id 1

ジョブの結果の取得

バックグラウンドジョブを実行すると、結果はすぐには表示されません。バックグラウンドジョブの結果を取得するには、 Receive-Job コマンドレットを使用します。

次の例では、 Receive-Job コマンドレットは、 $job 変数のジョブオブジェクトを使用してジョブの結果を取得します。

Receive-Job -Job $job

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------    -----      ----- -----   ------    -- -----------
    103       4    11328       9692    56           1176 audiodg
    804      14    12228      14108   100   101.74  1740 CcmExec
    668       7     2672       6168   104    32.26   488 csrss
...

ジョブの結果を変数に保存できます。次のコマンドは、ジョブの結果を $job 変数の $results 変数に保存します。

$results = Receive-Job -Job $job

部分的なジョブ結果の取得と保持

Receive-Job コマンドレットは、バックグラウンドジョブの結果を取得します。ジョブが完了すると、 Receive-Job はすべてのジョブ結果を取得します。ジョブがまだ実行中の場合、 Receive-Job はこれまでに生成された結果を取得します。 Receive-Jobコマンドをもう一度実行して、残りの結果を取得できます。

既定では、 Receive-Job は、ジョブの結果が格納されているキャッシュから結果を削除します。 Receive-Jobをもう一度実行すると、最初の実行後に到着した新しい結果のみが取得されます。

次のコマンドは、ジョブが完了する前に実行 Receive-Job コマンドの結果を示しています。

C:\PS> Receive-Job -Job $job

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    103       4    11328       9692    56            1176 audiodg
    804      14    12228      14108   100   101.74   1740 CcmExec

C:\PS> Receive-Job -Job $job

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    68       3     2632        664    29     0.36   1388 ccmsetup
   749      22    21468      19940   203   122.13   3644 communicator
   905       7     2980       2628    34   197.97    424 csrss
  1121      25    28408      32940   174   430.14   3048 explorer

Keep パラメーターを使用して、Receive-Jobが返されたジョブの結果を削除しないようにします。次のコマンドは、まだ完了していないジョブで Keep パラメーターを使用した場合の影響を示しています。

C:\PS> Receive-Job -Job $job -Keep

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    103       4    11328       9692    56            1176 audiodg
    804      14    12228      14108   100   101.74   1740 CcmExec

C:\PS> Receive-Job -Job $job -Keep

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    103       4    11328       9692    56            1176 audiodg
    804      14    12228      14108   100   101.74   1740 CcmExec
     68       3     2632        664    29     0.36   1388 ccmsetup
    749      22    21468      19940   203   122.13   3644 communicator
    905       7     2980       2628    34   197.97    424 csrss
   1121      25    28408      32940   174   430.14   3048 explorer

結果を待機しています

完了に時間がかかるコマンドを実行する場合は、ジョブオブジェクトのプロパティを使用して、ジョブが完了したタイミングを判断できます。次のコマンドでは、 Get-Job オブジェクトを使用して、現在のセッションのすべてのバックグラウンドジョブを取得します。

Get-Job

結果はテーブルに表示されます。ジョブの状態が State 列に表示されます。

Id Name  PSJobTypeName State    HasMoreData Location  Command
-- ----  ------------- -----    ----------- --------  -------
1  Job1  BackgroundJob Complete True        localhost Get-Process
2  Job2  BackgroundJob Running  True        localhost Get-EventLog -Log ...
3  Job3  BackgroundJob Complete True        localhost dir -Path C:\* -Re...

この場合、 State プロパティは、ジョブ 2 がまだ実行されていることを示します。 Receive-Job コマンドレットを使用してジョブの結果を取得する場合、結果は不完全になります。 Receive-Job コマンドレットを繰り返し使用して、すべての結果を取得できます。ジョブがいつ完了するかを判断するには、 State プロパティを使用します。

Receive-Job コマンドレットの Wait パラメーターを使用することもできます。このパラメーターを使用すると、ジョブが完了し、すべての結果が使用可能になるまで、コマンドレットはコマンドプロンプトを返しません。

Wait-Job コマンドレットを使用して、ジョブの結果の一部または全部を待機することもできます。 Wait-Job では、1 つ以上の特定のジョブまたはすべてのジョブを待機できます。次のコマンドでは、 Wait-Job コマンドレットを使用して、 ID 10 のジョブを待機します。

Wait-Job -ID 10

その結果、PowerShell プロンプトはジョブが完了するまで抑制されます。

また、所定の期間待機することもできます。このコマンドでは、 Timeout パラメーターを使用して、待機を 120 秒に制限します。時間が経過すると、コマンドプロンプトが返されますが、ジョブはバックグラウンドで引き続き実行されます。

Wait-Job -ID 10 -Timeout 120

ジョブの停止

バックグラウンドジョブを停止するには、 Stop-Job コマンドレットを使用します。次のコマンドは、システムイベントログ内のすべてのエントリを取得するジョブを開始します。ジョブオブジェクトを $job 変数に保存します。

$job = Start-Job -ScriptBlock {Get-EventLog -Log System}

次のコマンドはジョブを停止します。パイプライン演算子 (|) を使用して、 $job 変数内のジョブを Stop-Jobに送信します。

$job | Stop-Job

ジョブの削除

バックグラウンドジョブを削除するには、 Remove-Job コマンドレットを使用します。次のコマンドは、 $job 変数内のジョブを削除します。

Remove-Job -Job $job

失敗したジョブの調査

ジョブは、さまざまな理由で失敗する可能性があります。ジョブオブジェクトには、エラーの原因に関する情報を含む Reason プロパティが含まれています。

次の例では、必要な資格情報なしでジョブを開始します。

$job = Start-Job -ScriptBlock {New-Item -Path HKLM:\Software\MyCompany}
Get-Job $job

Id Name  PSJobTypeName State  HasMoreData  Location  Command
-- ----  ------------- -----  -----------  --------  -------
1  Job1  BackgroundJob Failed False        localhost New-Item -Path HKLM:...

Reason プロパティを調べて、ジョブの失敗の原因となったエラーを見つけます。

$job.ChildJobs[0].JobStateInfo.Reason

この場合、リモートコンピューターでコマンドを実行するために明示的な資格情報が必要なため、ジョブは失敗しました。 Reason プロパティには、次のメッセージが含まれています。

リモートサーバーへの接続が失敗し、"アクセスが拒否されました" というエラーメッセージが表示されました。

次の方法で共有

about_Jobs

簡単な説明

詳細な説明

ジョブコマンドレット

ローカルコンピューターでジョブを開始する方法

ジョブオブジェクトの取得

ジョブの結果の取得

部分的なジョブ結果の取得と保持

結果を待機しています

ジョブの停止

ジョブの削除

失敗したジョブの調査

関連項目

その他のリソース

次の方法で共有

about_Jobs

簡単な説明

詳細な説明

ジョブ コマンドレット

ローカル コンピューターでジョブを開始する方法

ジョブ オブジェクトの取得

ジョブの結果の取得

部分的なジョブ結果の取得と保持

結果を待機しています

ジョブの停止

ジョブの削除

失敗したジョブの調査

関連項目

その他のリソース

ジョブコマンドレット

ローカルコンピューターでジョブを開始する方法

ジョブオブジェクトの取得