Get-ScheduledJobOption

参考

模块:: PSScheduledJob

获取计划作业的作业选项。

语法

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 是 PSScheduledJob 模块（包含在 Windows PowerShell 中）中的一系列作业计划 cmdlet 之一。

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

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：获取作业选项

此示例获取与指定名称匹配的计划作业的作业选项。

Get-ScheduledJobOption -Name "*Backup*"

示例 2：获取所有作业选项

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

Get-ScheduledJob | Get-ScheduledJobOption

此示例使用 Get-ScheduledJob cmdlet 获取本地计算机上的计划作业。管道运算符 (|) 将计划作业发送到 Get-ScheduledJobOption cmdlet，此 cmdlet 可获取每个计划作业的作业选项。

示例 3：获取选定的作业选项

此示例显示了如何使用特定值查找作业选项对象。

Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun}

Get-ScheduledJob | Get-ScheduledJobOption | Where {$_.RunElevated -and !$_.WaketoRun} |
    ForEach-Object {$_.JobDefinition}

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

第二个命令显示了如何查找作业选项所属的计划作业。此命令使用管道运算符 (|) 将所选的作业选项发送到 ForEach-Object cmdlet，此 cmdlet 获取每个选项对象的 JobDefinition 属性。 JobDefinition 属性包含起源作业对象。

示例 4：使用作业选项创建新作业

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

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

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

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

示例 5：从远程计算机获取作业选项

$O = Invoke-Command -ComputerName "Srv01" -ScriptBlock {Get-ScheduledJob -Name "DataDemon" }

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

参数

-Id

指定计划作业的标识号。 Get-ScheduledJobOption 获取指定计划作业的作业选项。

若要获取本地计算机或远程计算机上的计划作业的标识号，请使用 Get-ScheduledJob cmdlet。

类型:	Int32
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-InputObject

指定计划作业。请输入包含 ScheduledJob 对象的变量，或者键入获取 ScheduledJob 对象的命令或表达式，例如 Get-ScheduledJob 命令。还可以通过管道将 ScheduledJob 对象传递给 Get-ScheduledJobOption。

类型:	ScheduledJobDefinition
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Name

指定计划作业的名称。 Get-ScheduledJobOption 获取指定计划作业的作业选项。支持通配符。

若要获取本地计算机或远程计算机上的计划作业的名称，请使用 Get-ScheduledJob cmdlet。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

输入

ScheduledJobDefinition

你可以通过管道将计划作业对象传递给此 cmdlet。

输出

ScheduledJobOptions

此 cmdlet 返回一个 ScheduledJobOptions 对象。

通过