Get-SqlAgentJobStep
取得 SQL Agent 作業目標實例中每個步驟的 SQL JobStep 物件。
Syntax
Get-SqlAgentJobStep
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Get-SqlAgentJobStep
[[-Name] <String>]
[-InputObject] <Job>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
Description
Get-SqlAgentJobStep Cmdlet 會取得 SQL Agent 作業目標實例中每個步驟的 SQL JobStep 物件。 如果您提供作業步驟的名稱,Cmdlet 只會取得這個特定的 JobStep 物件。
此 Cmdlet 支援下列作業模式,以傳回 JobStep 物件的集合:
- 在輸入中傳遞 SQL Agent 作業的實例。
- 指定 Job 實例的 Path 參數。
- 在有效的內容中叫用 Cmdlet。
範例
範例 1:取得作業實例中的所有 JobStep 實例
PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobStep
Name ID OnSuccessAction OnFailAction LastRunDate LastRunDuration
---- -- --------------- ------------ ----------- ---------------
step1 1 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 4.03:23:45
step2 2 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 00:33:59
step3 3 GoToNextStep QuitWithSuccess 1/1/0001 12:00:00 AM 00:00:11
此命令會使用 Get-SqlAgent Cmdlet 來取得名為 'MyServerInstance' 的伺服器實例,然後使用管線將結果傳遞至 Get-SqlAgentJob Cmdlet。 命令接著會使用管線將結果傳遞至 Get-SqlAgentJobStep Cmdlet,以取得所有 JobStep 實例。
範例 2:依名稱取得 JobStep 實例
PS C:\> Get-SqlAgent -ServerInstance "MyServerInstance" | Get-SqlAgentJob | Get-SqlAgentJobStep -Name "Step1"
Name ID OnSuccessAction OnFailAction LastRunDate LastRunDuration
---- -- --------------- ------------ ----------- ---------------
step1 1 QuitWithSuccess QuitWithFailure 1/1/0001 12:00:00 AM 4.03:23:45
此命令會使用 Get-SqlAgent Cmdlet 來取得名為 'MyServerInstance' 的伺服器實例,然後使用管線將結果傳遞至 Get-SqlAgentJob Cmdlet。 命令接著會使用管線將結果傳遞至 Get-SqlAgentJobStep Cmdlet,以取得名為 'Step1' 的 JobStep 實例。
參數
-AccessToken
用來驗證 SQL Server 的存取令牌,作為使用者/密碼或 Windows 驗證的替代方案。
例如,這可用來連線至 SQL Azure DB
或使用 或使用 SQL Azure Managed Instance
Service Principal
或 Managed 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 |
-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
指定目標實例的作業物件。
Type: | Job |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
指定這個 Cmdlet 取得的 JobStep 物件名稱。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
指定這個 Cmdlet 執行作業之作業物件的路徑。 如果您未指定此參數的值,Cmdlet 會使用目前的工作位置。
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
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 |
輸入
Microsoft.SqlServer.Management.Smo.Agent.Job
輸出
System.Object