New-ModuleManifest

Modul:: Microsoft.PowerShell.Core Module

Vytvoří nový manifest modulu.

Syntaxe

All

New-ModuleManifest
    [-Path] <String>
    [-NestedModules <Object[]>]
    [-Guid <Guid>]
    [-Author <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-RootModule <String>]
    [-ModuleVersion <Version>]
    [-Description <String>]
    [-ProcessorArchitecture <ProcessorArchitecture>]
    [-PowerShellVersion <Version>]
    [-CLRVersion <Version>]
    [-DotNetFrameworkVersion <Version>]
    [-PowerShellHostName <String>]
    [-PowerShellHostVersion <Version>]
    [-RequiredModules <Object[]>]
    [-TypesToProcess <String[]>]
    [-FormatsToProcess <String[]>]
    [-ScriptsToProcess <String[]>]
    [-RequiredAssemblies <String[]>]
    [-FileList <String[]>]
    [-ModuleList <Object[]>]
    [-FunctionsToExport <String[]>]
    [-AliasesToExport <String[]>]
    [-VariablesToExport <String[]>]
    [-CmdletsToExport <String[]>]
    [-DscResourcesToExport <String[]>]
    [-CompatiblePSEditions <String[]>]
    [-PrivateData <Object>]
    [-Tags <String[]>]
    [-ProjectUri <Uri>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ReleaseNotes <String>]
    [-Prerelease <String>]
    [-RequireLicenseAcceptance]
    [-ExternalModuleDependencies <String[]>]
    [-HelpInfoUri <String>]
    [-PassThru]
    [-DefaultCommandPrefix <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Rutina New-ModuleManifest vytvoří nový soubor manifestu modulu (.psd1), naplní jeho hodnoty a uloží soubor manifestu do zadané cesty.

Autoři modulů mohou tuto rutinu použít k vytvoření manifestu pro svůj modul. Manifest modulu je soubor .psd1, který obsahuje tabulku hash. Klíče a hodnoty v tabulce hash popisují obsah a atributy modulu, definují požadavky a určují, jak se komponenty zpracovávají. Manifesty se pro modul nevyžadují.

New-ModuleManifest vytvoří manifest, který obsahuje všechny běžně používané klíče manifestu, takže jako šablonu manifestu můžete použít výchozí výstup. Pokud chcete přidat nebo změnit hodnoty nebo přidat klíče modulu, které tato rutina nepřidá, otevřete výsledný soubor v textovém editoru.

Každý parametr s výjimkou Path a PassThruvytvoří klíč manifestu modulu a jeho hodnotu. V manifestu modulu se vyžaduje pouze klíč ModuleVersion. Pokud není zadán v popisu parametru, pokud vynecháte parametr z příkazu, New-ModuleManifest vytvoří řetězec komentáře pro přidruženou hodnotu, která nemá žádný vliv.

V PowerShellu 2.0 vás New-ModuleManifest vyzve k zadání hodnot běžně používaných parametrů, které nejsou zadané v příkazu, kromě požadovaných hodnot parametrů. Počínaje PowerShellem 3.0 New-ModuleManifest výzvy pouze v případě, že nejsou zadány požadované hodnoty parametrů.

Pokud plánujete publikovat modul v galerii Prostředí PowerShell, musí manifest obsahovat hodnoty pro určité vlastnosti. Další informace najdete v tématu Požadovaná metadata pro položky publikované do Galerie PowerShell v dokumentaci k Galerii.

Příklady

Příklad 1 – Vytvoření nového manifestu modulu

Tento příklad vytvoří nový manifest modulu v souboru určeném parametrem Path. Parametr PassThru odešle výstup do potrubí a do souboru.

Výstup zobrazuje výchozí hodnoty všech klíčů v manifestu.

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 7/12/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 = 'e1826c6e-c420-4eef-9ac8-185e3669ca6a'

# Author of this module
Author = 'ContosoAdmin'

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

# Copyright statement for this module
Copyright = '(c) ContosoAdmin. 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 = ''

}

Příklad 2 – Vytvoření nového manifestu s některými předem vyplněnými nastaveními

