New-SqlCredential
Creates a SQL Server credential object.
Syntax
New-SqlCredential
-Identity <String>
[-Secret <SecureString>]
[-ProviderName <String>]
[-Name] <String>
[[-Path] <String>]
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-SqlCredential
-Identity <String>
[-Secret <SecureString>]
[-ProviderName <String>]
[-Name] <String>
[-InputObject] <Server>
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-SqlCredential cmdlet creates a new SQL Server credential object. A SQL Server credential object is used to store authentication information. The SQL Server credential is required when backing up to or restoring from the Windows Azure storage service, and is used to store the Windows Azure storage account name and access key information.
Examples
Example 1: Create a SQL credential for the current instance of SQL Server
PS C:\> cd SQLServer:\SQL\Computer\Instance
PS SQLServer:\SQL\Computer\Instance> New-SqlCredential -Name "MySqlCredential" -Identity "MyWindowsAzureStorageAccount" -Secret "P4ssw0rd"The first command changes the directory to SQLServer:\SQL\Computer\Instance.
Example 2: Create a SQL credential for all instances of SQL Server
PS C:\> cd SQLServer:\SQL\Computer\Instance
PS SQLServer:\SQL\Computer\Instance> $SecureString = ConvertTo-SecureString "P4ssw0rd" -AsPlainText -Force
PS SQLServer:\SQL\Computer\Instance> $Instances = Get-ChildItem
PS SQLServer:\SQL\Computer\Instance> $Instances | New-SqlCredential -Name "MySqlCredential" -Identity "MyWindowsAzureStorageAccount" -Secret $SecureStringThe first command changes the directory to SQLServer:\SQL\Computer\Instance.
The forth command uses the pipeline to pass the instances to the New-SqlCredential to create a SQL Credential
named MySqlCredential on all the instances of SQL Server.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Identity
Specifies the name of user or account. For Windows Azure storage service authentication, this is the name of the Windows Azure storage account.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the Server object where the credential should be created.
| Type: | Server |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the credential.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Specifies the path of the instance of SQL Server for which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProviderName
Specifies the cryptographic provider name for the Enterprise Key Management Provider (EKM).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Script
Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Secret
Specifies the password for the user or account. For Windows Azure storage service authentication, this is the storage account access key value.
| Type: | SecureString |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.SqlServer.Management.Smo.Server