Get-ScheduledJobOption

取得排程作業的作業選項。

Syntax

Get-ScheduledJobOption
   [-InputObject] <ScheduledJobDefinition>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Id] <Int32>
   [<CommonParameters>]
Get-ScheduledJobOption
   [-Name] <String>
   [<CommonParameters>]

Description

Cmdlet Get-ScheduledJobOption 會取得排程工作的工作選項。 您可以使用此命令來檢查作業選項,或使用管線將作業選項傳送至其他 Cmdlet。

作業選項不會獨立儲存至磁碟;它們是排程工作的一部分。 若要取得排程作業的作業選項,請指定排程的工作。

使用 Cmdlet 的參數 Get-ScheduledJobOption 來識別排程的工作。 您可以藉由其名稱或標識符來識別排程工作,或輸入或管線 ScheduledJob 物件,例如 Cmdlet 傳回的Get-ScheduledJob作業。Get-ScheduledJobOption

Get-ScheduledJobOption 是 WINDOWS PowerShell 隨附的 PSScheduledJob 模組中作業排程 Cmdlet 的其中一個集合。

如需排程工作的詳細資訊,請參閱 PSScheduledJob 模組中的 About 主題。 匯入 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,以取得 每個 options 物件的 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 options 物件。

範例 5:從遠端電腦取得作業選項

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

此命令會 Invoke-Command 使用 Cmdlet 取得 Srv01 計算機上 DataDemon 作業的排程工作選項。 命令會將選項儲存在變數中 $O

參數

-Id

指定排程工作的識別碼。 Get-ScheduledJobOption 會取得指定之排程作業的作業選項。

若要取得本機電腦或遠端電腦上的排程工作識別碼,請使用 Get-ScheduledJob Cmdlet。

Type:Int32
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定排程的工作。 輸入包含 ScheduledJob 物件的變數,或輸入取得 ScheduledJob 物件的命令或表示式,例如 Get-ScheduledJob 命令。 您也可以使用管線將 ScheduledJob 物件傳送至 Get-ScheduledJobOption

Type:ScheduledJobDefinition
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定排程工作的名稱。 Get-ScheduledJobOption 會取得指定之排程作業的作業選項。 支援萬用字元。

若要取得本機電腦或遠端電腦上的排程工作名稱,請使用 Get-ScheduledJob Cmdlet。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

輸入

ScheduledJobDefinition

您可以使用管線將排程的工作物件傳送至此 Cmdlet。

輸出

ScheduledJobOptions

此 Cmdlet 會傳 回 ScheduledJobOptions 物件。