< Back

Remove-DbaDbMasterKey

Mon Jan 13, 2020 1:18 pm

NAME Remove-DbaDbMasterKey



SYNOPSIS

Deletes specified database master key





SYNTAX

Remove-DbaDbMasterKey [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [-All

<Switch>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.MasterKey[]>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

Deletes specified database master key





PARAMETERS

-All [<Switch>]

Purge the master keys from all databases on an instance



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Database [<System.String[]>]

The database where the master key will be removed.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnableException [<Switch>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExcludeDatabase [<System.String[]>]

List of databases to exclude from clearing all master keys



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-InputObject [<Microsoft.SqlServer.Management.Smo.MasterKey[]>]

Enables pipeline input from Get-DbaDatabase



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlCredential [<Pscredential>]

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).



Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -

Integrated are all supported.



For MFA support, please use Connect-DbaInstance.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

The target SQL Server instance or instances.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Tags: Certificate, Masterkey

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 1 --------------------------



PS C:\\>Remove-DbaDbMasterKey -SqlInstance sql2017, sql2016 -Database pubs



The master key in the pubs database on sql2017 and sql2016 will be removed if it exists.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Remove-DbaDbMasterKey -SqlInstance sql2017 -Database db1 -Confirm:$false



Suppresses all prompts to remove the master key in the 'db1' database and drops the key.

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-DbaDbMasterKey -SqlInstance sql2017 -Database db1 | Remove-DbaDbMasterKey -Confirm:$false



Suppresses all prompts to remove the master key in the 'db1' database and drops the key.



RELATED LINKS

https://dbatools.io/Remove-DbaMasterKey