通过

Get-SqlAgent

模块:
SqlServer

获取 SQL Server 目标实例中存在的 SQL 代理对象。

语法

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

说明

Get-SqlAgent cmdlet 获取 SQL Server 目标实例中存在的 SQL 代理对象。

此 cmdlet 支持以下作模式：

  • 指定 SQL Server 目标实例的 ServerInstance 对象。
  • 指定 SQL Server 实例的 Path 参数。
  • 在有效上下文中调用 cmdlet。

示例

示例 1：获取服务器实例的 SQL 代理

PS C:\> Get-SqlAgent -ServerInstance "SERVERNAME\INSTANCENAME"

AgentDomainGroup          : NT SERVICE\SQLSERVERAGENT
AgentLogLevel             : Errors, Warnings
AgentMailType             : SqlAgentMail
AgentShutdownWaitTime     : 15
...

此命令获取服务器“SERVERNAME”上名为“INSTANCENAME”的服务器实例的 SQL 代理。

参数

-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
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ConnectionTimeout

指定在超时失败之前等待 SQL Server 连接的秒数。 超时值必须是介于 0 和 65534 之间的整数值。 如果指定了 0，则连接尝试不会超时。

类型:Int32
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Credential

指定一个 PSCredential 对象，该对象用于指定有权执行此作的 SQL Server 登录名的凭据。

类型:PSCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Encrypt

连接到 SQL Server 时要使用的加密类型。

此值映射到 Encrypt Microsoft.Data.SqlClient 驱动程序的 SqlConnection 对象上的属性 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

指定目标实例的服务器对象。

类型:Server
Position:1
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Path

指定运行该作的 SQL Server 实例的路径。 如果未为此参数指定值，cmdlet 将使用当前工作位置。

类型:String
Position:1
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ServerInstance

将 SQL Server 实例的名称指定为数组，该数组成为作的目标。

类型:String[]
Position:1
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-TrustServerCertificate

指示通道是否在绕过证书链以验证信任的同时进行加密。

在模块的 v22 中，默认值为 $true （为了与 v21 兼容）。 在模块的 v23+ 中，默认值将为“$false”，这可能会为现有脚本创建中断性变更。

此参数是模块 v22 中的新增参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

Microsoft.SqlServer.Management.Smo.Server

System.String[]

输出

System.Object