Get-SqlAgentJobStep
获取 SQL 代理作业的目标实例中存在的每个步骤的 SQL JobStep 对象。
语法
ByPath （默认值）
Get-SqlAgentJobStep
[[-Name] <String>]
[[-Path] <String>]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
ByObject
Get-SqlAgentJobStep
[[-Name] <String>]
[-InputObject] <Job>
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[<CommonParameters>]
说明
Get-SqlAgentJobStep cmdlet 获取 SQL 代理作业目标实例中存在的每个步骤的 SQL JobStep 对象。 如果提供作业步骤的名称，则 cmdlet 仅获取此特定的 JobStep 对象。
此 cmdlet 支持以下作模式来返回 JobStep 对象的集合：
- 在输入中传递 SQL 代理作业的实例。
- 指定作业实例的 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 InstanceService Principal a 或 a Managed Identity.
要使用的参数可以是表示令牌的字符串，也可以是一个 PSAccessToken 通过运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的对象。
此参数是模块 v22 中的新增参数。
参数属性
| 类型: | PSObject |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Encrypt
连接到 SQL Server 时要使用的加密类型。
此值映射到 Encrypt Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象上的属性 SqlConnectionEncryptOption 。
在模块的 v22 中，默认值为 Optional （为了与 v21 兼容）。 在模块的 v23+ 中，默认值为“必需”，这可能会为现有脚本创建中断性变更。
此参数是模块 v22 中的新增参数。
参数属性
| 类型: | String |
| 默认值: | None |
| 接受的值: | Mandatory, Optional, Strict |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-HostNameInCertificate
验证 SQL Server TLS/SSL 证书时要使用的主机名。 如果为强制加密启用了 SQL Server 实例，并且想要使用主机名/shortname 连接到实例，则必须传递此参数。 如果省略此参数，则必须将完全限定域名（FQDN）传递给 -ServerInstance 才能连接到为强制加密启用的 SQL Server 实例。
此参数是模块 v22 中的新增参数。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-InputObject
指定目标实例的作业对象。
参数属性
| 类型: | Job |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByObject
| Position: | 2 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Name
指定此 cmdlet 获取的 JobStep 对象的名称。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
指定运行该 cmdlet 的作业对象的路径。 如果未为此参数指定值，cmdlet 将使用当前工作位置。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
ByPath
| Position: | 2 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-TrustServerCertificate
指示通道是否在绕过证书链以验证信任的同时进行加密。
在模块的 v22 中，默认值为 $true （为了与 v21 兼容）。 在模块的 v23+ 中，默认值将为“$false”，这可能会为现有脚本创建中断性变更。
此参数是模块 v22 中的新增参数。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。