通过

Get-SqlSmartAdmin

  • 参考
模块:
SQLServer

获取 SQL 智能管理员对象及其属性。

语法

Get-SqlSmartAdmin
   [[-Name] <String>]
   [-DatabaseName <String>]
   [-ServerInstance <PSObject>]
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlSmartAdmin
   [[-Name] <String>]
   [-DatabaseName <String>]
   [-ServerInstance <PSObject>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlSmartAdmin
   [[-Name] <String>]
   [-DatabaseName <String>]
   [-ServerInstance <PSObject>]
   [-InputObject] <Server>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Get-SqlSmartAdmin cmdlet 获取 SQL 智能管理员对象。 Smart Admin 对象包括 SQL Server 托管备份到 Windows Azure_2配置设置。 此 cmdlet 支持以下操作模式来返回对象：

  • 使用 Name 参数传递服务器实例的名称。 对于默认实例，仅指定计算机名称。 对于命名实例，请使用 Computername\InstanceName。
  • 将 SQL Server 实例的路径传递给 Path 参数。

示例

示例 1：从计算机获取智能管理员对象属性

PS C:\> Get-SqlSmartAdmin -Name "Computer\MyInstance"

此命令从名为“Computer\MyInstance”的计算机获取智能管理员对象属性。

参数

-AccessToken

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

例如，这可用于使用 Service Principal 或 Managed Identity连接到 SQL Azure DB 和 SQL Azure Managed Instance。

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

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

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

-Confirm

在运行 cmdlet 之前，提示你进行确认。

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

-DatabaseName

指定此 cmdlet 获取 SQL 智能管理员对象的数据库的名称。

类型:String
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

指定 Server 对象的实例。

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

-Name

以以下格式指定 SQL Server 实例的名称：Computer\Instance。

类型: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

-Script

指示此 cmdlet 运行执行任务的 Transact-SQL 脚本。

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

-ServerInstance

指定 SQL Server 实例的名称。 对于默认实例，仅指定计算机名称：MyComputer。 对于命名实例，请使用 ComputerName\InstanceName 格式。 Name 和 ServerInstance 参数都允许指定实例的名称，但 ServerInstance 还接受服务器实例名称或 SqInstanceInfo 对象的管道输入。

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

-TrustServerCertificate

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

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

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

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

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

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

输入

System.Management.Automation.PSObject

Microsoft.SqlServer.Management.Smo.Server