Skip to content

Latest commit

 

History

History
110 lines (92 loc) · 1.56 KB

DSCUseIdenticalParametersForDSC.md

File metadata and controls

110 lines (92 loc) · 1.56 KB
description ms.date ms.topic title
Use Identical Parameters For DSC Test and Set Functions
06/28/2023
reference
DSCUseIdenticalParametersForDSC

UseIdenticalParametersForDSC

Severity Level: Error

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.

Example

Wrong

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

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
    )
    ...
}