commands

^

Remove-DbaCredential

Author Mikey Bronowski (@MikeyBronowski), https://bronowski.it
Availability Windows, Linux, macOS

 

Synopsis

Removes SQL credential(s).

Description

Removes the SQL credential(s) that have passed through the pipeline. If not used with a pipeline, Get-DbaCredential will be executed with the parameters provided and the returned SQL credential(s) will be removed.

Syntax

Remove-DbaCredential
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Credential <String[]>]
    [-ExcludeCredential <String[]>]
    [-Identity <String[]>]
    [-ExcludeIdentity <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Remove-DbaCredential
    [-SqlInstance <DbaInstanceParameter[]>]
    [-SqlCredential <PSCredential>]
    [-Credential <String[]>]
    [-ExcludeCredential <String[]>]
    [-Identity <String[]>]
    [-ExcludeIdentity <String[]>] -InputObject <Credential[]>
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaCredential -SqlInstance localhost, localhost\namedinstance

Removes all SQL credentials on the localhost, localhost\namedinstance instances.

Example: 2
PS C:\> Remove-DbaCredential -SqlInstance localhost -Credential MyDatabaseCredential

Removes MyDatabaseCredential SQL credential on the localhost.

Example: 3
PS C:\> Get-DbaCredential -SqlInstance SRV1 | Out-GridView -Title 'Select SQL credential(s) to drop' -OutputMode Multiple | Remove-DbaCredential

Using a pipeline this command gets all SQL credentials on SRV1, lets the user select those to remove and then removes the selected SQL credentials.

Required Parameters

-InputObject

Allows piping from Get-DbaCredential.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

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

Specifies one or more SQL credential(s) to delete. If unspecified, all accounts will be removed.

Alias
Required False
Pipeline false
Default Value
-ExcludeCredential

Specifies one or more SQL credential(s) to exclude.

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
Required False
Pipeline false
Default Value
-ExcludeIdentity

Excluded identities

Alias
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
-WhatIf

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

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command. This is the default. Use -Confirm:$false to suppress these prompts.

Alias cf
Required False
Pipeline false
Default Value

 

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