共用方式為

Get-SqlAgentJob

  • 參考
模組:
SQLServer

取得 SQL Agent 目標實例中每個作業的 SQL Agent 作業物件。

語法

Get-SqlAgentJob
   [[-Name] <String>]
   [[-Path] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentJob
   [[-ServerInstance] <String[]>]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [[-Name] <String>]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-SqlAgentJob
   [[-Name] <String>]
   [-InputObject] <JobServer>
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get-SqlAgentJob Cmdlet 會針對存在於 SQL Agent 目標實例中的每個作業取得 SQL Agent 作業物件。 如果提供作業的名稱，Cmdlet 只會取得這個特定的作業物件。

此 Cmdlet 支援下列作業模式，以取得 Job 物件的集合：

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

範例

範例 1：從指定的伺服器實例取得所有作業實例

PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob
Name                      Owner                Category                  Enabled    CurrentRunStatus     DateCreated               LastModified              JobID
----                      -----                --------                  -------    ----------------     -----------               ------------              -----
MyJob1                    Owner                [Uncategorized (Local)]   True       Idle                 6/2/2016 10:21:44 AM      6/2/2016 10:21:44 AM      841255df-06e8-43ef-b798-3... 
MyJob2                    Owner                [Uncategorized (Local)]   True       Idle                 5/31/2016 2:40:58 PM      6/1/2016 5:09:40 PM       995b296a-cd35-4505-868a-3... 
MyJob3                    Owner                [Uncategorized (Local)]   True       Idle                 5/25/2016 12:13:56 PM     5/25/2016 12:13:56 PM     01d2e61a-9a90-4f77-98f4-e...

此命令會取得伺服器實例中名為 『MyServerInstance』 的所有作業實例。

範例 2：依名稱從指定的伺服器實例取得作業實例

PS C:\> Get-SqlAgent -ServerInstance MyServerInstance | Get-SqlAgentJob -Name MyJob1
Name                      Owner                Category                  Enabled    CurrentRunStatus     DateCreated               LastModified              JobID
----                      -----                --------                  -------    ----------------     -----------               ------------              -----
MyJob1                    Owner                [Uncategorized (Local)]   True       Idle                 6/2/2016 10:21:44 AM      6/2/2016 10:21:44 AM      841255df-06e8-43ef-b798-3...

此命令會在名為 『MyServerInstance』 的伺服器實例中取得名為 『MyJob1』 的作業實例。

參數

-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

-HostNameInCertificate

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

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

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

-InputObject

指定代表目標之 SQL Server Agent 的 SQL 管理物件 （SMO） 物件。

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

-Name

指定這個 Cmdlet 取得的 Job 物件名稱。 根據執行 SQL Agent 的 SQL Server 定序，名稱可能不區分大小寫。

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

-Path

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

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

-ProgressAction

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

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

-ServerInstance

指定 SQL Agent 執行位置之 SQL Server 實例的名稱做為字串數位。 針對預設實例，只指定計算機名稱：MyComputer。 針對具名實例，請使用 ComputerName\InstanceName 格式。

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

-TrustServerCertificate

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

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

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

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

輸出

System.Object