New-ModuleManifest
Létrehoz egy új moduljegyzéket.
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>]
[-HelpInfoUri <string>]
[-PassThru]
[-DefaultCommandPrefix <string>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
A New-ModuleManifest
parancsmag létrehoz egy új moduljegyzékfájlt (.psd1
), feltölti az értékeit, és menti a jegyzékfájlt a megadott elérési úton.
A modulkészítők ezzel a parancsmaggal hozhatnak létre jegyzékfájlt a moduljukhoz. A moduljegyzék egy .psd1
kivonattáblát tartalmazó fájl. A kivonattáblában szereplő kulcsok és értékek leírják a modul tartalmát és attribútumait, meghatározzák az előfeltételeket, és meghatározzák az összetevők feldolgozásának módját. A modulhoz nincs szükség jegyzékekre.
New-ModuleManifest
létrehoz egy jegyzékfájlt, amely tartalmazza az összes gyakran használt jegyzékkulcsot, így az alapértelmezett kimenetet jegyzéksablonként használhatja. Ha értékeket szeretne hozzáadni vagy módosítani, vagy olyan modulkulcsokat szeretne hozzáadni, amelyeket ez a parancsmag nem ad hozzá, nyissa meg az eredményként kapott fájlt egy szövegszerkesztőben.
A Path és a PassThru kivételével minden paraméter létrehoz egy moduljegyzékkulcsot és annak értékét.
Egy moduljegyzékben csak a ModuleVersion kulcs szükséges. Ha nincs megadva a paraméter leírása, ha kihagy egy paramétert a parancsból, New-ModuleManifest
létrehoz egy megjegyzéssztringet a társított értékhez, amelynek nincs hatása.
A PowerShell 2.0-ban New-ModuleManifest
a parancsban nem megadott gyakran használt paraméterek értékeit kéri a szükséges paraméterértékek mellett. A PowerShell 3.0-tól kezdődően csak akkor kéri a rendszer, New-ModuleManifest
ha a szükséges paraméterértékek nincsenek megadva.
Ha a modult a PowerShell-galéria szeretné közzétenni, a jegyzéknek bizonyos tulajdonságok értékeit kell tartalmaznia. További információ: A katalógus dokumentációjában a PowerShell-galéria közzétett elemek kötelező metaadatai.
Példák
1. példa – Új moduljegyzék létrehozása
Ez a példa létrehoz egy új moduljegyzéket a fájlban, amelyet az Elérési út paraméter határoz meg. A PassThru paraméter elküldi a kimenetet a folyamatnak és a fájlnak.
A kimenet a jegyzékben szereplő összes kulcs alapértelmezett értékeit jeleníti meg.
New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru
#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 1/22/2019
#
@{
# Script module or binary module file associated with this manifest.
# RootModule = ''
# Version number of this module.
ModuleVersion = '1.0'
# Supported PSEditions
# CompatiblePSEditions = @()
# ID used to uniquely identify this module
GUID = '47179120-0bcb-4f14-8d80-f4560107f85c'
# Author of this module
Author = 'ContosoAdmin'
# Company or vendor of this module
CompanyName = 'Unknown'
# Copyright statement for this module
Copyright = '(c) 2019 ContosoAdmin. All rights reserved.'
# Description of the functionality provided by this module
# Description = ''
# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''
# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''
# Minimum version of the Windows 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 = ''
} # 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 = ''
}
2. példa – Új jegyzék létrehozása néhány előre feltöltött beállítással
Ez a példa létrehoz egy új moduljegyzéket. A PowerShellVersion és az AliasesToExport paraméterekkel adja hozzá az értékeket a megfelelő jegyzékkulcsokhoz.
$moduleSettings = @{
PowerShellVersion = 1.0
Path = 'C:\ps-test\ManifestTest.psd1'
AliasesToExport = @(
'JKBC'
'DRC'
'TAC'
)
}
New-ModuleManifest @moduleSettings
3. példa – Más modulokat igénylő jegyzék létrehozása
Ez a példa sztringformátumot használ a BitsTransfer modul nevének és a kivonattábla formátumának megadásához a PSScheduledJob modul nevének, GUID-jának és verziójának megadásához.
$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
Ez a példa bemutatja, hogyan használható a ModuleList, a RequiredModules és a NestedModules paraméter sztring- és kivonattáblázat-formátuma. Sztringeket és kivonattáblákat kombinálhat ugyanabban a paraméterértékben.
4. példa – Frissíthető súgót támogató jegyzék létrehozása
Ez a példa a HelpInfoUri paraméterrel hoz létre egy HelpInfoUri-kulcsot a moduljegyzékben. A paraméter és a kulcs értékének http-vel vagy https-lel kell kezdődnie. Ez az érték azt jelzi a frissíthető súgórendszernek, hogy hol található a modulHoz tartozó HelpInfo XML frissíthető súgóinformációs fájl.
$moduleSettings = @{
HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings
Az frissíthető súgóval kapcsolatos információkért lásd: about_Updatable_Help. A HelpInfo XML-fájlról további információt az Frissíthető súgó támogatása című témakörben talál.
5. példa – Moduladatok lekérése
Ez a példa bemutatja, hogyan szerezheti be egy modul konfigurációs értékeit. A moduljegyzékben szereplő értékek a modulobjektum tulajdonságainak értékeiben jelennek meg.
A Get-Module
parancsmag a Microsoft.PowerShell.Diagnostics modul listázási paraméterrel való lekérésére szolgál. A parancs elküldi a modult a parancsmagnak a Format-List
modulobjektum összes tulajdonságának és értékének megjelenítéséhez.
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}
Paraméterek
-AliasesToExport
Megadja a modul által exportált aliasokat. Helyettesítő karakterek használata engedélyezett.
Ezzel a paramétersel korlátozhatja a modul által exportált aliasokat. Eltávolíthatja az aliasokat az exportált aliasok listájából, de nem tud aliasokat hozzáadni a listához.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy AliasesToExport kulcsot egy (mind) értékkel *
, ami azt jelenti, hogy a modulban definiált összes aliast exportálja a jegyzék.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | * (all) |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-Author
Megadja a modul szerzőjének értékét.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy Author kulcsot az aktuális felhasználó nevével.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | Name of the current user |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ClrVersion
Meghatározza a Microsoft .NET-keretrendszer common language runtime (CLR) minimális verzióját, amelyet a modul igényel.
Feljegyzés
Ez a beállítás csak a PowerShell Desktop kiadásra érvényes, például a Windows PowerShell 5.1-hez, és csak a 4.5-nél kisebb .NET-keretrendszer verziókra vonatkozik. Ez a követelmény nincs hatással a PowerShell újabb verzióira vagy a .NET-keretrendszer.
Típus: | Version |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-CmdletsToExport
Megadja a modul által exportált parancsmagokat. Helyettesítő karakterek használata engedélyezett.
Ezzel a paramétersel korlátozhatja a modul által exportált parancsmagokat. Eltávolíthatja a parancsmagokat az exportált parancsmagok listájából, de nem tud parancsmagokat hozzáadni a listához.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy CmdletsToExport kulcsot egy (mind) értékkel *
, ami azt jelenti, hogy a modulban definiált parancsmagokat a jegyzék exportálja.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | * (all) |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-CompanyName
Azonosítja a modult létrehozó vállalatot vagy szállítót.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy "Ismeretlen" értékű CompanyName kulcsot.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | "Unknown" |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-CompatiblePSEditions
A modul kompatibilis PSEdition-jait adja meg. A PSEdition szolgáltatással kapcsolatos információkért tekintse meg a kompatibilis PowerShell-kiadásokkal rendelkező modulokat.
Típus: | String[] |
Elfogadott értékek: | Desktop, Core |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Confirm
Jóváhagyást kér a parancsmag futtatása előtt.
Típus: | SwitchParameter |
Aliasok: | cf |
Position: | Named |
Alapértelmezett érték: | False |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Copyright
A modul szerzői jogi nyilatkozatát adja meg.
Ha kihagyja ezt a paramétert, létrehoz egy szerzői jogi kulcsot, amelynek értéke <year>
(c) <year> <username>. All rights reserved.
az aktuális év, és <username>
a Szerzői kulcs értéke. New-ModuleManifest
Típus: | String |
Position: | Named |
Alapértelmezett érték: | (c) <year> <username>. All rights reserved. |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-DefaultCommandPrefix
Olyan előtagot ad meg, amely a modul összes parancsának főnevére van előtagként a munkamenetbe való importáláskor. Adjon meg egy előtag-sztringet. Az előtagok megakadályozzák a parancsnevek ütközését egy felhasználó munkamenetében.
A modulfelhasználók felülbírálhatják ezt az előtagot a Import-Module
parancsmag előtagparaméterének megadásával.
Ezt a paramétert a PowerShell 3.0-ban vezettük be.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Description
A modul tartalmát ismerteti.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-DotNetFrameworkVersion
Megadja a Microsoft .NET-keretrendszer minimális verzióját, amelyet a modul igényel.
Feljegyzés
Ez a beállítás csak a PowerShell Desktop kiadásra érvényes, például a Windows PowerShell 5.1-hez, és csak a 4.5-nél kisebb .NET-keretrendszer verziókra vonatkozik. Ez a követelmény nincs hatással a PowerShell újabb verzióira vagy a .NET-keretrendszer.
Típus: | Version |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-DscResourcesToExport
Megadja a modul által exportált kívánt állapotkonfigurációs (DSC-) erőforrásokat. Helyettesítő karakterek használata engedélyezett.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-FileList
Megadja a modulban szereplő összes elemet.
Ez a kulcs úgy lett kialakítva, hogy modulleltárként működjön. A kulcsban felsorolt fájlok a modul közzétételekor jelennek meg, de a függvények nem lesznek automatikusan exportálva.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-FormatsToProcess
Megadja a modul importálásakor futtatott formázási fájlokat (.ps1xml
).
Modul importálásakor a PowerShell a Update-FormatData
megadott fájlokkal futtatja a parancsmagot.
Mivel a formázási fájlok nincsenek hatókörben, a munkamenet összes munkamenetállapotára hatással vannak.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-FunctionsToExport
Meghatározza a modul által exportált függvényeket. Helyettesítő karakterek használata engedélyezett.
Ezzel a paramétersel korlátozhatja a modul által exportált függvényeket. Eltávolíthat függvényeket az exportált aliasok listájából, de nem tud függvényeket hozzáadni a listához.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy FunctionsToExport kulcsot egy (mind) értékkel *
, ami azt jelenti, hogy a modulban definiált összes függvényt exportálja a jegyzék.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | * (all) |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-Guid
A modul egyedi azonosítójának megadása. A GUID az azonos nevű modulok megkülönböztetésére használható.
Ha kihagyja ezt a paramétert, létrehoz egy GUID-kulcsot a jegyzékben, New-ModuleManifest
és létrehoz egy GUID azonosítót az értékhez.
Ha új GUID-t szeretne létrehozni a PowerShellben, írja be a következőt [guid]::NewGuid()
: .
Típus: | Guid |
Position: | Named |
Alapértelmezett érték: | A GUID generated for the module |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-HelpInfoUri
A modul HelpInfo XML-fájljának internetes címét adja meg. Adjon meg egy egységes erőforrás-azonosítót (URI), amely http vagy https használatával kezdődik.
A HelpInfo XML-fájl támogatja a PowerShell 3.0-ban bevezetett Frissíthető súgó funkciót. Információkat tartalmaz a modul letölthető súgófájljainak helyéről, valamint az egyes támogatott területi beállítások legújabb súgófájljainak verziószámairól.
Az frissíthető súgóval kapcsolatos információkért lásd: about_Updatable_Help. A HelpInfo XML-fájlról további információt az Frissíthető súgó támogatása című témakörben talál.
Ezt a paramétert a PowerShell 3.0-ban vezettük be.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-IconUri
Megadja a modul ikonjának URL-címét. A megadott ikon megjelenik a modul katalógusának weblapján.
Típus: | Uri |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-LicenseUri
Megadja a modul licencfeltételeinek URL-címét.
Típus: | Uri |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ModuleList
Felsorolja a modulban szereplő összes modult.
Adja meg az egyes modulneveket sztringként vagy kivonattábláként a ModuleName és a ModuleVersion kulcsokkal. A kivonatoló tábla opcionális GUID-kulccsal is rendelkezhet. A paraméterértékben sztringeket és kivonattáblákat kombinálhat.
Ez a kulcs úgy lett kialakítva, hogy modulleltárként működjön. A kulcs értékében felsorolt modulok feldolgozása nem történik meg automatikusan.
Típus: | Object[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ModuleVersion
Megadja a modul verzióját.
Ez a paraméter nem kötelező, de a jegyzékben egy ModuleVersion-kulcsra van szükség. Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy ModuleVersion-kulcsot 1,0 értékkel.
Típus: | Version |
Position: | Named |
Alapértelmezett érték: | 1.0 |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-NestedModules
A modul munkamenet-állapotába importált szkriptmodulokat (.psm1
) és bináris modulokat (.dll
) adja meg. A Beágyazottmodules kulcs fájljai abban a sorrendben futnak, amelyben szerepelnek az értékben.
Adja meg az egyes modulneveket sztringként vagy kivonattábláként a ModuleName és a ModuleVersion kulcsokkal. A kivonatoló tábla opcionális GUID-kulccsal is rendelkezhet. A paraméterértékben sztringeket és kivonattáblákat kombinálhat.
A beágyazott modulok általában olyan parancsokat tartalmaznak, amelyekre a gyökérmodulnak szüksége van a belső feldolgozáshoz.
Alapértelmezés szerint a beágyazott modulok parancsai a modul munkamenet-állapotából a hívó munkamenet-állapotába lesznek exportálva, de a gyökérmodul korlátozhatja az exportált parancsokat. Például egy Export-ModuleMember
parancs használatával.
A modul munkamenet-állapotában lévő beágyazott modulok elérhetők a gyökérmodul számára, de a hívó munkamenetállapotában lévő parancs nem adja vissza Get-Module
őket.
A Beágyazottmodules kulcsban felsorolt szkriptek (.ps1
) nem a hívó munkamenetállapotában, hanem a modul munkamenet-állapotában futnak. Ha szkriptet szeretne futtatni a hívó munkamenet-állapotában, adja meg a szkriptfájl nevét a jegyzékben lévő ScriptsToProcess kulcs értékében.
Típus: | Object[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-PassThru
Az eredményként kapott moduljegyzéket a konzolra írja, és létrehoz egy .psd1
fájlt. Ez a parancsmag alapértelmezés szerint nem hoz létre kimenetet.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | False |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Path
Megadja az új moduljegyzék elérési útját és fájlnevét. Adjon meg egy elérési utat és egy fájlnevet egy .psd1
fájlnévkiterjesztéssel, például $pshome\Modules\MyModule\MyModule.psd1
. Az Elérési út paraméter megadása kötelező.
Ha egy meglévő fájl elérési útját adja meg, figyelmeztetés nélkül lecseréli a fájlt, New-ModuleManifest
kivéve, ha a fájl írásvédett attribútummal rendelkezik.
A jegyzékfájlnak a modul könyvtárában kell lennie, a jegyzékfájl nevének pedig meg kell egyeznie a modul könyvtárának nevével, de fájlnévkiterjesztéssel .psd1
.
Feljegyzés
Az Elérési út paraméter értékére vonatkozó kérdésre adott válaszként nem használhat változókat, például $PSHOME
vagy $HOME
– válaszul. Változó használatához adja meg az Elérési út paramétert a parancsban.
Típus: | String |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-PowerShellHostName
Megadja annak a PowerShell-gazdagépprogramnak a nevét, amelyre a modulnak szüksége van. Adja meg a gazdagépprogram nevét, például a Windows PowerShell ISE-gazdagépét vagy a ConsoleHostot. A helyettesítő karakterek használata nem engedélyezett.
A gazdagépprogram nevének megkereséséhez írja be a programba $Host.Name
.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-PowerShellHostVersion
Meghatározza a modullal működő PowerShell-gazdagépprogram minimális verzióját. Adjon meg egy verziószámot, például az 1.1-et.
Típus: | Version |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-PowerShellVersion
A Modullal működő PowerShell minimális verzióját adja meg. Megadhatja például az 1.0, a 2.0 vagy a 3.0 értéket a paraméter értékeként. X.X formátumban kell lennie. Ha például beküldi 5
, a PowerShell hibát jelez.
Típus: | Version |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-PrivateData
Megadja a modulnak az importáláskor átadott adatokat.
Típus: | Object |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ProcessorArchitecture
Megadja a modul által igényelt processzorarchitektúrát. Az érvényes értékek: x86, AMD64, IA64, MSIL és None (ismeretlen vagy meghatározatlan).
Típus: | ProcessorArchitecture |
Elfogadott értékek: | None, MSIL, X86, IA64, Amd64, Arm |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ProjectUri
Megadja a projekthez tartozó weblap URL-címét.
Típus: | Uri |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ReleaseNotes
Kibocsátási megjegyzéseket ad meg.
Típus: | String |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-RequiredAssemblies
Megadja a modul által igényelt szerelvényfájlokat..dll
Adja meg a szerelvényfájlneveket.
A PowerShell betölti a megadott szerelvényeket a típusok vagy formátumok frissítése, a beágyazott modulok importálása vagy a RootModule kulcs értékében megadott modulfájl importálása előtt.
Ezzel a paraméter használatával listázhatja a modul által igényelt szerelvényeket, beleértve azokat a szerelvényeket is, amelyeket be kell tölteni a FormatsToProcess vagy TypesToProcess kulcsokban felsorolt formázási vagy típusfájlok frissítéséhez, még akkor is, ha ezek a szerelvények bináris modulokként is szerepelnek a Beágyazottmodulok kulcsban.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-RequiredModules
Megadja azokat a modulokat, amelyeknek globális munkamenet-állapotban kell lenniük. Ha a szükséges modulok nincsenek globális munkamenet-állapotban, a PowerShell importálja őket. Ha a szükséges modulok nem érhetők el, a Import-Module
parancs meghiúsul.
Adja meg az egyes modulneveket sztringként vagy kivonattábláként a ModuleName és a ModuleVersion kulcsokkal. A kivonatoló tábla opcionális GUID-kulccsal is rendelkezhet. A paraméterértékben sztringeket és kivonattáblákat kombinálhat.
A PowerShell 2.0-ban Import-Module
nem importálja automatikusan a szükséges modulokat. Csak ellenőrzi, hogy a szükséges modulok globális munkamenet-állapotban vannak-e.
Típus: | Object[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-RootModule
A modul elsődleges vagy gyökérfájlját adja meg. Adja meg egy szkript (), egy szkriptmodul (.ps1
.psm1
), egy moduljegyzék(.psd1
), egy szerelvény (.dll
), egy parancsmagdefiníciós XML-fájl () vagy munkafolyamat (.cdxml
.xaml
) fájlnevét. A modul importálásakor a gyökérmodul-fájlból exportált tagok a hívó munkamenet-állapotába lesznek importálva.
Ha egy modul jegyzékfájllal rendelkezik, és a RootModule kulcsban nem lett kijelölve gyökérfájl, a jegyzékfájl lesz a modul elsődleges fájlja, a modul pedig jegyzékmodul (ModuleType = Jegyzék).
Ha egy jegyzékfájllal rendelkező modul tagjait .psm1
vagy .dll
fájljait szeretné exportálni, ezeknek a fájloknak a nevét meg kell adni a jegyzékben szereplő RootModule vagy BeágyazottModules kulcsok értékeiben. Ellenkező esetben a tagok nem lesznek exportálva.
Feljegyzés
A PowerShell 2.0-ban ezt a kulcsot ModuleToProcess-nak hívták. Használhatja a RootModule paraméternevet vagy annak ModuleToProcess aliasát.
Típus: | String |
Aliasok: | ModuleToProcess |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-ScriptsToProcess
A modul importálásakor a hívó munkamenet-állapotában futó szkriptfájlokat (.ps1
) adja meg.
Ezekkel a szkriptekkel előkészíthet egy környezetet, akárcsak egy bejelentkezési szkriptet.
A modul munkamenet-állapotában futó szkriptek megadásához használja a Beágyazottmodules kulcsot.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Tags
Címkék tömbjének megadása.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-TypesToProcess
Megadja a modul importálásakor futtatott típusfájlokat (.ps1xml
).
A modul importálásakor a PowerShell a Update-TypeData
megadott fájlokkal futtatja a parancsmagot.
Mivel a típusfájlok hatóköre nem terjed ki, a munkamenet összes munkamenetállapotára hatással vannak.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-VariablesToExport
Megadja a modul által exportált változókat. Helyettesítő karakterek használata engedélyezett.
Ezzel a paramétersel korlátozhatja a modul által exportált változókat. Eltávolíthatja a változókat az exportált változók listájából, de nem tud változókat hozzáadni a listához.
Ha kihagyja ezt a paramétert, New-ModuleManifest
létrehoz egy VariablesToExport kulcsot egy (mind) értékkel *
, ami azt jelenti, hogy a modulban definiált összes változót exportálja a jegyzék.
Típus: | String[] |
Position: | Named |
Alapértelmezett érték: | * (all) |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-WhatIf
Megjeleníti, mi történne, ha New-ModuleManifest
futna. A parancsmag nem fut.
Típus: | SwitchParameter |
Aliasok: | wi |
Position: | Named |
Alapértelmezett érték: | False |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
Bevitelek
None
Ehhez a parancsmaghoz nem lehet objektumokat csövezni.
Kimenetek
None
Ez a parancsmag alapértelmezés szerint nem ad vissza kimenetet.
A PassThru paraméter használatakor ez a parancsmag egy, a moduljegyzéket képviselő sztringet ad vissza.
Jegyzetek
New-ModuleManifest
UTF16-ként kódolt moduljegyzékfájlokat.psd1
hoz létre.
A moduljegyzékek általában nem kötelezőek. A globális szerelvény-gyorsítótárban telepített szerelvény exportálásához azonban moduljegyzék szükséges.
Ha fájlokat szeretne hozzáadni vagy módosítani a címtárban, indítsa el a $pshome\Modules
PowerShellt a Futtatás rendszergazdaként beállítással.
A PowerShell 2.0-ban számos paraméter New-ModuleManifest
kötelező volt, még akkor is, ha nem volt kötelező a moduljegyzékben. A PowerShell 3.0-tól kezdve csak az Elérési út paraméter kötelező.
A munkamenet a PowerShell végrehajtási környezetének egy példánya. A munkamenetek egy vagy több munkamenet-állapotot tartalmazhatnak. Alapértelmezés szerint egy munkamenet csak globális munkamenet-állapottal rendelkezik, de minden importált modul saját munkamenet-állapottal rendelkezik. A munkamenet-állapotok lehetővé teszik, hogy a modul parancsai a globális munkamenet állapotának befolyásolása nélkül fussanak.
A hívó munkamenet-állapota az a munkamenet-állapot, amelybe importál egy modult. Általában a globális munkamenet állapotára utal, de ha egy modul beágyazott modulokat importál, a hívó a modul, a hívó munkamenet-állapota pedig a modul munkamenet-állapota.