| Author | Garry Bargsley (@gbargsley), blog.garrybargsley.com |
| Availability | Windows, Linux, macOS |
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.
Gets SQL Credential information for each instance(s) of SQL Server.
The Get-DbaCredential command gets SQL Credential information for each instance(s) of SQL Server.
Get-DbaCredential
[-SqlInstance] <DbaInstanceParameter[]>
[[-SqlCredential] <PSCredential>]
[[-Credential] <String[]>]
[[-ExcludeCredential] <String[]>]
[[-Identity] <String[]>]
[[-ExcludeIdentity] <String[]>]
[-EnableException]
[<CommonParameters>]
PS C:\> Get-DbaCredential -SqlInstance localhost
Returns all SQL Credentials on the local default SQL Server instance
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
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
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 |
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 |
Only include specific names
Note: if spaces exist in the credential name, you will have to type "" or '' around it.
| Alias | Name |
| Required | False |
| Pipeline | false |
| Default Value |
Excluded credential names
| Alias | ExcludeName |
| Required | False |
| Pipeline | false |
| Default Value |
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 |
Excluded identities
| Alias | ExcludeCredentialIdentity |
| Required | False |
| Pipeline | false |
| Default Value |
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 |