Get-SqlAgentSchedule

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

Syntax

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

Description

Get-SqlAgentSchedule Cmdlet 會取得 SQL Agent 目標實例中每個排程的 SQL JobSchedule 物件。 如果您提供排程的名稱,Cmdlet 只會取得該特定的 JobSchedule 物件。

Cmdlet 會查詢 Microsoft.SqlServer.Management.Smo.Agent.SharedSchedules SQL Server Management Object (SMO) 物件。 如果您對與特定作業相關聯的排程感興趣,請使用 Get-SqlAgentJobSchedule Cmdlet。

此 Cmdlet 支援下列作業模式,以傳回 JobSchedule 物件的集合:

  • 指定 SQL Agent 的實例。
  • 指定作業實例的Path參數。
  • 在有效的內容中叫用 Cmdlet。

範例

範例 1:取得指定伺服器實例上的所有作業排程

PS C:\> Get-SqlAgentSchedule -ServerInstance MyComputer | ? { $_.JobCount -eq 0 }

Name                           Jobs  Enabled    DateCreated               ActiveStartDate           ActiveEndDate             ID
----                           ----  -------    -----------               ---------------           -------------             --
EveryDay                       0     True       4/13/2016 11:36:30 AM     4/13/2016 12:00:00 AM     12/31/9999 12:00:00 AM    3
OnceAWeek                      0     True       4/13/2016 11:36:30 AM     4/13/2016 12:00:00 AM     12/31/9999 12:00:00 AM    4

此命令會取得位於沒有作業之伺服器實例 『MyComputer』 之 SQL Agent 上的所有作業排程。

參數

-AccessToken

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

例如,這可用來連線至 SQL Azure DB 或使用 或使用 SQL Azure Managed InstanceService PrincipalManaged Identity

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

這個參數是模組 v22 中的新功能。

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTimeout

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

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

-Credential

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

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Encrypt

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

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

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

這個參數是模組 v22 中的新功能。

Type:String
Accepted values:Mandatory, Optional, Strict
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HostNameInCertificate

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

這個參數是模組 v22 中的新功能。

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

-InputObject

指定目標實例的 SQL Server Agent。

Type:JobServer
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定這個 Cmdlet 取得的 JobSchedule 物件名稱。

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

-Path

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

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

-ServerInstance

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

Type:String[]
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-TrustServerCertificate

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

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

這個參數是模組 v22 中的新功能。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

System.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer

輸出

System.Object