< Back
Get-DbaDbAsymmetricKey
Post
NAME Get-DbaDbAsymmetricKey
SYNOPSIS
Gets database Asymmetric Key
SYNTAX
Get-DbaDbAsymmetricKey [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [[-Name]
<System.String[]>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets database Asymmetric Key
PARAMETERS
-Database [<System.String[]>]
Get Asymmetric Keys from specific database
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[]>]
Database(s) to ignore when retrieving Asymmetric Keys
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piping from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.String[]>]
Get specific Asymmetric Key by name
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
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: AsymmetricKey
Author: Stuart Moore (@napalmgram), stuart-moore.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
SYNOPSIS
Gets database Asymmetric Key
SYNTAX
Get-DbaDbAsymmetricKey [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [[-Name]
<System.String[]>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Gets database Asymmetric Key
PARAMETERS
-Database [<System.String[]>]
Get Asymmetric Keys from specific database
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[]>]
Database(s) to ignore when retrieving Asymmetric Keys
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piping from Get-DbaDatabase
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.String[]>]
Get specific Asymmetric Key by name
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
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: AsymmetricKey
Author: Stuart Moore (@napalmgram), stuart-moore.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS