Módulos com edições do PowerShell compatíveis

Artigo
10/04/2023

A partir da versão 5.1, o PowerShell está disponível em diferentes edições, o que indica diferentes conjuntos de funcionalidades e compatibilidade de plataforma.

Edição de Ambiente de Trabalho: Com base no .NET Framework, aplica-se ao Windows PowerShell v4.0 e abaixo, bem como ao Windows PowerShell 5.1 no Windows Desktop, Windows Server, Windows Server Core e na maioria das outras edições do Windows.
Core Edition: Criado com base no .NET Core, aplica-se ao PowerShell 6.0 e superior, bem como Windows PowerShell 5.1 em edições do Windows com requisitos de espaço reduzido, como o Windows IoT e o Windows Nano Server.

Para obter mais informações sobre as edições do PowerShell, veja about_PowerShell_Editions.

Declarar edições compatíveis

Os autores do módulo podem declarar que os módulos são compatíveis com uma ou mais edições do PowerShell com a chave de manifesto do CompatiblePSEditions módulo. Esta chave apenas é suportada no PowerShell 5.1 ou posterior.

Nota

Quando um manifesto de módulo é especificado com a CompatiblePSEditions chave ou utiliza a $PSEdition variável, não pode ser importado no PowerShell v4 ou inferior.

New-ModuleManifest -Path .\TestModuleWithEdition.psd1 -CompatiblePSEditions Desktop,Core -PowerShellVersion 5.1
$ModuleInfo = Test-ModuleManifest -Path .\TestModuleWithEdition.psd1
$ModuleInfo.CompatiblePSEditions

Desktop
Core

$ModuleInfo | Get-Member CompatiblePSEditions

   TypeName: System.Management.Automation.PSModuleInfo

Name                 MemberType Definition
----                 ---------- ----------
CompatiblePSEditions Property   System.Collections.Generic.IEnumerable[string] CompatiblePSEditions {get;}

Ao obter uma lista de módulos disponíveis, pode filtrar a lista por edição do PowerShell.

Get-Module -ListAvailable -PSEdition Desktop

    Directory: C:\Program Files\WindowsPowerShell\Modules

ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Manifest   1.0        ModuleWithPSEditions

Get-Module -ListAvailable -PSEdition Core | % CompatiblePSEditions

Desktop
Core

A partir do PowerShell 6, o CompatiblePSEditions valor é utilizado para decidir se um módulo é compatível quando os módulos são importados do $env:windir\System32\WindowsPowerShell\v1.0\Modules. Este comportamento aplica-se apenas ao Windows. Fora deste cenário, o valor só é utilizado como metadados.

Localizar módulos compatíveis

Galeria do PowerShell utilizadores podem encontrar a lista de módulos suportados numa Edição do PowerShell específica com etiquetas PSEdition_Desktop e PSEdition_Core.

Os módulos sem PSEdition_Desktop e etiquetas de PSEdition_Core são considerados como funcionando corretamente nas edições do PowerShell Desktop.

# Find modules supported on PowerShell Desktop edition
Find-Module -Tag PSEdition_Desktop

# Find modules supported on PowerShell Core editions
Find-Module -Tag PSEdition_Core

Filtrar várias edições

Os autores de módulos podem publicar um único módulo direcionado para as edições do PowerShell (Desktop e Core).

Um único módulo pode funcionar nas edições Desktop e Core. Nesse módulo, o autor tem de adicionar a lógica necessária no RootModule ou no manifesto do módulo com a $PSEdition variável . Os módulos podem ter dois conjuntos de DLLs compilados direcionados para CoreCLR e FullCLR. Eis as opções de empacotamento com lógica para carregar DLLs adequados.

Opção 1: empacotar um módulo para filtrar várias versões e várias edições do PowerShell

Conteúdo da pasta do módulo

Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll
Microsoft.Windows.PowerShell.ScriptAnalyzer.dll
PSScriptAnalyzer.psd1
PSScriptAnalyzer.psm1
ScriptAnalyzer.format.ps1xml
ScriptAnalyzer.types.ps1xml
coreclr\Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll
coreclr\Microsoft.Windows.PowerShell.ScriptAnalyzer.dll
en-US\about_PSScriptAnalyzer.help.txt
en-US\Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml
PSv3\Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.dll
PSv3\Microsoft.Windows.PowerShell.ScriptAnalyzer.dll
Settings\CmdletDesign.psd1
Settings\DSC.psd1
Settings\ScriptFunctions.psd1
Settings\ScriptingStyle.psd1
Settings\ScriptSecurity.psd1

Conteúdo do PSScriptAnalyzer.psd1 ficheiro

@{

# Author of this module
Author = 'Microsoft Corporation'

# Script module or binary module file associated with this manifest.
RootModule = 'PSScriptAnalyzer.psm1'

# Version number of this module.
ModuleVersion = '1.6.1'

# ---
}

A lógica abaixo carrega as assemblagens necessárias consoante a edição ou versão atual.

Conteúdo do PSScriptAnalyzer.psm1 ficheiro:

#
# Script module for module 'PSScriptAnalyzer'
#
Set-StrictMode -Version Latest

# Set up some helper variables to make it easier to work with the module
$PSModule = $ExecutionContext.SessionState.Module
$PSModuleRoot = $PSModule.ModuleBase

# Import the appropriate nested binary module based on the current PowerShell version
$binaryModuleRoot = $PSModuleRoot


if (($PSVersionTable.Keys -contains "PSEdition") -and ($PSVersionTable.PSEdition -ne 'Desktop')) {
    $binaryModuleRoot = Join-Path -Path $PSModuleRoot -ChildPath 'coreclr'
}
else
{
    if ($PSVersionTable.PSVersion -lt [Version]'5.0')
    {
        $binaryModuleRoot = Join-Path -Path $PSModuleRoot -ChildPath 'PSv3'
    }
}

$binaryModulePath = Join-Path -Path $binaryModuleRoot -ChildPath 'Microsoft.Windows.PowerShell.ScriptAnalyzer.dll'
$binaryModule = Import-Module -Name $binaryModulePath -PassThru

# When the module is unloaded, remove the nested binary module that was loaded with it
$PSModule.OnRemove = {
    Remove-Module -ModuleInfo $binaryModule
}

Opção 2: utilize $PSEdition variável no ficheiro PSD1 para carregar os DLLs adequados

No PS 5.1 ou mais recente, $PSEdition a variável global é permitida no ficheiro de manifesto do módulo. Com esta variável, o autor do módulo pode especificar os valores condicionais no ficheiro de manifesto do módulo. $PSEdition A variável pode ser referenciada no modo de idioma restrito ou numa secção Dados.

Ficheiro de manifesto do módulo de exemplo com CompatiblePSEditions chave.

@{
    # Script module or binary module file associated with this manifest.
    RootModule = if($PSEdition -eq 'Core')
    {
        'coreclr\MyCoreClrRM.dll'
    }
    else # Desktop
    {
        'clr\MyFullClrRM.dll'
    }

    # Supported PSEditions
    CompatiblePSEditions = 'Desktop', 'Core'

    # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
    NestedModules = if($PSEdition -eq 'Core')
    {
        'coreclr\MyCoreClrNM1.dll',
        'coreclr\MyCoreClrNM2.dll'
    }
    else # Desktop
    {
        'clr\MyFullClrNM1.dll',
        'clr\MyFullClrNM2.dll'
    }
}

Conteúdos do módulo

ModuleWithEditions\ModuleWithEditions.psd1
ModuleWithEditions\clr\MyFullClrNM1.dll
ModuleWithEditions\clr\MyFullClrNM2.dll
ModuleWithEditions\clr\MyFullClrRM.dll
ModuleWithEditions\coreclr\MyCoreClrNM1.dll
ModuleWithEditions\coreclr\MyCoreClrNM2.dll
ModuleWithEditions\coreclr\MyCoreClrRM.dll

Mais detalhes

Scripts com Edições do PowerShell

Suporte do PSEditions no PowerShellGallery

Atualizar o manifesto do módulo

about_PowerShell_Editions

Partilhar via