Get-SqlAgentSchedule

获取 SQL 代理目标实例中存在的每个计划的 SQL 作业计划对象。

语法

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

说明

Get-SqlAgentSchedule cmdlet 获取 SQL 代理目标实例中存在的每个计划的 SQL JobSchedule 对象。 如果提供计划的名称,则 cmdlet 仅获取该特定的 JobSchedule 对象。

该 cmdlet 查询 Microsoft.SqlServer.Management.Smo.Agent.SharedSchedules SQL Server Management 对象 (SMO) 对象。 如果对与特定作业关联的计划感兴趣,请使用 Get-SqlAgentJobSchedule cmdlet。

此 cmdlet 支持以下操作模式来返回 JobSchedule 对象的集合:

  • 指定 SQL 代理的实例。
  • 指定作业实例的 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 代理上的所有作业计划。

参数

-AccessToken

用于向 SQL Server 进行身份验证的访问令牌,作为用户/密码或 Windows 身份验证的替代方法。

例如,这可用于使用 Service PrincipalManaged Identity连接到 SQL Azure DBSQL Azure Managed Instance

要使用的参数可以是表示令牌的字符串,也可以是运行 Get-AzAccessToken -ResourceUrl https://database.windows.net返回的 PSAccessToken 对象。

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

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

-ConnectionTimeout

指定此 cmdlet 在超时失败之前等待服务器连接的秒数。 超时值必须是介于 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 代理。

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

-Name

指定此 cmdlet 获取的 JobSchedule 对象的名称。

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

-Path

指定运行操作的 SQL Server 代理的路径。 如果未为此参数指定值,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 Server 实例的名称指定为运行 SQL 代理的数组。 对于默认实例,仅指定计算机名称: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.String[]

Microsoft.SqlServer.Management.Smo.Agent.JobServer

输出

System.Object