Remove-JobTrigger

Remove-JobTrigger
    [-InputObject] <ScheduledJobDefinition[]>
    [-TriggerId <Int32[]>]
    [<CommonParameters>]

Remove-JobTrigger
    [-Name] <String[]>
    [-TriggerId <Int32[]>]
    [<CommonParameters>]

Remove-JobTrigger
    [-Id] <Int32[]>
    [-TriggerId <Int32[]>]
    [<CommonParameters>]

Remove-JobTrigger コマンドレットは、スケジュールされたジョブからジョブ トリガーを削除します。

ジョブ トリガーは、スケジュールされたジョブを開始するための定期的なスケジュールまたは条件を定義します。 ジョブ トリガーを管理するには、New-JobTrigger、Add-JobTrigger、Set-JobTrigger、および Set-ScheduledJob コマンドレットを使用します。

トリガーが削除されるスケジュールされたジョブを識別するには、Name、ID、または Remove-JobTrigger の InputObject パラメーターを使用します。 TriggerID パラメーターを使用して、削除するジョブ トリガーを識別します。 既定では、Remove-JobTrigger は、スケジュールされたジョブのすべてのジョブ トリガーを削除します。

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

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

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

PS C:\> Remove-JobTrigger -Name "Test*"

このコマンドは、Test で始まる名前を持つスケジュールされたジョブからすべてのジョブ トリガーを削除します。

PS C:\> Remove-JobTrigger -Name "BackupArchive" -TriggerID 3

このコマンドは、BackupArchive スケジュールされたジョブから 3 番目のトリガー (ID = 3) のみを削除します。

PS C:\> function Delete-AtStartup
{
    Get-ScheduledJob | Get-JobTrigger | Where-Object {$_.Frequency -eq "AtStartup"} | ForEach-Object { Remove-JobTrigger -InputObject $_.JobDefinition -TriggerID $_.ID}
}

この関数は、ローカル コンピューター上のすべてのジョブからすべての AtStartup ジョブ トリガーを削除します。 関数を使用するには、セッションで関数を実行し、「Delete-AtStartup」と入力します。

Delete-AtStartup 関数には、1 つのコマンドが含まれています。 このコマンドでは、Get-ScheduledJob コマンドレットを使用して、ローカル コンピューターでスケジュールされたジョブを取得します。 パイプライン演算子 (|) は、スケジュールされたジョブを Get-JobTrigger コマンドレットに送信します。このコマンドレットは、スケジュールされた各ジョブからすべてのジョブ トリガーを取得します。 パイプライン演算子は、ジョブ トリガーを Where-Object コマンドレットに送信します。このコマンドレットは、ジョブ トリガーの Frequency プロパティの値が AtStartup であるジョブ トリガーを選択します。

JobTrigger オブジェクトには、トリガーするスケジュールされたジョブを含む JobDefinition プロパティがあります。 コマンドの残りの部分では、その重要な機能を使用します。

パイプライン演算子は、atStartup ジョブ トリガーを ForEach-Object コマンドレットに送信します。このコマンドレットは、各 AtStartup トリガーで Remove-JobTrigger コマンドを実行します。 Remove-JobTrigger の InputObject パラメーター 値は、ジョブ トリガーの JobDefinition プロパティのスケジュールされたジョブです。 TriggerID パラメーターの値は、ジョブ トリガーの ID プロパティの識別子です。

PS C:\> Invoke-Command -ComputerName "Server01" { Remove-JobTrigger -ID 38 -TriggerID 1 }

このコマンドは、Server01 コンピューターのインベントリ ジョブから最初のジョブ トリガーを削除します。

このコマンドは、Invoke-Command コマンドレットを使用して、Server01 コンピューターで Remove-JobTrigger コマンドレットを実行します。 Remove-JobTrigger コマンドレットは、ID パラメーターを使用して、Inventory スケジュールされたジョブと、最初のトリガーを指定する TriggerID パラメーターを識別します。 ID パラメーターは、複数のスケジュールされたジョブの名前が同じまたは類似している場合に特に便利です。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

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

コマンドレットは出力を生成しません。