< Back
New-DbaCredential
Post
NAME New-DbaCredential
SYNOPSIS
Creates a new SQL Server credential
SYNTAX
New-DbaCredential [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Name] <System.Object[]>] [-Identity] <System.String[]> [[-SecurePassword] <Securestring>]
[[-MappedClassType] <String>] [[-ProviderName] <String>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Creates a new credential
PARAMETERS
-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
-Force [<Switch>]
If credential exists, drop and recreate
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Identity [<System.String[]>]
The Credential Identity
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MappedClassType [<String>]
Sets the class associated with the credential.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.Object[]>]
The Credential name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ProviderName [<String>]
Sets the name of the provider
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SecurePassword [<Securestring>]
Secure string used to authenticate the Credential Identity
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(s)
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: Certificate, Credential
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaCredential -SqlInstance Server1
You will be prompted to securely enter your password, then a credential will be created in the master database on
server1 if it does not exist.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaCredential -SqlInstance Server1 -Confirm:$false
Suppresses all prompts to install but prompts to securely enter your password and creates a credential on Server1.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$params = @{
>>SqlInstance = "Server1"
>>Name = "AzureBackupBlobStore"
>>Identity = "https://<Azure Storage Account Name>.blob.core.windows.net/<Blob Container Name>"
>>SecurePassword = (ConvertTo-SecureString '<Azure Storage Account Access Key>' -AsPlainText -Force)
>>}
PS C:\\> New-DbaCredential @params
Creates a credential, "AzureBackupBlobStore", on Server1 using the Access Keys for Backup To URL. Identity must be
the full URI for the blob container that will be the backup target. The SecurePassword supplied is one of the two
Access Keys for the Azure Storage Account.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>$sasParams = @{
>>SqlInstance = "server1"
>>Name = "https://<azure storage account name>.blob.core.windows.net/<blob container>"
>>Identity = "SHARED ACCESS SIGNATURE"
>>SecurePassword = (ConvertTo-SecureString '<Shared Access Token>' -AsPlainText -Force)
>>}
PS C:\\> New-DbaCredential @sasParams
Create a credential on Server1 using a SAS token for Backup To URL. The Name is the full URI for the blob
container that will be the backup target.
The SecurePassword will be the Shared Access Token (SAS), as a SecureString.
RELATED LINKS
SYNOPSIS
Creates a new SQL Server credential
SYNTAX
New-DbaCredential [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [[-Name] <System.Object[]>] [-Identity] <System.String[]> [[-SecurePassword] <Securestring>]
[[-MappedClassType] <String>] [[-ProviderName] <String>] [-Force <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Creates a new credential
PARAMETERS
-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
-Force [<Switch>]
If credential exists, drop and recreate
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Identity [<System.String[]>]
The Credential Identity
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-MappedClassType [<String>]
Sets the class associated with the credential.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.Object[]>]
The Credential name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ProviderName [<String>]
Sets the name of the provider
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SecurePassword [<Securestring>]
Secure string used to authenticate the Credential Identity
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(s)
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: Certificate, Credential
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaCredential -SqlInstance Server1
You will be prompted to securely enter your password, then a credential will be created in the master database on
server1 if it does not exist.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaCredential -SqlInstance Server1 -Confirm:$false
Suppresses all prompts to install but prompts to securely enter your password and creates a credential on Server1.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$params = @{
>>SqlInstance = "Server1"
>>Name = "AzureBackupBlobStore"
>>Identity = "https://<Azure Storage Account Name>.blob.core.windows.net/<Blob Container Name>"
>>SecurePassword = (ConvertTo-SecureString '<Azure Storage Account Access Key>' -AsPlainText -Force)
>>}
PS C:\\> New-DbaCredential @params
Creates a credential, "AzureBackupBlobStore", on Server1 using the Access Keys for Backup To URL. Identity must be
the full URI for the blob container that will be the backup target. The SecurePassword supplied is one of the two
Access Keys for the Azure Storage Account.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>$sasParams = @{
>>SqlInstance = "server1"
>>Name = "https://<azure storage account name>.blob.core.windows.net/<blob container>"
>>Identity = "SHARED ACCESS SIGNATURE"
>>SecurePassword = (ConvertTo-SecureString '<Shared Access Token>' -AsPlainText -Force)
>>}
PS C:\\> New-DbaCredential @sasParams
Create a credential on Server1 using a SAS token for Backup To URL. The Name is the full URI for the blob
container that will be the backup target.
The SecurePassword will be the Shared Access Token (SAS), as a SecureString.
RELATED LINKS