共用方式為

Get-SqlAgentJobHistory

  • 參考
模組:
SQLServer

取得 SQL Agent 目標實例中存在的作業歷程記錄。

語法

Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-Path] <String[]>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentJobHistory
   [-StartRunDate <DateTime>]
   [-EndRunDate <DateTime>]
   [-JobID <Guid>]
   [-JobName <String>]
   [-MinimumRetries <Int32>]
   [-MinimumRunDurationInSeconds <Int32>]
   [-OldestFirst]
   [-OutcomesType <CompletionResult>]
   [-SqlMessageID <Int32>]
   [-SqlSeverity <Int32>]
   [-Since <SinceType>]
   [-InputObject] <JobServer[]>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get-SqlAgentJobHistory Cmdlet 會取得存在於 SQL Agent 目標實例中的 JobHistory 物件。

此 Cmdlet 支援下列作業模式來取得 JobHistory 物件：

  • 指定 SQL Agent 實體的路徑。
  • 在輸入中傳遞 SQL Agent 的實例。
  • 在有效的內容中叫用 Cmdlet。

範例

範例 1：從指定的伺服器實例取得整個作業歷程記錄

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" | Format-Table

InstanceID SqlMessageID Message
---------- ------------ -------
        34            0 The job succeeded.  The Job was invoked by Schedule 8 (syspolicy_purge_history_schedule).  T... 
        33            0 Executed as user: DOMAIN\Machine1$. The step did not generate any output.  Process Exit

此命令會在名為 MyServerInstance 的伺服器實例中取得整個作業歷程記錄，然後格式化輸出。

範例 2：從指定的伺服器實例取得作業歷程記錄

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -JobID 187112d7-84e1-4b66-b093-e97201c441ed

JobID            : 187112d7-84e1-4b66-b093-e97201c441ed
JobName          : Job_73cc6990-6386-49f9-9826-96c318ad8afa
RunStatus        : 3

此命令會取得名稱為 'MyServerInstance' 的伺服器實例中標識符為 '187112d7-84e1-4b66-b093-e97201c441ed' 的工作物件作業歷程記錄。

範例 3：從指定伺服器實例的時間持續時間取得作業歷程記錄

PS C:\> Get-SqlAgentJobHistory -ServerInstance "MyServerInstance" -Since Yesterday
InstanceID       : 4
SqlMessageID     : 0
Message          : The job was stopped prior to completion by User admin.  The Job was invoked by User
                   admin.  The last step to run was step 1 (JobStep_3e4cd4ba-3433-4311-a6a2-816884101504).

此命令會傳回自伺服器實例 'MyServerInstance' 的前一天起的工作歷程記錄。

參數

-AccessToken

用來向 SQL Server 驗證的存取令牌，作為使用者/密碼或 Windows 驗證的替代方案。

例如，這可用來使用 Service Principal 或 Managed Identity來連線到 SQL Azure DB 和 SQL Azure Managed Instance。

要使用的參數可以是字串，表示令牌或 PSAccessToken 物件，如執行 Get-AzAccessToken -ResourceUrl https://database.windows.net所傳回。

此參數是模組 v22 的新功能。

類型:PSObject
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ConnectionTimeout

指定要在逾時失敗前等候伺服器連線的秒數。 逾時值必須是介於 0 到 65534 之間的整數值。 如果指定了 0，連線嘗試就不會逾時。

類型:Int32
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Credential

指定 PSCredential 物件，用來指定具有執行這項作業許可權之 SQL Server 登入的認證。

類型:PSCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Encrypt

線上到 SQL Server 時要使用的加密類型。

此值會對應至 Microsoft.Data.SqlClient 驅動程式之 SqlConnection 物件上的 Encrypt 屬性 SqlConnectionEncryptOption。

在模組的 v22 中，預設值為 Optional （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 「強制」，這可能會為現有的腳本建立重大變更。

此參數是模組 v22 的新功能。

類型:String
接受的值:Mandatory, Optional, Strict
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-EndRunDate

指定作業篩選條件約束，限制傳回至作業完成日期的值。

類型:DateTime
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-HostNameInCertificate

用來驗證 SQL Server TLS/SSL 憑證的主機名。 如果您的 SQL Server 實例已啟用強制加密，而且您想要使用主機名/shortname 連線到實例，則必須傳遞此參數。 如果省略此參數，則必須將完整功能變數名稱 （FQDN） 傳遞至 -ServerInstance 才能連線到啟用強制加密的 SQL Server 實例。

此參數是模組 v22 的新功能。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-InputObject

指定 SQL Server 管理物件 （SMO） 物件的陣列，代表要設定目標的 SQL Server Agent。

類型:JobServer[]
Position:1
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-JobID

指定工作篩選條件約束，限制工作標識符值所指定作業所傳回的值。

類型:Guid
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-JobName

指定作業篩選條件約束，限制傳回給作業名稱所指定作業的值。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-MinimumRetries

指定工作篩選條件約束，限制傳回給失敗且重試最少次數之作業的值。

類型:Int32
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-MinimumRunDurationInSeconds

指定作業篩選條件約束，以秒為單位，將傳回的值限制在指定時間長度下限完成的作業。

類型:Int32
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-OldestFirst

指出此 Cmdlet 會以最舊的順序列出作業。 如果您未指定此參數，Cmdlet 會使用最新的第一個順序。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-OutcomesType

指定作業篩選條件約束，限制在完成時傳回給具有指定結果之作業的值。

此參數可接受的值為：

-- 失敗 -- 成功 -- 重試 -- 已取消 -- 輸入 -- 未知

類型:CompletionResult
接受的值:Failed, Succeeded, Retry, Cancelled, InProgress, Unknown
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Path

指定 SQL Server Agent 的路徑，做為數位，此 Cmdlet 會在此數位上執行作業。 如果您未指定此參數的值，Cmdlet 會使用目前的工作位置。

類型:String[]
Position:1
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ProgressAction

決定 PowerShell 如何回應腳本、Cmdlet 或提供者所產生的進度更新，例如 Write-Progress Cmdlet 所產生的進度列。 Write-Progress Cmdlet 會建立顯示命令狀態的進度列。

類型:ActionPreference
別名:proga
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-ServerInstance

指定 SQL Server 實例的名稱做為陣列，其中會執行 SQL Agent。 針對預設實例，只指定計算機名稱：MyComputer。 針對具名實例，請使用 ComputerName\InstanceName 格式。

類型:String[]
Position:1
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Since

指定您可以取代 StartRunDate 參數的縮寫。

您可以使用 EndRunDate 參數來指定。

如果您使用此參數，就無法使用 StartRunDate 參數。

此參數可接受的值為：

  • 午夜 （取得午夜後產生的所有作業歷程記錄資訊）
  • 昨天 （取得過去 24 小時內產生的所有作業歷程記錄資訊）
  • LastWeek （取得上周產生的所有作業歷程記錄資訊）
  • LastMonth （取得上個月產生的所有作業歷程記錄資訊）
類型:SinceType
接受的值:Midnight, Yesterday, LastWeek, LastMonth
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-SqlMessageID

指定作業篩選條件約束，限制傳回給運行時間期間產生指定訊息之作業的值。

類型:Int32
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-SqlSeverity

指定作業篩選條件約束，限制傳回給運行時間期間產生指定嚴重性錯誤之作業的值。

類型:Int32
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-StartRunDate

指定工作篩選條件約束，限制工作啟動日期所傳回的值。

類型:DateTime
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-TrustServerCertificate

指出通道是否會在略過憑證鏈結以驗證信任時加密。

在模組的 v22 中，預設值為 $true （為了與 v21 相容）。 在模組的 v23+ 中，預設值會是 『$false』，這可能會為現有的腳本建立重大變更。

此參數是模組 v22 的新功能。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

輸入

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer[]

輸出

System.Object