commands

^

Get-DbaCredential

Author Garry Bargsley (@gbargsley), http://blog.garrybargsley.com
Availability Windows, Linux, macOS

 

Synopsis

Gets SQL Credential information for each instance(s) of SQL Server.

Description

The Get-DbaCredential command gets SQL Credential information for each instance(s) of SQL Server.

Syntax

Get-DbaCredential
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Name] <String[]>]
    [[-ExcludeName] <String[]>]
    [[-Identity] <String[]>]
    [[-ExcludeIdentity] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaCredential -SqlInstance localhost

Returns all SQL Credentials on the local default SQL Server instance

Example: 2
PS C:\> Get-DbaCredential -SqlInstance localhost, sql2016 -Name 'PowerShell Proxy'

Returns the SQL Credentials named 'PowerShell Proxy' for the local and sql2016 SQL Server instances

Example: 3
PS C:\> Get-DbaCredential -SqlInstance localhost, sql2016 -Identity ad\powershell

Returns the SQL Credentials for the account 'ad\powershell' on the local and sql2016 SQL Server instances

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

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

Only include specific names Note: if spaces exist in the credential name, you will have to type "" or '' around it.

Alias
Required False
Pipeline false
Default Value
-ExcludeName

Excluded credential names

Alias
Required False
Pipeline false
Default Value
-Identity

Only include specific identities Note: if spaces exist in the credential identity, you will have to type "" or '' around it.

Alias CredentialIdentity
Required False
Pipeline false
Default Value
-ExcludeIdentity

Excluded identities

Alias ExcludeCredentialIdentity
Required False
Pipeline false
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-DbaCredential on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaCredential.