UseCompatibleCmdlets

Severity Level: Warning

Description

This rule flags cmdlets that aren't available in a given Edition and Version of PowerShell on a given Operating System. It works by comparing a cmdlet against a set of allowlists which ship with PSScriptAnalyzer. They can be found at /path/to/PSScriptAnalyzerModule/Settings. These files are of the form, <psedition>-<psversion>-<os>.json where <psedition> can be either Core or Desktop, <os> can be either Windows, Linux or MacOS, and <psversion> is the PowerShell version. To enable the rule to check if your script is compatible on PowerShell Core on windows, put the following your settings file:

@{
    'Rules' = @{
        'PSUseCompatibleCmdlets' = @{
            'compatibility' = @('core-6.1.0-windows')
        }
    }
}

The parameter compatibility is a list that contain any of the following

• desktop-2.0-windows
• desktop-3.0-windows
• desktop-4.0-windows (taken from Windows Server 2012R2)
• desktop-5.1.14393.206-windows
• core-6.1.0-windows (taken from Windows 10 - 1803)
• core-6.1.0-linux (taken from Ubuntu 18.04)
• core-6.1.0-linux-arm (taken from Raspbian)
• core-6.1.0-macos

Usually, patched versions of PowerShell have the same cmdlet data, therefore only settings of major and minor versions of PowerShell are supplied. You can also create a custom settings file with the New-CommandDataFile.ps1 script. Place the created .json file in the Settings folder of the PSScriptAnalyzer module folder. Then the compatibility parameter values is just the filename. Note that the core-6.0.2-* files were removed in PSScriptAnalyzer 1.18 since PowerShell 6.0 reached it's end of life.