Jak napsat manifest modulu PowerShellu

Po napsání modulu PowerShellu můžete přidat volitelný manifest modulu, který obsahuje informace o modulu. Můžete například popsat autora, zadat soubory v modulu (například vnořené moduly), spustit skripty pro přizpůsobení prostředí uživatele, načtení typů a formátování souborů, definování požadavků na systém a omezení členů, které modul exportuje.

Vytvoření manifestu modulu

Manifest modulu je datový soubor PowerShellu (.psd1), který popisuje obsah modulu a určuje způsob zpracování modulu. Soubor manifestu je textový soubor, který obsahuje tabulku hash klíčů a hodnot. Soubor manifestu propojíte s modulem pojmenováním manifestu stejným způsobem jako modul a uložíte manifest do kořenového adresáře modulu.

Pro jednoduché moduly, které obsahují pouze jeden .psm1 nebo binární sestavení, je manifest modulu volitelný. Doporučujeme ale použít manifest modulu, kdykoli je to možné, protože jsou užitečné k uspořádání kódu a údržbě informací o správě verzí. A manifest modulu je nutný k exportu sestavení nainstalovaného v globální mezipaměti sestavení. Manifest modulu se také vyžaduje pro moduly, které podporují funkci Aktualizovatelná nápověda. Aktualizovatelná nápověda používá klíč HelpInfoUri v manifestu modulu k vyhledání souboru nápovědy (HelpInfo XML), který obsahuje umístění aktualizovaných souborů nápovědy pro modul. Další informace o aktualizovatelné nápovědě naleznete v tématu Podpora aktualizovatelné nápovědy.

Vytvoření a použití manifestu modulu

Osvědčeným postupem vytvoření manifestu modulu je použít rutinu New-ModuleManifest. Pomocí parametrů můžete zadat jeden nebo více výchozích klíčů a hodnot manifestu. Jediným požadavkem je pojmenování souboru. New-ModuleManifest vytvoří manifest modulu se zadanými hodnotami a zahrne zbývající klíče a jejich výchozí hodnoty. Pokud potřebujete vytvořit více modulů, použijte New-ModuleManifest k vytvoření šablony manifestu modulu, kterou můžete upravit pro různé moduly. Příklad výchozího manifestu modulu najdete v manifestu ukázkového modulu.

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

Alternativou je ruční vytvoření hashovací tabulky manifestu modulu pomocí minimálních požadovaných informací, ModuleVersion. Soubor uložíte se stejným názvem jako modul a použijete příponu .psd1 souboru. Potom můžete soubor upravit a přidat příslušné klíče a hodnoty.
Do souboru manifestu přidejte všechny další prvky, které chcete použít.

Pokud chcete soubor manifestu upravit, použijte libovolný textový editor, který dáváte přednost. Soubor manifestu je ale soubor skriptu, který obsahuje kód, takže ho můžete chtít upravit ve skriptovacím nebo vývojovém prostředí, například v editoru Visual Studio Code. Všechny prvky souboru manifestu jsou volitelné, s výjimkou ModuleVersion číslo.

Další informace najdete v popisu parametrů v rutině New-ModuleManifest. Popis klíčů a hodnot, které můžete zahrnout do manifestu modulu, najdete v about_Module_Manifests.
Pokud chcete vyřešit všechny scénáře, které nemusí být pokryté elementy manifestu základního modulu, máte možnost přidat do manifestu modulu další kód.

V případě problémů se zabezpečením PowerShell spouští jenom malou podmnožinu dostupných operací v souboru manifestu modulu. Obecně můžete použít příkaz if, aritmetické operátory a relační operátory a základní datové typy PowerShellu.
Po vytvoření manifestu modulu ho můžete otestovat a ověřit správnost cest popsaných v manifestu. K otestování manifestu modulu použijte test-ModuleManifest.

Test-ModuleManifest myModuleName.psd1
Ujistěte se, že se manifest modulu nachází na nejvyšší úrovni adresáře, který obsahuje váš modul.

Když modul zkopírujete do systému a naimportujete ho, PowerShell k importu modulu použije manifest modulu.
Volitelně můžete manifest modulu přímo otestovat voláním import-module pomocí dot-sourcing samotného manifestu.

Import-Module .\myModuleName.psd1

Manifest ukázkového modulu

Následující ukázkový manifest modulu byl vytvořen s New-ModuleManifest v PowerShellu 7 a obsahuje výchozí klíče a hodnoty. Podrobný popis jednotlivých prvků v manifestu modulu najdete v 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 = ''

}

Viz také

Váš názor

Byla tato stránka užitečná?

Last updated on 2026-05-04