New-SqlColumnMasterKey

在数据库中创建列主密钥对象。

语法

New-SqlColumnMasterKey
   -ColumnMasterKeySettings <SqlColumnMasterKeySettings>
   [-Name] <String>
   [-InputObject] <Database>
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
New-SqlColumnMasterKey
   -ColumnMasterKeySettings <SqlColumnMasterKeySettings>
   [-Name] <String>
   [[-Path] <String>]
   [-Script]
   [-AccessToken <PSObject>]
   [-TrustServerCertificate]
   [-HostNameInCertificate <String>]
   [-Encrypt <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

说明

New-SqlColumnMasterKey cmdlet 在数据库中创建列主密钥对象。 列主密钥对象捕获要用作 Always Encrypted 功能的列主密钥的物理加密密钥的位置。

示例

示例 1:创建引用证书的列主密钥对象

$CmkSettings = New-SqlCertificateStoreColumnMasterKeySettings -CertificateStoreLocation 'CurrentUser' -CertificateThumbprint 'f2260f28d909d21c642a3d8e0b45a830e79a1420'
New-SqlColumnMasterKey -Name 'CMK1' -ColumnMasterKeySettings $CmkSettings

第一个命令使用 New-SqlCertificateStoreColumnMasterKeySettings cmdlet 创建引用 Windows 证书存储中的证书的列主设置,并将结果存储在名为 $CmkSettings的变量中。

示例 2:创建引用 Azure Key Vault 中的密钥的列主密钥对象

$CmkSettings = New-SqlAzureKeyVaultColumnMasterKeySettings -KeyUrl 'https://myvault.vault.contoso.net/keys/CMK/4c05f1a41b12488f9cba2ea964b6a700'
New-SqlColumnMasterKey 'CMK1' -ColumnMasterKeySettings $CmkSettings

第一个命令使用 New-SqlCertificateStoreColumnMasterKeySettings cmdlet 创建引用 Azure Key Vault 中的密钥的列主密钥对象,并将结果存储在名为 $CmkSettings的变量中。

示例 3:创建引用支持 CNG 的密钥的列主密钥对象

$CmkSettings = New-SqlCngColumnMasterKeySettings -CngProviderName 'Microsoft Software Key Storage Provider' -KeyName 'AlwaysEncryptedKey'
New-SqlColumnMasterKey 'CMK1' -ColumnMasterKeySettings $CmkSettings

第一个命令使用 New-SqlCertificateStoreColumnMasterKeySettings cmdlet 在支持加密下一代 API 的密钥存储中创建引用密钥的列主密钥对象,并将结果存储在名为 $CmkSettings的变量中。

示例 4:创建引用支持 CSP 的密钥的列主密钥对象

$CmkSettings = New-SqlCspColumnMasterKeySettings 'MyCspProvider' 'AlwaysEncryptedKey'
New-SqlColumnMasterKey 'CMK1' -ColumnMasterKeySettings $CmkSettings

第一个命令使用 New-SqlCertificateStoreColumnMasterKeySettings cmdlet 创建列主密钥对象,该对象引用密钥存储中的密钥存储中具有支持加密 API(CAPI)的加密服务提供程序(CSP)。

示例 5:创建引用证书的列主密钥对象,该对象是自动签名并支持 enclave 计算

$CmkSettings = New-SqlCertificateStoreColumnMasterKeySettings -CertificateStoreLocation 'CurrentUser' -CertificateThumbprint 'f2260f28d909d21c642a3d8e0b45a830e79a1420' -AllowEnclaveComputations
New-SqlColumnMasterKey -Name 'CMK1' -ColumnMasterKeySettings $CmkSettings

第一个命令使用 New-SqlCertificateStoreColumnMasterKeySettings cmdlet 创建引用支持 enclave 计算并存储在 Windows 证书存储中的证书的列主设置。

参数

-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

-ColumnMasterKeySettings

指定 SqlColumnMasterKeySettings 对象,该对象指定实际列主密钥的位置。

SqlColumnMasterKeySettings 对象具有两个属性:KeyStoreProviderNameKeyPath

KeyStoreProviderName 指定列主密钥存储提供程序的名称,启用 Always Encrypted 的客户端驱动程序必须使用该提供程序访问包含列主密钥的密钥存储。

KeyPath 指定密钥存储中列主密钥的位置。 KeyPath 格式特定于密钥存储。

类型:SqlColumnMasterKeySettings
Position:Named
默认值:None
必需:True
接受管道输入: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

指定此 cmdlet 创建的列主密钥对象的名称。

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

-Path

指定运行操作的 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 返回执行此 cmdlet 执行的任务的 Transact-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

输出

Microsoft.SqlServer.Management.Smo.SqlColumnMasterKey