New-Credential

DBSystems: Creates a new SQL Server credential object

Script

#Requires -Version 5.0
#Requires -Modules SQLServer

[CmdLetBinding()]
Param(
    [Parameter(Mandatory = $true)]   
    [string]$Name,    
    [Parameter(Mandatory = $true)]   
    [string]$Identity,       
    [Parameter(Mandatory = $true)]   
    [securestring]$Password,
    [Parameter(Mandatory = $true)]   
    [string]$ServerInstance,    
    [pscredential]$ServerCredential,
    [int]$ConnectionTimeout = 30
)

function Get-SqlServerInstanceInternal {
    [CmdLetBinding()]
    Param(
        [Parameter(Mandatory = $true)]   
        [string]$ServerInstance,    
        [pscredential]$ServerCredential,
        [int]$ConnectionTimeout = 30
    )
    try {
        [hashtable]$cmdArgs = @{
            'ErrorAction' = 'Stop'
            'Confirm' = $false
            'ServerInstance' = $ServerInstance
            'ConnectionTimeout' = $ConnectionTimeout
        }
        if ($null -ne $ServerCredential) {
            $cmdArgs.Add('Credential', $ServerCredential)
        }
        return Get-SqlInstance @cmdArgs
    } catch {
        throw
    }
}

Import-Module SQLServer

try {
    $instance = Get-SqlServerInstanceInternal -ServerInstance $ServerInstance -ServerCredential $ServerCredential -ConnectionTimeout $ConnectionTimeout

    [hashtable]$cmdArgs = @{
        'ErrorAction' = 'Stop'
        'Name'        = $Name
        'Identity'    = $Identity
        'InputObject' = $instance
        'Secret'      = $Password
        'Confirm'     = $false
    }    
       
    $result = New-SqlCredential @cmdArgs | Select-Object *
    Write-Output $result
} catch {
    throw
}

Customize

Name string

Specifies the name of the new SQL Server credential

Identity string

Specifies the name of the user or account for the credential

Password securestring

Specifies the password for the account as a SecureString

ServerInstance string

Specifies the name of the target computer including the instance name, e.g. MyServer\Instance

ServerCredential pscredential

Specifies a PSCredential object for the connection to the SQL Server. ServerCredential is ONLY used for SQL Logins. When you are using Windows Authentication you don't specify -Credential. It is picked up from your current login.

ConnectionTimeout int

Specifies the time period to retry the command on the target server