Skip to content

UsePSCredentialType.md

Latest commit

 

History

History
51 lines (38 loc) · 1.22 KB

UsePSCredentialType.md

File metadata and controls

51 lines (38 loc) · 1.22 KB
Raw
description Use PSCredential type
ms.date 07/21/2026
ms.topic reference
title UsePSCredentialType

UsePSCredentialType

Severity Level: Warning

Default state: Always enabled

Description

This rule detects when a cmdlet or function defines a Credential parameter with a type other than PSCredential. Credential parameters should always use the PSCredential type to ensure proper handling of secure credential objects. Change any Credential parameter's type to PSCredential for consistency and security.

Example

Noncompliant

function Credential([String]$Credential)
{
    ...
}

Compliant

function Credential([PSCredential]$Credential)
{
    ...
}

Configure rule

This rule is always enabled and isn't configurable. Use one of the following methods to avoid using this rule:

  • Create a custom rule configuration file to include only the rules you want or exclude the rules you don't want.
  • Add the appropriate rule suppression attributes to your code to suppress the rule for specific code blocks. For more information, see the Suppressing rules section of Using PSScriptAnalyzer.