Tento příklad vytvoří nový manifest modulu. Používá parametry PowerShellVersion a AliasesToExport k přidání hodnot do odpovídajících klíčů manifestu.

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

Příklad 3 – Vytvoření manifestu, který vyžaduje další moduly

Tento příklad používá formát řetězce k určení názvu modulu BitsTransfer a formát hash tabulky k určení názvu, GUIDa verzi modulu PSScheduledJob.

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Tento příklad ukazuje, jak používat formáty řetězce a tabulky hash parametru ModuleList, RequiredModulesa NestedModules. Řetězce a tabulky hash můžete kombinovat ve stejné hodnotě parametru.

Příklad 4 – Vytvoření manifestu, který podporuje aktualizovatelnou nápovědu

Tento příklad používá parametr HelpInfoUri k vytvoření klíče HelpInfoUri v manifestu modulu. Hodnota parametru a klíče musí začínat http nebo https. Tato hodnota říká systému aktualizovatelné nápovědy, kde najít aktualizovatelný soubor informační nápovědy HelpInfo XML pro modul.

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Informace o aktualizovatelné nápovědě naleznete v části o aktualizovatelné nápovědě. Informace o souboru HelpInfo XML naleznete v tématu Podpora aktualizovatelné nápovědy.

Příklad 5 – Získání informací o modulu

Tento příklad ukazuje, jak získat konfigurační hodnoty modulu. Hodnoty v manifestu modulu se projeví v hodnotách vlastností objektu modulu.

Pomocí rutiny Get-Module můžete získat modul Microsoft.PowerShell.Diagnostics s použitím parametru List. Příkaz odešle modul do rutiny Format-List, která zobrazí všechny vlastnosti a hodnoty objektu modulu.

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

Parametry

-AliasesToExport

Určuje aliasy, které modul exportuje. Jsou povoleny zástupné symboly.

Tento parametr můžete použít k omezení aliasů exportovaných modulem. Může odebrat aliasy ze seznamu exportovaných aliasů, ale nemůže do seznamu přidávat aliasy.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč AliasesToExport s hodnotou * (vše), což znamená, že manifest exportuje všechny aliasy definované v modulu.

Vlastnosti parametru

Typ:	String[]
Default value:	* (all)
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Author

Určuje autora modulu.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč Author s názvem aktuálního uživatele.

Vlastnosti parametru

Typ:	String
Default value:	Name of the current user
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ClrVersion

Určuje minimální verzi modulu CLR (Common Language Runtime) rozhraní Microsoft .NET Framework, kterou modul vyžaduje.

Poznámka:

Toto nastavení platí jenom pro edici PowerShell Desktopu, například Windows PowerShell 5.1, a platí pouze pro verze rozhraní .NET Framework nižší než 4.5. Tento požadavek nemá žádný vliv na novější verze PowerShellu ani rozhraní .NET Framework.

Vlastnosti parametru

Typ:	Version
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CmdletsToExport

Určuje rutiny, které modul exportuje. Jsou povoleny zástupné symboly.

Tento parametr můžete použít k omezení rutin, které modul exportuje. Může odebrat rutiny ze seznamu exportovaných rutin, ale nemůže do seznamu přidávat rutiny.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč RutinyToExport s hodnotou * (vše), což znamená, že manifest exportuje všechny rutiny definované v modulu.

Vlastnosti parametru

Typ:	String[]
Default value:	* (all)
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CompanyName

Identifikuje společnost nebo dodavatele, kteří modul vytvořili.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč CompanyName s hodnotou Unknown.

Vlastnosti parametru

Typ:	String
Default value:	Unknown
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CompatiblePSEditions

Určuje kompatibilní PSEditions modulu. Informace o PSEdition naleznete v tématu Moduly s kompatibilními edicemi PowerShellu.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Přípustné hodnoty:	Desktop, Core
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Confirm

Před spuštěním cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	viz

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Copyright

Určuje prohlášení o autorských právech pro modul.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč Copyright s hodnotou (c) <year> <username>. All rights reserved., kde <year> je aktuální rok a <username> je hodnota klíče Autor.

Vlastnosti parametru

