Get-ScheduledJobOption

Get-ScheduledJobOption
    [-InputObject] <ScheduledJobDefinition>
    [<CommonParameters>]

Get-ScheduledJobOption
    [-Id] <Int32>
    [<CommonParameters>]

Get-ScheduledJobOption
    [-Name] <String>
    [<CommonParameters>]

Get-ScheduledJobOption cmdlet 获取计划作业的作业选项。 可以使用此命令检查作业选项，或通过管道将作业选项传递给其他 cmdlet。

作业选项不会单独保存到磁盘;它们是计划作业的一部分。 若要获取计划作业的作业选项，请指定计划作业。

使用 Get-ScheduledJobOption cmdlet 的参数来标识计划作业。 可以通过计划作业的名称或标识号，或通过输入或管道 ScheduledJob 对象（例如由 Get-ScheduledJob cmdlet 返回的作业）来 Get-ScheduledJobOption。

Get-ScheduledJobOption 是 WINDOWS PowerShell 中包含的 PSScheduledJob 模块中作业计划 cmdlet 的集合之一。

有关计划作业的详细信息，请参阅 PSScheduledJob 模块中的“关于”主题。 导入 PSScheduledJob 模块，然后键入：Get-Help about_Scheduled* 或查看about_Scheduled_Jobs。

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

PS C:\> Get-ScheduledJobOption -Name "*Backup*"
StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : False

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

此命令获取其名称中包含 BackUp 的计划作业的作业选项。 结果显示返回的 Get-ScheduledJobOption 的作业选项对象。

PS C:\> Get-ScheduledJob | Get-ScheduledJobOptions

此命令获取本地计算机上所有计划作业的作业选项。

它使用 Get-ScheduledJob cmdlet 在本地计算机上获取计划作业。 管道运算符 （|） 将计划作业发送到 Get-ScheduledJobOptions cmdlet，该 cmdlet 获取每个计划作业的作业选项。

PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}
StartIfOnBatteries     : False

StopIfGoingOnBatteries : True

WakeToRun              : True

StartIfNotIdle         : True

StopIfGoingOffIdle     : False

RestartOnIdleResume    : False

IdleDuration           : 00:10:00

IdleTimeout            : 01:00:00

ShowInTaskScheduler    : True

RunElevated            : True

RunWithoutNetwork      : True

DoNotAllowDemandStart  : False

MultipleInstancePolicy : Ignore

NewJobDefinition       : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

The second command shows how to find to which scheduled job the job options belong. This command uses a pipeline operator (|) to send the selected job options to the ForEach-Object cmdlet, which gets the JobDefinition property of each options object. The JobDefinition property contains the originating job object. The results show that the selected options came from the DeployPkg scheduled job.
PS C:\> Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} | ForEach-Object {$_.JobDefinition}
Id         Name            Triggers        Command                                  Enabled

--         ----            --------        -------                                  -------

2          DeployPkg         {1, 2}        DeployPackage.ps1                        True

此示例演示如何查找具有特定值的作业选项对象。

第一个命令获取 RunElevated 属性的作业选项，其中 RunElevated 属性的值为 $True，RunWithoutNetwork 属性的值为 $False。 输出显示所选 JobOptions 对象。

PS C:\> $Opts = Get-ScheduledJobOption -Name "BackupTestLogs"
PS C:\> Register-ScheduledJob -Name "Archive-Scripts" -FilePath "\\Srv01\Scripts\ArchiveScripts.ps1" -ScheduledJobOption $Opts

此示例演示如何使用 Get-ScheduledJobOptions 在新计划作业中获取的作业选项。

第一个命令使用 Get-ScheduledJobOptions 来获取 BackupTestLogs 计划作业的作业选项。 该命令将选项保存在$Opts变量中。

第二个命令使用 Register-ScheduledJob cmdlet 创建新的计划作业。 ScheduledJobOption 参数的值是$Opts变量中的 options 对象。

PS C:\> $O = Invoke-Command -ComputerName "Srv01" -ScriptBlock {Get-ScheduledJob -Name "DataDemon" }

此命令使用 Invoke-Command cmdlet 获取 Srv01 计算机上的 DataDemon 作业的计划作业选项。 该命令将选项保存在$O变量中。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

可以通过管道将计划作业从 Get-ScheduledJob 传递给 Get-ScheduledJobOption。