functions/New-DbaDbCertificate.ps1
|
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle# function New-DbaDbCertificate { <# .SYNOPSIS Creates a new database certificate .DESCRIPTION Creates a new database certificate. If no database is specified, the certificate will be created in master. .PARAMETER SqlInstance The target SQL Server instance or instances. .PARAMETER SqlCredential Allows you to login to SQL Server using alternative credentials. .PARAMETER Database The database where the certificate will be created. Defaults to master. .PARAMETER Name Optional name to create the certificate. Defaults to database name. .PARAMETER Subject Optional subject to create the certificate. .PARAMETER StartDate Optional secure string used to create the certificate. .PARAMETER ExpirationDate Optional secure string used to create the certificate. .PARAMETER ActiveForServiceBrokerDialog Optional secure string used to create the certificate. .PARAMETER Password Optional password - if no password is supplied, the password will be protected by the master key .PARAMETER InputObject Enables piping from Get-DbaDatabase .PARAMETER WhatIf Shows what would happen if the command were to run. No actions are actually performed. .PARAMETER Confirm Prompts you for confirmation before executing any changing operations within the command. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Certificate Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .EXAMPLE PS C:\> New-DbaDbCertificate -SqlInstance Server1 You will be prompted to securely enter your password, then a certificate will be created in the master database on server1 if it does not exist. .EXAMPLE PS C:\> New-DbaDbCertificate -SqlInstance Server1 -Database db1 -Confirm:$false Suppresses all prompts to install but prompts to securely enter your password and creates a certificate in the 'db1' database #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = "Low")] param ( [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [string[]]$Name, [string[]]$Database = "master", [string[]]$Subject, [datetime]$StartDate = (Get-Date), [datetime]$ExpirationDate = $StartDate.AddYears(5), [switch]$ActiveForServiceBrokerDialog, [Security.SecureString]$Password, [parameter(ValueFromPipeline)] [Microsoft.SqlServer.Management.Smo.Database[]]$InputObject, [switch]$EnableException ) begin { Test-DbaDeprecation -DeprecatedOn "1.0.0" -Alias New-DbaDatabaseCertificate } process { if ($SqlInstance) { $InputObject += Get-DbaDatabase -SqlInstance $SqlInstance -SqlCredential $SqlCredential -Database $Database } foreach ($db in $InputObject) { if ((Test-Bound -Not -ParameterName Name)) { Write-Message -Level Verbose -Message "Name of certificate not specified, setting it to '$db'" $Name = $db.Name } if ((Test-Bound -Not -ParameterName Subject)) { Write-Message -Level Verbose -Message "Subject not specified, setting it to '$Name Database Certificate'" $subject = "$Name Database Certificate" } foreach ($cert in $Name) { if ($null -ne $db.Certificates[$cert]) { Stop-Function -Message "Certificate '$cert' already exists in $($db.Name) on $($db.Parent.Name)" -Target $db -Continue } if ($Pscmdlet.ShouldProcess($db.Parent.Name, "Creating certificate for database '$($db.Name)'")) { # something is up with .net, force a stop $eap = $ErrorActionPreference $ErrorActionPreference = 'Stop' try { $smocert = New-Object -TypeName Microsoft.SqlServer.Management.Smo.Certificate $db, $cert $smocert.StartDate = $StartDate $smocert.Subject = $Subject $smocert.ExpirationDate = $ExpirationDate $smocert.ActiveForServiceBrokerDialog = $ActiveForServiceBrokerDialog if ($Password) { $smocert.Create(([System.Runtime.InteropServices.marshal]::PtrToStringAuto([System.Runtime.InteropServices.marshal]::SecureStringToBSTR($password)))) } else { $smocert.Create() } Add-Member -Force -InputObject $smocert -MemberType NoteProperty -Name ComputerName -value $db.Parent.ComputerName Add-Member -Force -InputObject $smocert -MemberType NoteProperty -Name InstanceName -value $db.Parent.ServiceName Add-Member -Force -InputObject $smocert -MemberType NoteProperty -Name SqlInstance -value $db.Parent.DomainInstanceName Add-Member -Force -InputObject $smocert -MemberType NoteProperty -Name Database -value $db.Name Select-DefaultView -InputObject $smocert -Property ComputerName, InstanceName, SqlInstance, Database, Name, Subject, StartDate, ActiveForServiceBrokerDialog, ExpirationDate, Issuer, LastBackupDate, Owner, PrivateKeyEncryptionType, Serial } catch { $ErrorActionPreference = $eap Stop-Function -Message "Failed to create certificate in $($db.Name) on $($db.Parent.Name)" -Target $smocert -ErrorRecord $_ -Continue } $ErrorActionPreference = $eap } } } } } |