PowerShell-moduljegyzék írása

Miután megírta a PowerShell-modult, hozzáadhat egy opcionális moduljegyzéket, amely tartalmazza a modulra vonatkozó információkat. Leírhatja például a szerzőt, megadhatja a modulban lévő fájlokat (például beágyazott modulokat), szkripteket futtathat a felhasználó környezetének testreszabásához, betöltheti és formázhatja a fájlokat, meghatározhatja a rendszerkövetelményeket, és korlátozhatja a modul által exportált tagokat.

Moduljegyzék létrehozása

A moduljegyzék- egy PowerShell-adatfájl (.psd1), amely leírja egy modul tartalmát, és meghatározza a modul feldolgozásának módját. A jegyzékfájl egy olyan szövegfájl, amely kulcsokat és értékeket tartalmazó kivonattáblázatot tartalmaz. A jegyzékfájlt egy modulhoz csatolhatja úgy, hogy a jegyzékfájlt a moduléval megegyező névvel elnevezi, és a jegyzékfájlt a modul gyökérkönyvtárában tárolja.

Olyan egyszerű modulok esetében, amelyek csak egyetlen .psm1 vagy bináris szerelvényt tartalmaznak, a moduljegyzék nem kötelező. A javaslat azonban az, hogy amikor csak lehetséges, használjon egy moduljegyzéket, mivel ezek segítenek a kód rendszerezésében és a verziószámozási információk fenntartásában. A Globális szerelvénygyorsítótártelepített szerelvény exportálásához pedig moduljegyzék szükséges. Az Frissíthető súgó funkciót támogató modulokhoz is szükség van moduljegyzékre. Az frissíthető súgó a moduljegyzék HelpInfoUri kulcsával megkeresi a modul frissített súgófájljainak helyét tartalmazó súgóinformációs (HelpInfo XML) fájlt. Az frissíthető súgóról további információt az Frissíthető súgó támogatásacímű témakörben talál.

Moduljegyzék létrehozása és használata

  1. A moduljegyzékek létrehozásának ajánlott eljárása a New-ModuleManifest parancsmag használata. Paraméterek használatával megadhatja a jegyzékfájl egy vagy több alapértelmezett kulcsát és értékét. Az egyetlen követelmény a fájl elnevezése. New-ModuleManifest létrehoz egy moduljegyzéket a megadott értékekkel, és tartalmazza a fennmaradó kulcsokat és azok alapértelmezett értékeit. Ha több modult kell létrehoznia, a New-ModuleManifest használatával hozzon létre egy moduljegyzéksablont, amely módosítható a különböző modulokhoz. Az alapértelmezett moduljegyzékre példaként tekintse meg a moduljegyzék-.

    New-ModuleManifest -Path C:\myModuleName.psd1 -ModuleVersion "2.0" -Author "YourNameHere"

    Másik lehetőségként manuálisan is létrehozhatja a moduljegyzék kivonattábláját a szükséges minimális információ, a ModuleVersionhasználatával. Mentse a fájlt a modul nevével megegyező néven, és használja a .psd1 fájlkiterjesztést. Ezután szerkesztheti a fájlt, és hozzáadhatja a megfelelő kulcsokat és értékeket.

  2. Adjon hozzá további elemeket a jegyzékfájlhoz.

    A jegyzékfájl szerkesztéséhez használja a kívánt szövegszerkesztőt. A jegyzékfájl azonban egy kódokat tartalmazó szkriptfájl, ezért érdemes lehet szerkeszteni egy szkriptelési vagy fejlesztési környezetben, például a Visual Studio Code-ban. A jegyzékfájl minden eleme nem kötelező, kivéve a ModuleVersion számát.

    További információt a New-ModuleManifest parancsmag paraméterleírásában talál. A moduljegyzékben szereplő kulcsok és értékek leírását a about_Module_Manifests találja.

  3. Az alapmodul jegyzékelemei által esetleg nem lefedett forgatókönyvek kezeléséhez további kódot adhat hozzá a moduljegyzékhez.

    Biztonsági problémák esetén a PowerShell csak a moduljegyzékfájlban elérhető műveletek egy kis részét futtatja. Általában használhatja a if utasítást, az aritmetikai és összehasonlító operátorokat, valamint az alapvető PowerShell-adattípusokat.

  4. Miután létrehozta a moduljegyzéket, tesztelheti, hogy a jegyzékben leírt elérési utak helyesek-e. A moduljegyzék teszteléséhez használja Test-ModuleManifest.

    Test-ModuleManifest myModuleName.psd1

  5. Győződjön meg arról, hogy a moduljegyzék a modult tartalmazó könyvtár legfelső szintjén található.

    Amikor a modult egy rendszerbe másolja és importálja, a PowerShell a modul jegyzékfájlját használja a modul importálásához.

  6. Ha szeretné, közvetlenül is tesztelheti a moduljegyzéket az Import-Module hívásával, ha magát a jegyzékfájlt pontozza.

    Import-Module .\myModuleName.psd1

Mintamodul-jegyzék

A következő mintamodul-jegyzékfájl New-ModuleManifest a PowerShell 7-ben lett létrehozva, és tartalmazza az alapértelmezett kulcsokat és értékeket. A moduljegyzék egyes elemeinek részletes leírását lásd: about_Module_Manifests.

#
# Module manifest for module 'SampleModuleManifest'
#
# Generated by: User01
#
# Generated on: 10/15/2019
#

@{

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

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

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'b632e90c-df3d-4340-9f6c-3b832646bf87'

# Author of this module
Author = 'User01'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) User01. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Lásd még

  • Last updated on