New-ScheduledJobOption

New-ScheduledJobOption
    [-RunElevated]
    [-HideInTaskScheduler]
    [-RestartOnIdleResume]
    [-MultipleInstancePolicy <TaskMultipleInstancePolicy>]
    [-DoNotAllowDemandStart]
    [-RequireNetwork]
    [-StopIfGoingOffIdle]
    [-WakeToRun]
    [-ContinueIfGoingOnBattery]
    [-StartIfOnBattery]
    [-IdleTimeout <TimeSpan>]
    [-IdleDuration <TimeSpan>]
    [-StartIfIdle]
    [<CommonParameters>]

New-ScheduledJobOption cmdlet 创建包含计划作业的高级选项的对象。

可以使用 New-ScheduledJobOption 返回的 ScheduledJobOptions 对象来设置新作业或现有计划作业的作业选项。 或者，可以使用 Get-ScheduledJobOption cmdlet 设置作业选项以获取现有计划作业的作业选项，也可以使用哈希表值来表示作业选项。

如果没有参数，New-ScheduledJobOption 将生成一个对象，该对象包含所有选项的默认值。 由于可以编辑 JobDefinition 属性之外的所有属性，因此可以使用生成的对象作为模板，并为企业创建标准选项对象。

创建计划作业和设置计划的作业选项时，请查看所有计划作业选项的默认值。 仅当满足为其执行设置的所有条件时，计划作业才会运行。

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

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

PS C:\> New-ScheduledJobOption
StartIfOnBatteries     : False
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : True
DoNotAllowDemandStart  : False
MultipleInstancePolicy : Ignore
NewJobDefinition       :

此命令创建具有所有默认值的计划作业选项对象。

PS C:\> New-ScheduledJobOption -RequireNetwork -StartIfOnBattery
StartIfOnBatteries     : True
StopIfGoingOnBatteries : True
WakeToRun              : False
StartIfNotIdle         : True
StopIfGoingOffIdle     : False
RestartOnIdleResume    : False
IdleDuration           : 00:10:00
IdleTimeout            : 01:00:00
ShowInTaskScheduler    : True
RunElevated            : False
RunWithoutNetwork      : False
DoNotAllowDemandStart  : False
MultipleInstancePolicy : Ignore
NewJobDefinition       :

以下命令创建一个计划作业对象，该对象需要网络并运行计划作业，即使计算机未连接到 AC 电源。

输出显示 RequireNetwork 参数将 RunWithoutNetwork 属性的值更改为 $False，StartIfOnBattery 参数将 StartIfOnBatteries 属性的值更改为 $True。

The first command creates a **ScheduledJobOptions** object with the *RunElevated* parameter. It saves the object in the $RunAsAdmin variable.
PS C:\> $RunAsAdmin = New-ScheduledJobOption -RunElevated

The second command uses the Register-ScheduledJob cmdlet to create a new scheduled job. The value of the *ScheduledJobOption* parameter is the option object in the value of the $RunAsAdmin variable.
PS C:\> Register-ScheduledJob -Name Backup -FilePath D:\Scripts\Backup.ps1 -Trigger $Mondays -ScheduledJobOption $RunAsAdmin

The third command uses the Get-ScheduledJobOption cmdlet to get the job options of the Backup scheduled job.The cmdlet output shows that the RunElevated property is set to $True and the JobDefinition property of the job option object is now populated with the scheduled job object for the Backup scheduled job.
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 : IgnoreNew
JobDefinition          : Microsoft.PowerShell.ScheduledJob.ScheduledJobDefinition

此示例演示如何使用 New-ScheduledJobOption 返回的 ScheduledJobOptions 对象来设置新计划作业的选项。

PS C:\> $Options = New-ScheduledJobOption -WakeToRun
PS C:\> $Options.PSObject.Properties | Sort-Object -Property Name | Format-Table -Property Name, Value -Autosize
Name                       Value
----                       -----
DoNotAllowDemandStart      False
IdleDuration            00:10:00
IdleTimeout             01:00:00
JobDefinition
MultipleInstancePolicy IgnoreNew
RestartOnIdleResume        False
RunElevated                False
RunWithoutNetwork           True
ShowInTaskScheduler         True
StartIfNotIdle              True
StartIfOnBatteries         False
StopIfGoingOffIdle         False
StopIfGoingOnBatteries      True
WakeToRun                   True

此示例演示如何按字母顺序对 ScheduledJobOptions 对象的属性进行排序，以便轻松阅读。

第一个命令使用 New-ScheduledJobOption cmdlet 创建 ScheduledJobOptions 对象。 该命令使用 WakeToRun 参数，并将生成的对象保存在$Options变量中。

若要获取$Options作为对象的属性，第二个命令使用所有 Windows PowerShell 对象的 PSObject 属性及其 Properties 属性。 然后，该命令将属性对象通过管道传递给 Sort-Object cmdlet，该 cmdlet 按名称按字母顺序对属性进行排序，然后传递给 Format-Table cmdlet，该 cmdlet 显示表中属性的名称和值。

通过此格式，可以更轻松地在 $Options 中找到 ScheduledJobOptions 对象的 WakeToRun 属性，并验证其值是否已从 $False 更改为 $True。

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

不能通过管道将输入传递给此 cmdlet。

• 可以使用 New-ScheduledJobOption 创建的 ScheduledJobOptions 对象作为 Register-ScheduledJob cmdlet 的 ScheduledJobOption 参数的值。 但是，ScheduledJobOption 参数还可以采用哈希表值，该值指定 ScheduledJobOptions 对象的属性及其值，例如：

  @{ShowInTaskScheduler=$False; RunElevated=$True; IdleDuration="00:05"}