Jak napsat manifest modulu PowerShellu

Článek
03/25/2025

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.

Popisy klíčů a hodnot, které můžete zahrnout do manifestu modulu, najdete v elementech manifestu modulu tabulce. Další informace najdete v popisu parametrů v rutině New-ModuleManifest.
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

Elementy manifestu modulu

Následující tabulka popisuje prvky, které můžete zahrnout do manifestu modulu.

prvek	Výchozí	Popis
RootModule Typ: `String`	`<empty string>`	Modul skriptu nebo binární soubor modulu přidružený k tomuto manifestu. Předchozí verze PowerShellu volala tento prvek ModuleToProcess. Možné typy kořenového modulu mohou být prázdné, což vytvoří modul manifestu, název modulu skriptu (`.psm1`) nebo název binárního modulu (`.exe` nebo `.dll`). Umístění názvu manifestu modulu (`.psd1`) nebo souboru skriptu (`.ps1`) v tomto prvku způsobí chybu. Příklad: `RootModule = 'ScriptModule.psm1'`
ModuleVersion Typ: `Version`	`'0.0.1'`	Číslo verze tohoto modulu Pokud není zadaná hodnota, `New-ModuleManifest` použije výchozí hodnotu. Řetězec musí být schopen převést na typ `Version` například `#.#.#.#`. `Import-Module` načte první modul, který najde na $PSModulePath, který odpovídá názvu, a má alespoň tak vysokou ModuleVersion, jako MinimumVersion parametr. Pokud chcete importovat konkrétní verzi, použijte parametr RequiredVersion rutiny `Import-Module`. Příklad: `ModuleVersion = '1.0'`
GUID Typ: `GUID`	`'<GUID>'`	ID použité k jedinečné identifikaci tohoto modulu. Pokud není zadaná hodnota, `New-ModuleManifest` hodnotu automaticky vygeneruje. Modul nelze v současné době importovat identifikátorem GUID. Příklad: `GUID = 'cfc45206-1e49-459d-a8ad-5b571ef94857'`
autora Typ: `String`	`'<Current user>'`	Autor tohoto modulu. Pokud není zadaná hodnota, `New-ModuleManifest` použije aktuálního uživatele. Příklad: `Author = 'AuthorNameHere'`
CompanyName Typ: `String`	`'Unknown'`	Společnost nebo dodavatel tohoto modulu. Pokud není zadaná hodnota, `New-ModuleManifest` použije výchozí hodnotu. Příklad: `CompanyName = 'Fabrikam'`
copyright Typ: `String`	`'(c) <Author>. All rights reserved.'`	Prohlášení o autorskýchprávch Pokud není zadaná hodnota, `New-ModuleManifest` jako `<Author>`použije výchozí hodnotu s aktuálním uživatelem . Pokud chcete zadat autora, použijte parametr Author. Příklad: `Copyright = '2019 AuthorName. All rights reserved.'`
popis Typ: `String`	`<empty string>`	Popis funkcí poskytovaných tímto modulem Příklad: `Description = 'This is the module's description.'`
PowerShellVersion Typ: `Version`	`<empty string>`	Minimální verze modulu PowerShellu vyžadované tímto modulem. Platné hodnoty jsou 1,0, 2.0, 3.0, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0 a 7.1. Příklad: `PowerShellVersion = '5.0'`
PowerShellHostName Typ: `String`	`<empty string>`	Název hostitele PowerShellu vyžadovaného tímto modulem Tento název poskytuje PowerShell. Chcete-li najít název hostitelského programu, zadejte v programu: `$Host.Name`. Příklad: `PowerShellHostName = 'ConsoleHost'`
PowerShellHostVersion Typ: `Version`	`<empty string>`	Minimální verze hostitele PowerShellu vyžadovaného tímto modulem Příklad: `PowerShellHostVersion = '2.0'`
DotNetFrameworkVersion Typ: `Version`	`<empty string>`	Minimální verze rozhraní Microsoft .NET Framework vyžadovaná tímto modulem Tento předpoklad platí jenom pro edici PowerShell Desktopu, například Windows PowerShell 5.1, a platí pouze pro verze rozhraní .NET Framework nižší než 4.5. Příklad: `DotNetFrameworkVersion = '3.5'`
CLRVersion Typ: `Version`	`<empty string>`	Minimální verze modulu CLR (Common Language Runtime) vyžadovaná tímto modulem. Tento předpoklad platí jenom pro edici PowerShell Desktopu, například Windows PowerShell 5.1, a platí pouze pro verze rozhraní .NET Framework nižší než 4.5. Příklad: `CLRVersion = '3.5'`
ProcessorArchitecture Typ: `ProcessorArchitecture`	`<empty string>`	Architektura procesoru (None, X86, Amd64) vyžadovaná tímto modulem. Platné hodnoty jsou x86, AMD64, Arm, IA64, MSIL a None (neznámé nebo nespecifikované). Příklad: `ProcessorArchitecture = 'x86'`
RequiredModules Typ: `Object[]`	`@()`	Moduly, které se musí importovat do globálního prostředí před importem tohoto modulu. Tím se načte všechny moduly uvedené, pokud ještě nebyly načteny. Některé moduly už můžou být například načteny jiným modulem. Je možné zadat konkrétní verzi, která se má načíst pomocí `RequiredVersion` místo `ModuleVersion`. Při `ModuleVersion` se načte nejnovější dostupná verze s minimální zadanou verzí. V hodnotě parametru můžete kombinovat řetězce a tabulky hash. Příklad: `RequiredModules = @("MyModule", @{ModuleName="MyDependentModule"; ModuleVersion="2.0"; GUID="cfc45206-1e49-459d-a8ad-5b571ef94857"})` Příklad: `RequiredModules = @("MyModule", @{ModuleName="MyDependentModule"; RequiredVersion="1.5"; GUID="cfc45206-1e49-459d-a8ad-5b571ef94857"})`
RequiredAssemblies Typ: `String[]`	`@()`	Sestavení, která musí být načtena před importem tohoto modulu. Určuje názvy souborů sestavení (`.dll`), které modul vyžaduje. PowerShell načte zadaná sestavení před aktualizací typů nebo formátů, importem vnořených modulů nebo importem souboru modulu zadaného v hodnotě klíče RootModule. Pomocí tohoto parametru zobrazíte seznam všech sestavení, která modul vyžaduje. Příklad: `RequiredAssemblies = @("assembly1.dll", "assembly2.dll", "assembly3.dll")`
scriptsToProcess Typ: `String[]`	`@()`	Soubory skriptu (`.ps1`) spuštěné ve stavu relace volajícího při importu modulu. Může se jednat o stav globální relace nebo stav relace jiného modulu pro vnořené moduly. Tyto skripty můžete použít k přípravě prostředí stejně, jako byste mohli použít skript pro přihlášení. Tyto skripty se spustí před načtením některého z modulů uvedených v manifestu. Příklad: `ScriptsToProcess = @("script1.ps1", "script2.ps1", "script3.ps1")`
TypesToProcess Typ: `String[]`	`@()`	Při importu tohoto modulu se načtou soubory typů (`.ps1xml`). Příklad: `TypesToProcess = @("type1.ps1xml", "type2.ps1xml", "type3.ps1xml")`
formáty NaProcess Typ: `String[]`	`@()`	Při importu tohoto modulu se načtou soubory formátu (`.ps1xml`). Příklad: `FormatsToProcess = @("format1.ps1xml", "format2.ps1xml", "format3.ps1xml")`
NestedModules Typ: `Object[]`	`@()`	Moduly, které se mají importovat jako vnořené moduly modulu zadaného v RootModule (alias:ModuleToProcess). Přidání názvu modulu do tohoto prvku je podobné volání `Import-Module` z vašeho skriptu nebo kódu sestavení. Hlavním rozdílem při použití souboru manifestu je, že je jednodušší zjistit, co načítáte. A pokud se modul nepodaří načíst, nenačte se váš skutečný modul. Kromě jiných modulů zde můžete také načíst soubory skriptu (`.ps1`). Tyto soubory se spustí v kontextu kořenového modulu. Toto je ekvivalentem pro dot sourcing skriptu v kořenovém modulu. Příklad: `NestedModules = @("script.ps1", @{ModuleName="MyModule"; ModuleVersion="1.0.0.0"; GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"})`
FunctionsToExport Typ: `String[]`	`@()`	Určuje funkce, které se mají exportovat z tohoto modulu, pro zajištění nejlepšího výkonu, nepoužívejte zástupné cardy a neodstraňují položku, použijte prázdné pole, pokud nejsou k dispozici žádné funkce k exportu. Ve výchozím nastavení nejsou exportovány žádné funkce. Tento klíč můžete použít k výpisu funkcí, které modul exportuje. Modul exportuje funkce do stavu relace volajícího. Stav relace volajícího může být stav globální relace nebo pro vnořené moduly stav relace jiného modulu. Při zřetězení vnořených modulů budou všechny funkce exportované vnořeným modulem exportovány do globálního stavu relace, pokud modul v řetězci neomezí funkci pomocí klíče FunctionsToExport. Pokud manifest exportuje aliasy pro funkce, může tento klíč odebrat funkce, jejichž aliasy jsou uvedeny v AliasesToExport klíč, ale tento klíč nemůže přidat aliasy funkcí do seznamu. Příklad: `FunctionsToExport = @("function1", "function2", "function3")`
RutinyToExport Typ: `String[]`	`@()`	Určuje rutiny, které se mají exportovat z tohoto modulu, pro zajištění co nejlepšího výkonu, nepoužívají zástupné cardy a neodstraňují položku, použijte prázdné pole, pokud nejsou k dispozici žádné rutiny k exportu. Ve výchozím nastavení se neexportují žádné rutiny. Tento klíč můžete použít k výpisu rutin, které modul exportuje. Stav relace volajícího může být stav globální relace nebo pro vnořené moduly stav relace jiného modulu. Při zřetězování vnořených modulů se všechny rutiny exportované vnořeným modulem exportují do globálního stavu relace, pokud modul v řetězu neomezí rutinu pomocí klíče CmdletsToExport. Pokud manifest exportuje aliasy pro rutiny, může tento klíč odebrat rutiny, jejichž aliasy jsou uvedeny v AliasesToExport klíč, ale tento klíč nemůže přidat aliasy rutin do seznamu. Příklad: `CmdletsToExport = @("Get-MyCmdlet", "Set-MyCmdlet", "Test-MyCmdlet")`
VariablesToExport Typ: `String[]`	`'*'`	Určuje proměnné, které modul exportuje do stavu relace volajícího. Jsou povoleny zástupné znaky. Ve výchozím nastavení se exportují všechny proměnné (`''`). Tento klíč můžete použít k omezení proměnných exportovaných modulem. Stav relace volajícího může být stav globální relace nebo pro vnořené moduly stav relace jiného modulu. Při zřetězování vnořených modulů se všechny proměnné exportované vnořeným modulem exportují do globálního stavu relace, pokud modul v řetězci neomezí proměnnou pomocí VariablesToExport* klíč. Pokud manifest také exportuje aliasy pro proměnné, může tento klíč odebrat proměnné, jejichž aliasy jsou uvedeny v AliasesToExport klíč, ale tento klíč nemůže přidat aliasy proměnných do seznamu. Příklad: `VariablesToExport = @('$MyVariable1', '$MyVariable2', '$MyVariable3')`
AliasesToExport Typ: `String[]`	`@()`	Určuje aliasy, které se mají exportovat z tohoto modulu, pro zajištění nejlepšího výkonu nepoužívejte zástupné cardy a neodstraňují položku, použijte prázdné pole, pokud nejsou k exportu žádné aliasy. Ve výchozím nastavení se neexportují žádné aliasy. Tento klíč můžete použít k výpisu aliasů exportovaných modulem. Modul exportuje aliasy do stavu relace volajícího. Stav relace volajícího může být stav globální relace nebo pro vnořené moduly stav relace jiného modulu. Při zřetězení vnořených modulů se všechny aliasy exportované vnořeným modulem nakonec exportují do globálního stavu relace, pokud modul v řetězu neomezí alias pomocí klíče AliasesToExport. Příklad: `AliasesToExport = @("MyAlias1", "MyAlias2", "MyAlias3")`
DscResourcesToExport Typ: `String[]`	`@()`	Určuje prostředky DSC, které se mají exportovat z tohoto modulu. Jsou povoleny zástupné symboly. Příklad: `DscResourcesToExport = @("DscResource1", "DscResource2", "DscResource3")`
ModuleList Typ: `Object[]`	`@()`	Určuje všechny moduly zabalené s tímto modulem. Tyto moduly lze zadat podle názvu, pomocí řetězce odděleného čárkami nebo jako hashovací tabulku s ModuleName a klíče GUID. Tabulka hash může mít také volitelný klíč ModuleVersion. Klíč ModuleList je navržený tak, aby fungoval jako inventář modulu. Tyto moduly se nezpracují automaticky. Příklad: `ModuleList = @("SampleModule", "MyModule", @{ModuleName="MyModule"; ModuleVersion="1.0.0.0"; GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"})`
FileList Typ: `String[]`	`@()`	Seznam všech souborů zabalených tímto modulem Stejně jako u ModuleList je FileList seznam inventáře a jinak se nezpracuje. Příklad: `FileList = @("File1", "File2", "File3")`
PrivateData Typ: `Object`	`@{...}`	Určuje všechna privátní data, která je potřeba předat kořenovému modulu určenému RootModule (alias: ModuleToProcess). PrivateData je tabulka hash, která obsahuje několik prvků: značky, LicenseUri , ProjectURI, IconUri, ReleaseNotes, předběžné verze, RequireLicenseAcceptancea ExternalModuleDependencies.
Značky Typ: `String[]`	`@()`	Značky pomáhají se zjišťováním modulů v online galeriích. Příklad: `Tags = "PackageManagement", "PowerShell", "Manifest"`
LicenseUri Typ: `Uri`	`<empty string>`	Adresa URL licence pro tento modul. Příklad: `LicenseUri = 'https://www.contoso.com/license'`
identifikátoru ProjectUri Typ: `Uri`	`<empty string>`	Adresa URL hlavního webu pro tento projekt. Příklad: `ProjectUri = 'https://www.contoso.com/project'`
IconUri Typ: `Uri`	`<empty string>`	Adresa URL ikony představující tento modul Příklad: `IconUri = 'https://www.contoso.com/icons/icon.png'`
ReleaseNotes Typ: `String`	`<empty string>`	Určuje poznámky k verzi modulu. Příklad: `ReleaseNotes = 'The release notes provide information about the module.`
předběžné verze Typ: `String`	`<empty string>`	Tento parametr byl přidán do modulu PowerShellGet 1.6.6. PreRelease řetězec, který identifikuje modul jako předběžnou verzi v online galeriích. Příklad: `PreRelease = 'alpha'`
RequireLicenseAcceptance Typ: `Boolean`	`$false`	Tento parametr byl přidán do modulu PowerShellGet 1.5. Příznak označující, jestli modul vyžaduje explicitní přijetí uživatele pro instalaci, aktualizaci nebo uložení. Příklad: `RequireLicenseAcceptance = $false`
ExternalModuleDependencies Typ: `String[]`	`@()`	Tento parametr byl přidán do modulu PowerShellGet v2. Seznam externích modulů, na které tento modul závisí. Příklad: `ExternalModuleDependencies = @("ExtModule1", "ExtModule2", "ExtModule3")`
HelpInfoURI Typ: `String`	`<empty string>`	Identifikátor URI helpInfo tohoto modulu. Příklad: `HelpInfoURI = 'https://www.contoso.com/help'`
DefaultCommandPrefix Typ: `String`	`<empty string>`	Výchozí předpona pro příkazy exportované z tohoto modulu Přepsat výchozí předponu pomocí `Import-Module -Prefix`. Příklad: `DefaultCommandPrefix = 'My'`

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.

#
# 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 = ''

}

Sdílet prostřednictvím

Jak napsat manifest modulu PowerShellu

Vytvoření manifestu modulu

Vytvoření a použití manifestu modulu

Elementy manifestu modulu

Manifest ukázkového modulu

Viz také

Další materiály