Get-SqlColumnEncryptionKey
获取数据库中定义的所有列加密密钥对象，或获取具有指定名称的一列加密密钥对象。
语法
Get-SqlColumnEncryptionKey
[[-Name] <String>]
[-InputObject] <Database>
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] Get-SqlColumnEncryptionKey
[[-Name] <String>]
[[-Path] <String>]
[-Script]
[-AccessToken <PSObject>]
[-TrustServerCertificate]
[-HostNameInCertificate <String>]
[-Encrypt <String>]
[-ProgressAction <ActionPreference>]
[<CommonParameters>] 说明
Get-SqlColumnEncryptionKey cmdlet 返回目标数据库中每个列加密密钥的列加密密钥对象。
如果提供了列加密密钥的名称，该 cmdlet 将返回一个特定的列加密密钥对象。
示例
示例 1：从数据库获取所有列加密密钥
PS C:\> Get-SqlColumnEncryptionKey此命令从数据库获取所有列加密密钥。
示例 2：从指定的列加密密钥获取
PS C:\> Get-SqlColumnEncryptionKey -Name "CEK1"此命令从名为“CEK1”的列加密密钥对象中获取列加密密钥。
参数
-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 |
-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
指定此 cmdlet 为其运行操作的 SQL 数据库对象。
| 类型: | Database |
| Position: | 2 |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-Name
指定列加密密钥对象的名称。
| 类型: | String |
| Position: | 1 |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Path
指定此 cmdlet 为其运行操作的 SQL 数据库的路径。 如果未为此参数指定值，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 运行脚本以获取 SQL 列加密密钥值。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-TrustServerCertificate
指示通道是否在绕过证书链以验证信任的同时进行加密。
在模块的 v22 中，默认为 $true（为了与 v21 兼容）。 在模块的 v23+ 中，默认值将为“$false”，这可能会为现有脚本创建中断性变更。
此参数是模块 v22 中的新增参数。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
Microsoft.SqlServer.Management.Smo.Database
输出
SqlColumnEncryptionKey[]
SqlColumnEncryptionKey