commands

^

Remove-DbaDbMasterKey

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Deletes specified database master key

Description

Deletes specified database master key

Syntax

Remove-DbaDbMasterKey
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [-All]
    [[-InputObject] <MasterKey[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

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.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required False
Pipeline false
Default Value
-SqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-Database

The database where the master key will be removed.

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

List of databases to exclude from clearing all master keys

Alias
Required False
Pipeline false
Default Value
-All

Purge the master keys from all databases on an instance

Alias
Required False
Pipeline false
Default Value False
-InputObject

Enables pipeline input from Get-DbaDatabase

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

Want to see the source code for this command? Check out Remove-DbaDbMasterKey on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaDbMasterKey.