New-DbaDbMasterKey

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

Synopsis

Creates a new database master key

Description

Creates a new database master key. If no database is specified, the master key will be created in master.

Syntax

New-DbaDbMasterKey
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Credential] <PSCredential>]
    [[-Database] <String[]>]
    [[-SecurePassword] <SecureString>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> New-DbaDbMasterKey -SqlInstance Server1

You will be prompted to securely enter your password, then a master key will be created in the master database on server1 if it does not exist.

Example: 2

PS C:\> New-DbaDbMasterKey -SqlInstance Server1 -Credential usernamedoesntmatter

You will be prompted by a credential interface to securely enter your password, then a master key will be created in the master database on server1 if it does not exist.

Example: 3

PS C:\> New-DbaDbMasterKey -SqlInstance Server1 -Database db1 -Confirm:$false

Suppresses all prompts to install but prompts in th console to securely enter your password and creates a master key in the 'db1' database

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

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

-Credential

Enables easy creation of a secure password.

-Database

The database where the master key will be created. Defaults to master.

-SecurePassword

Secure string used to create the key.

-InputObject

Database object piped in from Get-DbaDatabase.

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

-WhatIf

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

-Confirm

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