Typ:	String
Default value:	(c) <year> <username>. All rights reserved.
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DefaultCommandPrefix

Určuje předponu, která je přidána před podstatnými jmény všech příkazů v modulu, když jsou importovány do relace. Zadejte předponu. Předpony brání konfliktům názvů příkazů v seanci uživatele.

Uživatelé modulu mohou tuto předponu přepsat zadáním parametru Prefix rutiny Import-Module.

Tento parametr byl představen v PowerShellu 3.0.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Description

Popisuje obsah modulu.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DotNetFrameworkVersion

Určuje minimální verzi rozhraní Microsoft .NET Framework, kterou modul vyžaduje.

Poznámka:

Vlastnosti parametru

Typ:	Version
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-DscResourcesToExport

Určuje prostředky DSC (Desired State Configuration), které modul exportuje. Jsou povoleny zástupné symboly.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ExternalModuleDependencies

Seznam externích modulů, na které tento modul závisí. Tento seznam slouží pouze k dokumentaci závislostí modulu a nevynucuje ho PowerShell. Nepoužívá se příkazy PowerShellGet ani PSResourceGet ani Galerie Prostředí PowerShell.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-FileList

Určuje všechny položky, které jsou součástí modulu.

Tento klíč je navržený tak, aby fungoval jako inventář modulů. Soubory uvedené v klíči se zahrnou při publikování modulu, ale žádné funkce se automaticky neexportují.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-FormatsToProcess

Určuje soubory formátování (.ps1xml), které se spustí při importu modulu.

Při importu modulu spustí PowerShell rutinu Update-FormatData se zadanými soubory. Vzhledem k tomu, že formátovací soubory nemají omezený rozsah, mají vliv na všechny stavy relací.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-FunctionsToExport

Určuje funkce, které modul exportuje. Jsou povoleny zástupné symboly.

Tento parametr můžete použít k omezení funkcí, které modul exportuje. Může odebrat funkce ze seznamu exportovaných aliasů, ale nemůže do seznamu přidávat funkce.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří se klíč FunctionsToExport s hodnotou * (all), což znamená, že manifest exportuje všechny funkce definované v modulu.

Vlastnosti parametru

Typ:	String[]
Default value:	* (all)
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Guid

Určuje jedinečný identifikátor modulu. Identifikátor GUID lze použít k rozlišení modulů se stejným názvem.

Pokud tento parametr vynecháte, vytvoří New-ModuleManifest v manifestu klíč identifikátoru GUID a vygeneruje identifikátor GUID pro hodnotu.

Pokud chcete vytvořit nový identifikátor GUID v PowerShellu, zadejte [guid]::NewGuid().

Vlastnosti parametru

Typ:	Guid
Default value:	A GUID generated for the module
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-HelpInfoUri

Určuje internetovou adresu souboru HelpInfo XML modulu. Zadejte identifikátor URI (Uniform Resource Identifier), který začíná http nebo https.

Soubor HelpInfo XML podporuje funkci Aktualizovatelná nápověda, která byla zavedena v PowerShellu 3.0. Obsahuje informace o umístění souborů nápovědy ke stažení pro modul a čísla verzí nejnovějších souborů nápovědy pro každé podporované národní prostředí.

Informace o aktualizovatelné nápovědě naleznete v části o aktualizovatelné nápovědě. Informace o souboru HelpInfo XML naleznete v tématu Podpora aktualizovatelné nápovědy.

Tento parametr byl představen v PowerShellu 3.0.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-IconUri

Určuje adresu URL ikony modulu. Zadaná ikona se zobrazí na webové stránce galerie modulu.

Vlastnosti parametru

Typ:	Uri
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-LicenseUri

Určuje adresu URL licenčních podmínek pro modul.

Vlastnosti parametru

Typ:	Uri
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ModuleList

Zobrazí seznam všech modulů, které jsou součástí tohoto modulu.

Zadejte název každého modulu jako řetězec nebo jako tabulku hash s ModuleName a ModuleVersion klíče. Tabulka hash může mít také volitelný klíč GUID. V hodnotě parametru můžete kombinovat řetězce a tabulky hash.

Tento klíč je navržený tak, aby fungoval jako inventář modulů. Moduly uvedené v hodnotě tohoto klíče se nezpracují automaticky.

Vlastnosti parametru

Typ:	Object[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ModuleVersion

Určuje verzi modulu.

Tento parametr není povinný, ale v manifestu se vyžaduje klíč ModuleVersion. Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč ModuleVersion s hodnotou 1,0.

Vlastnosti parametru

Typ:	Version
Default value:	1.0
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-NestedModules

Určuje moduly skriptu (.psm1) a binární moduly (.dll), které se importují do stavu relace modulu. Soubory v NestedModules klíče se spustí v pořadí, v jakém jsou uvedeny v hodnotě.

Vnořené moduly obvykle obsahují příkazy, které kořenový modul potřebuje pro interní zpracování. Ve výchozím nastavení se příkazy v vnořených modulech exportují ze stavu relace modulu do stavu relace volajícího, ale kořenový modul může omezit příkazy, které exportuje. Například pomocí příkazu Export-ModuleMember.

Vnořené moduly ve stavu relace modulu jsou k dispozici kořenovému modulu, ale nevrátí se příkazem Get-Module ve stavu relace volajícího.

Skripty (.ps1), které jsou uvedeny v klíči NestedModules, se spouští ve stavu relace modulu, ne ve stavu relace volajícího. Pokud chcete spustit skript ve stavu relace volajícího, uveďte název souboru skriptu jako hodnotu v klíči ScriptsToProcess v manifestu.

Vlastnosti parametru

Typ:	Object[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PassThru

Zapíše výsledný manifest modulu do konzoly a vytvoří .psd1 soubor. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Path

Určuje cestu a název souboru nového manifestu modulu. Zadejte cestu a název souboru s příponou názvu souboru .psd1, například $PSHOME\Modules\MyModule\MyModule.psd1. Je vyžadován parametr Path.

Pokud zadáte cestu k existujícímu souboru, New-ModuleManifest nahradí soubor bez upozornění, pokud soubor nemá atribut jen pro čtení.

Manifest by se měl nacházet v adresáři modulu a název souboru manifestu by měl být stejný jako název adresáře modulu, ale s příponou názvu souboru .psd1.

Poznámka:

Proměnné, například $PSHOME nebo $HOME, nelze použít v reakci na výzvu k zadání hodnoty parametru Path. Pokud chcete použít proměnnou, zahrňte do příkazu parametr Path.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	1
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PowerShellHostName

Určuje název hostitelského programu PowerShellu, který modul vyžaduje. Zadejte název hostitelského programu, například Windows PowerShell ISE Host nebo ConsoleHost. Zástupné cardy nejsou povolené.

Chcete-li najít název hostitelského programu, zadejte v programu $Host.Name.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PowerShellHostVersion

Určuje minimální verzi hostitelského programu PowerShellu, která funguje s modulem. Zadejte číslo verze, například 1.1.

Vlastnosti parametru

Typ:	Version
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PowerShellVersion

Určuje minimální verzi PowerShellu, která funguje s tímto modulem. Jako hodnotu parametru můžete například zadat hodnotu 1.0, 2.0 nebo 3.0. Musí být ve formátu X.X. Pokud například odešlete 5, PowerShell vyvolá chybu.

Vlastnosti parametru

Typ:	Version
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Prerelease

Předběžná verze řetězce tohoto modulu Přidání řetězce předběžné verze identifikuje modul jako předběžnou verzi. Při publikování modulu do galerie PowerShell se tato data používají k identifikaci předběžných balíčků. Chcete-li získat předběžné verze balíčků z galerie, musíte použít parametr AllowPrerelease pomocí příkazů PowerShellGet Find-Module, Install-Module, Update-Modulea Save-Module.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PrivateData

Určuje data, která se předávají modulu při importu.

Vlastnosti parametru

Typ:	Object
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ProcessorArchitecture

Určuje architekturu procesoru, kterou modul vyžaduje. Platné hodnoty jsou x86, AMD64, IA64, MSIL a None (neznámé nebo nespecifikované).

Vlastnosti parametru

Typ:	ProcessorArchitecture
Default value:	None
Přípustné hodnoty:	None, MSIL, X86, IA64, Amd64, Arm
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ProjectUri

Určuje adresu URL webové stránky o tomto projektu.

Vlastnosti parametru

Typ:	Uri
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ReleaseNotes

Určuje poznámky k verzi.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RequiredAssemblies

Určuje soubory sestavení (.dll), které modul vyžaduje. Zadejte názvy souborů sestavení. PowerShell načte zadaná sestavení před aktualizací typů či formátů, importem vnořených modulů nebo načítáním souboru modulu uvedeného v hodnotě klíče RootModule.

Tento parametr použijte k výpisu všech sestavení, která modul vyžaduje, včetně těch, která musí být načtena k aktualizaci formátovacích nebo typových souborů uvedených v klíčích FormatsToProcess nebo TypesToProcess, i když jsou tato sestavení uvedena také jako binární moduly v klíči NestedModules.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RequiredModules

Určuje moduly, které musí být v globálním stavu relace. Pokud ve stavu globální relace nejsou požadované moduly, PowerShell je naimportuje. Pokud požadované moduly nejsou dostupné, příkaz Import-Module selže.

Při instalaci modulu pomocí Install-Module příkazů nebo Install-PSResource příkazů tyto příkazy zkontrolují tento seznam. Pokud nejsou nainstalované požadované moduly, příkazy se pokusí nainstalovat požadované moduly.

Vlastnosti parametru

Typ:	Object[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RequireLicenseAcceptance

Příznak označující, jestli modul vyžaduje explicitní přijetí uživatele pro instalaci, aktualizaci nebo uložení.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RootModule

Určuje primární nebo kořenový soubor modulu. Zadejte název souboru skriptu (.ps1), modul skriptu (.psm1), manifest modulu(.psd1), sestavení (.dll), soubor XML definice rutiny (.cdxml) nebo pracovní postup (.xaml). Při importu modulu se členové, kteří jsou exportováni z kořenového souboru modulu, importují do stavu relace volajícího.

Pokud modul obsahuje soubor manifestu a v klíči RootMod ule nebyl označen žádný kořenový soubor, stane se manifest primárním souborem modulu a modul se stane modulem manifestu (ModuleType = Manifest).

Chcete-li exportovat členy ze souborů .psm1 nebo .dll v modulu, který má manifest, musí být názvy těchto souborů zadány v hodnotách klíčů RootModul nebo VnořenéModuly v manifestu. Jinak se jejich členové neexportují.

Poznámka:

V PowerShellu 2.0 se tento klíč nazývá ModuleToProcess. Můžete použít název parametru RootModule nebo alias ModuleToProcess.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	ModuleToProcess

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ScriptsToProcess

Určuje soubory skriptu (.ps1), které se při importu modulu spouští ve stavu relace volajícího. Tyto skripty můžete použít k přípravě prostředí, stejně jako můžete použít přihlašovací skript.

Pokud chcete zadat skripty, které se spustí ve stavu relace modulu, použijte klíč NestedModules.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Tags

Určuje pole značek.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-TypesToProcess

Určuje soubory typu (.ps1xml), které se spustí při importu modulu.

Při importu modulu spustí PowerShell rutinu Update-TypeData se zadanými soubory. Vzhledem k tomu, že soubory typu nejsou vymezeny, mají vliv na všechny stavy relací v relaci.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-VariablesToExport

Určuje proměnné, které modul exportuje. Jsou povoleny zástupné symboly.

Tento parametr můžete použít k omezení proměnných exportovaných modulem. Může odebrat proměnné ze seznamu exportovaných proměnných, ale nemůže do seznamu přidávat proměnné.

Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč VariablesToExport s hodnotou * (vše), což znamená, že manifest exportuje všechny proměnné definované v modulu.

Vlastnosti parametru

Typ:	String[]
Default value:	* (all)
Podporuje zástupné znaky:	True
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-WhatIf

Ukazuje, co by se stalo, když se New-ModuleManifest spustí. Cmdlet se nespustil.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Wi

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do tohoto cmdletu nemůžete předávat objekty.

Výstupy

None

Ve výchozím nastavení tato rutina nevrací žádný výstup.

String

Pokud použijete parametr PassThru, vrátí tato rutina řetězec představující manifest modulu.

Poznámky

New-ModuleManifest spuštěné na platformách Windows a jiných platformách než Windows vytvoří soubory manifestu modulu (.psd1) kódované jako UTF8NoBOM.

Manifesty modulů jsou obvykle volitelné. K exportu sestavení, které je nainstalováno v globální mezipaměti sestavení, je však nutný manifest modulu.

Pokud chcete přidat nebo změnit soubory v adresáři $PSHOME\Modules, spusťte PowerShell s možností Spustit jako správce.

Poznámka:

Počínaje PowerShellem 6.2 se PowerShell pokusí načíst všechny soubory DLL uvedené v souboru FileList vlastnosti manifestu modulu. Nativní knihovny DLL v FileList se v procesu nepodaří načíst a chyba se ignoruje. V procesu se načtou všechny spravované knihovny DLL. Toto chování bylo odebráno v PowerShellu 7.1.

Relace je instance spouštěcího prostředí PowerShellu. Relace může mít jeden nebo více stavů relace. Ve výchozím nastavení má relace pouze globální stav relace, ale každý importovaný modul má svůj vlastní stav relace. Stavy relace umožňují spuštění příkazů v modulu, aniž by to mělo vliv na globální stav relace.

Stav relace volajícího je stav relace, do kterého se modul importuje. Obvykle odkazuje na globální stav relace, ale když modul importuje vnořené moduly, volající je modul a stav relace volajícího je stav relace modulu.

V PowerShellu 2.0 bylo mnoho parametrů New-ModuleManifest povinné, i když se v manifestu modulu nepožadovaly. Počínaje PowerShellem 3.0 je povinný pouze parametr Path.

V PowerShellu 2.0 Import-Module nenaimportuje požadované moduly automaticky. Ověří pouze, že požadované moduly jsou ve stavu globální relace sezení.

Váš názor

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

Sdílet prostřednictvím

New-ModuleManifest

Syntaxe

All

Description

Příklady

Příklad 1 – Vytvoření nového manifestu modulu

Příklad 2 – Vytvoření nového manifestu s některými předem vyplněnými nastaveními

Příklad 3 – Vytvoření manifestu, který vyžaduje další moduly

Příklad 4 – Vytvoření manifestu, který podporuje aktualizovatelnou nápovědu

Příklad 5 – Získání informací o modulu

Parametry

-AliasesToExport

Vlastnosti parametru

Sady parametrů

-Author

Vlastnosti parametru

Sady parametrů

-ClrVersion

Vlastnosti parametru

Sady parametrů

-CmdletsToExport

Vlastnosti parametru

Sady parametrů

-CompanyName

Vlastnosti parametru

Sady parametrů

-CompatiblePSEditions

Vlastnosti parametru

Sady parametrů

-Confirm

Vlastnosti parametru

Sady parametrů

-Copyright

Vlastnosti parametru

Sady parametrů

-DefaultCommandPrefix

Vlastnosti parametru

Sady parametrů

-Description

Vlastnosti parametru

Sady parametrů

-DotNetFrameworkVersion

Vlastnosti parametru

Sady parametrů

-DscResourcesToExport

Vlastnosti parametru

Sady parametrů

-ExternalModuleDependencies

Vlastnosti parametru

Sady parametrů

-FileList

Vlastnosti parametru

Sady parametrů

-FormatsToProcess

Vlastnosti parametru

Sady parametrů

-FunctionsToExport

Vlastnosti parametru

Sady parametrů

-Guid

Vlastnosti parametru

Sady parametrů

-HelpInfoUri

Vlastnosti parametru

Sady parametrů

-IconUri

Vlastnosti parametru

Sady parametrů

-LicenseUri

Vlastnosti parametru

Sady parametrů

-ModuleList

Vlastnosti parametru

Sady parametrů

-ModuleVersion

Vlastnosti parametru

Sady parametrů

-NestedModules

Vlastnosti parametru