Skip to content

AvoidUsingUsernameAndPasswordParams.md

Latest commit

 

History

History
53 lines (43 loc) · 828 Bytes

AvoidUsingUsernameAndPasswordParams.md

File metadata and controls

53 lines (43 loc) · 828 Bytes
description Avoid Using Username and Password Parameters
ms.custom PSSA v1.21.0
ms.date 06/28/2023
ms.topic reference
title AvoidUsingUsernameAndPasswordParams

AvoidUsingUsernameAndPasswordParams

Severity Level: Error

Description

To standardize command parameters, credentials should be accepted as objects of type PSCredential. Functions should not make use of username or password parameters.

How

Change the parameter to type PSCredential.

Example

Wrong

function Test-Script
{
    [CmdletBinding()]
    Param
    (
        [String]
        $Username,
        [SecureString]
        $Password
    )
    ...
}

Correct

function Test-Script
{
    [CmdletBinding()]
    Param
    (
        [PSCredential]
        $Credential
    )
    ...
}