commands

^

Get-DbaDbAsymmetricKey

Author Stuart Moore (@napalmgram), stuart-moore.com
Availability Windows, Linux, macOS

 

Synopsis

Gets database Asymmetric Key

Description

Gets database Asymmetric Key

Syntax

Get-DbaDbAsymmetricKey
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [[-Name] <String[]>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbAsymmetricKey -SqlInstance sql2016

Gets all Asymmetric Keys

Example: 2
PS C:\> Get-DbaDbAsymmetricKey -SqlInstance Server1 -Database db1

Gets the Asymmetric Keys for the db1 database

Example: 3
PS C:\> Get-DbaDbAsymmetricKey -SqlInstance Server1 -Database db1 -Name key1

Gets the key1 Asymmetric Key within the db1 database

Optional Parameters

-SqlInstance

The target SQL Server instance

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

Get Asymmetric Keys from specific database

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

Database(s) to ignore when retrieving Asymmetric Keys

Alias
Required False
Pipeline false
Default Value
-Name

Get specific Asymmetric Key by name

Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piping 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

 

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