New-ModuleManifest
Vytvoří nový manifest modulu.
Syntax
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 .psd1 soubor, 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 PassThru vytvoří 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 New-ModuleManifest se kromě požadovaných hodnot parametrů zobrazí výzva k zadání hodnot běžně používaných parametrů, které nejsou zadané v příkazu. Počínaje PowerShellem 3.0 se zobrazí výzva pouze v případě, New-ModuleManifest že nejsou zadány požadované hodnoty parametrů.
Pokud plánujete publikovat modul v Galerie prostředí PowerShell, musí manifest obsahovat hodnoty pro určité vlastnosti. Další informace naleznete v tématu Požadovaná metadata pro položky publikované v Galerie prostředí PowerShell v dokumentaci galerie.
Příklady
Příklad 1 – Vytvoření nového manifestu modulu
Tento příklad vytvoří nový manifest modulu v souboru, který je určen parametrem Path . Parametr PassThru odešle výstup do kanálu 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. K přidání hodnot do odpovídajících klíčů manifestu používá parametry PowerShellVersion a AliasesToExport .
$moduleSettings = @{
PowerShellVersion = 1.0
Path = 'C:\ps-test\ManifestTest.psd1'
AliasesToExport = @(
'JKBC'
'DRC'
'TAC'
)
}
New-ModuleManifest @moduleSettingsPří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átu hash tabulky k zadání názvu, identifikátoru GUID a verze 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 @moduleSettingsTento příklad ukazuje, jak používat formáty řetězců a hash tabulky ModuleList, RequiredModules a NestedModules parametru. Ř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á updatable help system, kde najít HelpInfo XML aktualizovatelný informační soubor nápovědy pro modul.
$moduleSettings = @{
HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettingsInformace o aktualizovatelné nápovědě najdete v tématu about_Updatable_Help. 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.
Rutina Get-Module slouží k získání modulu Microsoft.PowerShell.Diagnostics pomocí parametru List . Příkaz odešle modul do Format-List rutiny, aby zobrazil 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é cardy.
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ří se klíč AliasesToExport s hodnotou * (all), což znamená, že manifest exportuje všechny aliasy definované v modulu.
| Type: | String[] |
| Position: | Named |
| Default value: | * (all) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Author
Určuje autora modulu.
Pokud tento parametr vynecháte, New-ModuleManifest vytvoří se klíč Autora s názvem aktuálního uživatele.
| Type: | String |
| Position: | Named |
| Default value: | Name of the current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CmdletsToExport
Určuje rutiny, které modul exportuje. Jsou povoleny zástupné cardy.
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íč CmdletsToExport s hodnotou * (all), což znamená, že manifest exportuje všechny rutiny definované v modulu.
| Type: | String[] |
| Position: | Named |
| Default value: | * (all) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-CompanyName
Identifikuje společnost nebo dodavatele, kteří modul vytvořili.
Pokud tento parametr vynecháte, New-ModuleManifest vytvoří se klíč CompanyName s hodnotou "Unknown".
| Type: | String |
| Position: | Named |
| Default value: | "Unknown" |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CompatiblePSEditions
Určuje kompatibilní psEditions modulu. Informace o PSEdition naleznete v tématu Moduly s kompatibilními edicemi PowerShellu.
| Type: | String[] |
| Accepted values: | Desktop, Core |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Copyright
Určuje prohlášení o autorských právech pro modul.
Pokud tento parametr vynecháte, New-ModuleManifest vytvoří se klíč autorských práv s hodnotou, kde (c) <year> <username>. All rights reserved.<year> je aktuální rok a <username> je hodnotou klíče Autora.
| Type: | String |
| Position: | Named |
| Default value: | (c) <year> <username>. All rights reserved. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultCommandPrefix
Určuje předponu před podstatnými jménem všech příkazů v modulu při jejich importu do relace. Zadejte řetězec předpony. Předpony brání konfliktům názvů příkazů v relaci 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Popisuje obsah modulu.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DotNetFrameworkVersion
Určuje minimální verzi 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.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DscResourcesToExport
Určuje prostředky DSC (Desired State Configuration), které modul exportuje. Jsou povoleny zástupné cardy.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ExternalModuleDependencies
Seznam externích modulů, na které tento modul závisí.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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í.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FormatsToProcess
Určuje formátovací soubory (.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 nejsou vymezené, mají vliv na všechny stavy relací v relaci.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FunctionsToExport
Určuje funkce, které modul exportuje. Jsou povoleny zástupné cardy.
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.
| Type: | String[] |
| Position: | Named |
| Default value: | * (all) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Guid
Určuje jedinečný identifikátor modulu. Identifikátor GUID lze použít k rozlišení mezi moduly se stejným názvem.
Pokud tento parametr vynecháte, New-ModuleManifest vytvoří klíč GUID v manifestu a vygeneruje identifikátor GUID pro hodnotu.
Pokud chcete v PowerShellu vytvořit nový identifikátor GUID , zadejte [guid]::NewGuid().
| Type: | Guid |
| Position: | Named |
| Default value: | A GUID generated for the module |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpInfoUri
Určuje internetovou adresu souboru HelpInfo XML modulu. Zadejte identifikátor URI (Uniform Resource Identifier), který začíná řetězcem 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ě najdete v tématu about_Updatable_Help. Informace o souboru HelpInfo XML naleznete v tématu Podpora aktualizovatelné nápovědy.
Tento parametr byl představen v PowerShellu 3.0.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUri
Určuje adresu URL ikony modulu. Zadaná ikona se zobrazí na webové stránce galerie modulu.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseUri
Určuje adresu URL licenčních podmínek pro modul.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleList
Zobrazí seznam všech modulů, které jsou součástí tohoto modulu.
Každý název modulu zadejte jako řetězec nebo jako tabulku hash s klíči ModuleName a ModuleVersion . 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.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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ří se klíč ModuleVersion s hodnotou 1.0.
| Type: | Version |
| Position: | Named |
| Default value: | 1.0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NestedModules
Určuje moduly skriptu (.psm1) a binární moduly (.dll), které se importují do stavu relace modulu. Soubory v klíči NestedModules se spouštějí v pořadí, ve kterém jsou uvedené v hodnotě.
Každý název modulu zadejte jako řetězec nebo jako tabulku hash s klíči ModuleName a ModuleVersion . Tabulka hash může mít také volitelný klíč GUID . V hodnotě parametru můžete kombinovat řetězce a tabulky hash.
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í Export-ModuleMember příkazu.
Vnořené moduly ve stavu relace modulu jsou k dispozici kořenovému modulu, ale nevrací Get-Module je příkaz ve stavu relace volajícího.
Skripty (.ps1) uvedené 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, vypište název souboru skriptu v hodnotě klíče ScriptsToProcess v manifestu.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
Určuje cestu a název souboru nového manifestu modulu. Zadejte cestu a název souboru s příponou .psd1 názvu souboru, například $pshome\Modules\MyModule\MyModule.psd1. Parametr Path je povinný.
Pokud zadáte cestu k existujícímu souboru, nahradí soubor bez upozornění, New-ModuleManifest 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 .psd1 názvu souboru.
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 .
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellHostName
Určuje název hostitelského programu PowerShellu, který modul vyžaduje. Zadejte název hostitelského programu, jako je například hostitel ISE windows PowerShellu nebo ConsoleHost. Zástupné cardy nejsou povolené.
Chcete-li najít název hostitelského programu, zadejte $Host.Namev programu .
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PowerShellHostVersion
Určuje minimální verzi hostitelského programu PowerShellu, která funguje s modulem. Zadejte číslo verze, například 1.1.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Version |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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 prostředí PowerShell se tato data používají k identifikaci předem připravených balíčků. Chcete-li získat předběžné verze balíčků z galerie, musíte použít parametr AllowPrerelease s příkazy Find-ModulePowerShellGet , , Install-ModuleUpdate-Modulea Save-Module.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateData
Určuje data, která se předávají modulu při importu.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProcessorArchitecture
Určuje architekturu procesoru, kterou modul vyžaduje. Platné hodnoty jsou x86, AMD64, IA64, MSIL a None (neznámé nebo nespecifikované).
| Type: | ProcessorArchitecture |
| Accepted values: | None, MSIL, X86, IA64, Amd64, Arm |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectUri
Určuje adresu URL webové stránky o tomto projektu.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleaseNotes
Určuje poznámky k verzi.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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ů nebo formátů, importem vnořených modulů nebo importem souboru modulu zadaného v hodnotě klíče RootModule .
Tento parametr použijte k výpisu všech sestavení, která modul vyžaduje, včetně sestavení, která musí být načtena k aktualizaci veškerého formátování nebo typů souborů uvedených v klíči FormatsToProcess nebo TypesToProcess , i když jsou tato sestavení uvedena jako binární moduly v klíči NestedModules .
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredModules
Určuje moduly, které musí být v globálním stavu relace. Pokud požadované moduly nejsou ve stavu globální relace, PowerShell je naimportuje. Pokud požadované moduly nejsou dostupné, Import-Module příkaz selže.
Každý název modulu zadejte jako řetězec nebo jako tabulku hash s klíči ModuleName a ModuleVersion . Tabulka hash může mít také volitelný klíč GUID . V hodnotě parametru můžete kombinovat řetězce a tabulky hash.
V PowerShellu 2.0 Import-Module se požadované moduly neimportuje automaticky. Jenom ověří, že požadované moduly jsou ve stavu globální relace.
| Type: | Object[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequireLicenseAcceptance
Příznak označující, jestli modul vyžaduje explicitní přijetí uživatele pro instalaci, aktualizaci nebo uložení.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RootModule
Určuje primární nebo kořenový soubor modulu. Zadejte název souboru skriptu (.ps1), modul skriptu (.psm1), manifest modulu modulu (.psd1), sestavení (.dll), soubor XML definice rutiny (.cdxml) nebo pracovní postup (.xaml). Při importu modulu se členové exportované ze souboru kořenového modulu importují do stavu relace volajícího.
Pokud má modul soubor manifestu a v klíči RootModule 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 z .psm1 modulu .dll , který má manifest, musí být názvy těchto souborů zadány v hodnotách klíčů RootModule nebo NestedModules 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 jeho alias ModuleToProcess.
| Type: | String |
| Aliases: | ModuleToProcess |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
K určení skriptů, které se spouští ve stavu relace modulu, použijte klíč NestedModules .
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
Určuje pole značek.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TypesToProcess
Určuje typ souborů (.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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VariablesToExport
Určuje proměnné, které modul exportuje. Jsou povoleny zástupné cardy.
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 * (all), což znamená, že manifest exportuje všechny proměnné definované v modulu.
| Type: | String[] |
| Position: | Named |
| Default value: | * (all) |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-WhatIf
Ukazuje, co se stane, když New-ModuleManifest se spustí. Rutina se nespustí.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Vstupy
None
Do této rutiny nemůžete roušit objekty.
Výstupy
None
Ve výchozím nastavení tato rutina nevrací žádný výstup.
Pokud použijete parametr PassThru , vrátí tato rutina řetězec představující manifest modulu.
Poznámky
New-ModuleManifest na platformách Windows a jiných platformách než Windows vytváří soubory manifestu modulu (.psd1) kódované jako UTF8NoBOM.
Manifesty modulů jsou obvykle volitelné. Manifest modulu je však nutný k exportu sestavení nainstalovaného v globální mezipaměti sestavení.
Pokud chcete přidat nebo změnit soubory v $pshome\Modules adresáři, 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é ve vlastnosti FileList manifestu modulu. Nativní knihovny DLL se v souboru FileList nepodaří načíst v procesu a chyba se ignoruje. Všechny spravované knihovny DLL se načtou v procesu. Toto chování bylo odebráno v PowerShellu 7.1.
V PowerShellu New-ModuleManifest 2.0 bylo mnoho parametrů povinné, i když se v manifestu modulu nepožadovaly. Počínaje PowerShellem 3.0 je povinný pouze parametr Cesta .
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.
Související odkazy
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro