次の方法で共有

Unregister-ScheduledJob

  • リファレンス
モジュール:
PSScheduledJob

ローカル コンピューター上のスケジュールされたジョブを削除します。

構文

Unregister-ScheduledJob
          [-InputObject] <ScheduledJobDefinition[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-ScheduledJob
          [-Id] <Int32[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]
Unregister-ScheduledJob
          [-Name] <String[]>
          [-Force]
          [-WhatIf]
          [-Confirm]
          [<CommonParameters>]

説明

Unregister-ScheduledJob コマンドレットは、ローカル コンピューターからスケジュールされたジョブを削除します。

スケジュールされたジョブを削除または登録解除 Unregister-ScheduledJob 、スケジュールされたジョブ ( $HOME\AppData\Local\Microsoft\Windows\PowerShell\ScheduledJobs directory内) のディレクトリを削除します。これには、スケジュールされたジョブ、ジョブ実行履歴、およびすべてのジョブ結果を定義する XML ファイルが含まれます。 この操作では、タスク スケジューラからもジョブが削除されます。

Unregister-ScheduledJob は、 Register-ScheduledJob コマンドレットを使用して作成されたスケジュールされたジョブのみを削除します。 タスク スケジューラで作成されたスケジュールされたジョブは削除しません。

Unregister-ScheduledJobのパラメーターを使用して、スケジュールされたジョブを ID または名前で削除したり、スケジュールされたジョブをGet-ScheduledJobからUnregister-ScheduledJobにパイプしたりできます。

Unregister-ScheduledJob は、Windows PowerShell に含まれる PSScheduledJob モジュールのジョブ スケジューリング コマンドレットのコレクションの 1 つです。

スケジュールされたジョブの詳細については、PSScheduledJob モジュールの概要トピックを参照してください。 PSScheduledJob モジュールをインポートし、「 Get-Help about_Scheduled* 」と入力するか、 about_Scheduled_Jobsを参照してください。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: スケジュールされたジョブを削除する

Unregister-ScheduledJob TestJob

このコマンドは、ローカル コンピューター上のスケジュールされたジョブ TestJob を削除します。

例 2: スケジュールされたすべてのジョブを削除する

Get-ScheduledJob | Unregister-ScheduledJob -Force
Unregister-ScheduledJob -Name "*" -Force

この例では、ローカル コンピューター上のすべてのスケジュールされたジョブを削除する 2 つの異なるコマンドを示します。

最初のコマンドでは、 Get-ScheduledJob コマンドレットを使用して、ローカル コンピューター上のすべてのスケジュールされたジョブを取得します。 パイプライン演算子 (|) は、スケジュールされたジョブを Unregister-ScheduleJobに送信し、ジョブを削除します。

2 番目のコマンドでは、すべての (*) の値を持つUnregister-ScheduledJobの Name パラメーターを使用して、スケジュールされたすべてのジョブを削除します。

どちらのコマンドも Force パラメーターを使用します。このパラメーターは、ジョブのインスタンスが実行されている場合でも、スケジュールされたジョブを削除します。

例 3: リモート コンピューターでスケジュールされたジョブを削除する

Invoke-Command -ComputerName "Server01" { Unregister-ScheduledJob -Name "Test*"}

このコマンドは、Server01 リモート コンピューターでテストで始まる名前のスケジュールされたジョブを削除します。 このコマンドでは、 Invoke-Command コマンドレットを使用して、Server02 コンピューターで Unregister-ScheduledJob コマンドを実行します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Force

ジョブのインスタンスが実行されている場合でも、スケジュールされたジョブを削除します。 既定では、 Unregister-ScheduledJob は実行中のジョブを中断しません。

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Id

指定された識別番号 (ID) のスケジュールされたジョブを削除します。 コンピューター上のスケジュールされたジョブの ID を入力します。

型:Int32[]
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

スケジュールされたジョブを指定します。 ScheduledJob オブジェクトを含む変数を入力するか、Get-ScheduledJob コマンドなどのScheduledJob オブジェクトを取得するコマンドまたは式を入力します。 パイプ ScheduledJob オブジェクトを Unregister-JobTriggerすることもできます。

型:ScheduledJobDefinition[]
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

指定された名前のスケジュールされたジョブを削除します。 コンピューター上の 1 つまたは複数のスケジュールされたジョブの名前を入力します。 ワイルドカードを利用できます。

型:String[]
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

ScheduledJobDefinition

スケジュールされたジョブをこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。