New-ColumnMasterKey
DBSystems: Creates a new SQL Server database column master key
#Requires -Version 5.0
#Requires -Modules SQLServer
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true)]
[string]$ServerInstance,
[Parameter(Mandatory = $true)]
[string]$DatabaseName,
[Parameter(Mandatory = $true)]
[string]$KeyName,
[Parameter(Mandatory = $true)]
[ValidateSet('CurrentUser','LocalMachine')]
[string]$CertificateStoreLocation = 'LocalMachine',
[Parameter(Mandatory = $true)]
[string]$CertificateThumbprint,
[pscredential]$ServerCredential,
[int]$ConnectionTimeout = 30
)
function Get-SqlServerInstanceInternal {
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true)]
[string]$ServerInstance,
[pscredential]$ServerCredential,
[int]$ConnectionTimeout = 30
)
try {
[hashtable]$cmdArgs = @{
'ErrorAction' = 'Stop'
'Confirm' = $false
'ServerInstance' = $ServerInstance
'ConnectionTimeout' = $ConnectionTimeout
}
if ($null -ne $ServerCredential) {
$cmdArgs.Add('Credential', $ServerCredential)
}
return Get-SqlInstance @cmdArgs
} catch {
throw
}
}
function Get-SqlDatabaseInternal {
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true)]
[object]$ServerInstance,
[Parameter(Mandatory = $true)]
[string]$DatabaseName
)
try {
[hashtable]$cmdArgs = @{
'ErrorAction' = 'Stop'
'InputObject' = $ServerInstance
'Name' = $DatabaseName
'Confirm' = $false
}
return Get-SqlDatabase @cmdArgs
} catch {
throw
}
}
Import-Module SQLServer
try {
$instance = Get-SqlServerInstanceInternal -ServerInstance $ServerInstance -ServerCredential $ServerCredential -ConnectionTimeout $ConnectionTimeout
$db = Get-SqlDatabaseInternal -DatabaseName $DatabaseName -ServerInstance $instance
$CmkSettings = New-SqlCertificateStoreColumnMasterKeySettings -CertificateStoreLocation $CertificateStoreLocation -Thumbprint $CertificateThumbprint -ErrorAction Stop
$result = New-SqlColumnMasterKey -Name $KeyName -ColumnMasterKeySettings $CmkSettings -InputObject $db -ErrorAction Stop
Write-Output $result
} catch {
throw
}Specifies the name of the target computer including the instance name, e.g. MyServer\Instance
Specifies the name of the new column master key object
Specifies the thumbprint of the certificate to use as the master key
Specifies a PSCredential object for the connection to the SQL Server. ServerCredential is ONLY used for SQL Logins. When you are using Windows Authentication you don't specify -Credential. It is picked up from your current login.
Specifies the time period to retry the command on the target server