powershell/PSDSCUseIdenticalParametersForDSC

powershell/PSDSCUseIdenticalParametersForDSC is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.

Property	Value
Severity	Error
Category	PSScriptAnalyzer
Default	Disabled in tally
Auto-fix	No

tally disables this rule by default because Desired State Configuration resources are out of scope for Dockerfile RUN analysis. Re-enable it with include = ["powershell/PSDSCUseIdenticalParametersForDSC"] or by setting rules.powershell.PSDSCUseIdenticalParametersForDSC.severity = "warning" in .tally.toml.

Description

The Get-TargetResource, Test-TargetResource and Set-TargetResource functions of DSC Resource must have the same parameters.

How

Correct the parameters for the functions in DSC resource.

Examples

Problematic code

function Get-TargetResource
{
    [OutputType([Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name,

        [String]
        $TargetResource
    )
    ...
}

function Set-TargetResource
{
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name
    )
    ...
}

function Test-TargetResource
{
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name
    )
    ...
}

Correct code

function Get-TargetResource
{
    [OutputType([Hashtable])]
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name,

        [String]
        $TargetResource
    )
    ...
}

function Set-TargetResource
{
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name,

        [String]
        $TargetResource
    )
    ...
}

function Test-TargetResource
{
    [OutputType([System.Boolean])]
    param
    (
        [parameter(Mandatory = $true)]
        [String]
        $Name,

        [String]
        $TargetResource
    )
    ...
}

Source

This rule documentation is adapted from Microsoft’s PSScriptAnalyzer documentation for DSCUseIdenticalParametersForDSC, licensed under CC BY 4.0.

powershell/PSDSCUseIdenticalMandatoryParametersForDSC

powershell/PSDSCUseVerboseMessageInDSCResource

⌘I

​Description

​How

​Examples

​Problematic code

​Correct code

​Source

Description

How

Examples

Problematic code

Correct code

Source