New-ModuleManifest
Létrehoz egy új moduljegyzéket.
Syntax
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
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 kivonattáblát tartalmazó .psd1 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 kimenet használható jegyzéksablonként. 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 PassThrukivé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 nem adja meg a paraméter leírását, 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 kéri a parancsban nem megadott gyakran használt paraméterek értékeit a szükséges paraméterértékek mellett. A PowerShell 3.0-tól kezdődően New-ModuleManifest csak akkor kéri, ha a szükséges paraméterértékek nincsenek megadva.
Ha a modult a PowerShell-katalógusban szeretné közzétenni, a jegyzéknek bizonyos tulajdonságok értékeit kell tartalmaznia. További információ: A PowerShell-katalógusban közzétett elemek kötelező metaadatai a Katalógus dokumentációjában.
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 a Path 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: 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 = ''
}
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 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 megadásához, és kivonattábla formátumot a név, a GUIDés a PSScheduledJob modul egy 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, RequiredModulesés NestedModules paraméterek karakterlánc- és hash-tábla-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 vagy https 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. További információért a HelpInfo XML-fájllal kapcsolatban lásd a következőt: Frissíthető súgótámogatása.
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 lekérésére szolgál a Lista paraméter használatával. A parancs elküldi a modult a Format-List parancsmagnak a 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 * (mind) értékkel, ami azt jelenti, hogy a modulban definiált összes aliast exportálja a jegyzék.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | * (all) |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Author
Megadja a modul szerzőjét.
Ha kihagyja ezt a paramétert, New-ModuleManifest létrehoz egy Author kulcsot az aktuális felhasználó nevével.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | Name of the current user |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ClrVersion
Meghatározza a Modulhoz szükséges Microsoft .NET-keretrendszer Common Language Runtime (CLR) minimális verzióját.
Megjegyzé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 .NET-keretrendszer 4.5-nél kisebb verzióira vonatkozik. Ez a követelmény nincs hatással a PowerShell vagy a .NET-keretrendszer újabb verzióira.
Paramétertulajdonságok
| Típus: | Version |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 * (mind) értékkel, ami azt jelenti, hogy a modulban definiált parancsmagokat a jegyzék exportálja.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | * (all) |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-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 CompanyName kulcsot "Ismeretlen" értékkel.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | Unknown |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-CompatiblePSEditions
A modul kompatibilis PSEditionjeit adja meg. A PSEdition kiadásról szóló információkért lásd: kompatibilis PowerShell-verziókkal rendelkező modulok.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Elfogadott értékek: | Desktop, Core |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Confirm
Megerősítést kér a parancsmag futtatása előtt.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
| Aliasok: | Cf |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Copyright
A modul szerzői jogi nyilatkozatát adja meg.
Ha kihagyja ezt a paramétert, New-ModuleManifest létrehoz egy Szerzői jogi kulcsot olyan (c) <year> <username>. All rights reserved. értékkel, ahol <year> az aktuális év, <username> pedig a Szerző kulcs értéke.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | (c) <year> <username>. All rights reserved. |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-DefaultCommandPrefix
Azon előtagot ad meg, amely a modul összes parancsának főnévéhez van hozzáillesztve, amikor a munkamenetbe importálják őket. 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 parancsmag Import-Module paraméterének megadásával.
Ezt a paramétert a PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Description
A modul tartalmát ismerteti.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-DotNetFrameworkVersion
Megadja a Modul által igényelt Microsoft .NET-keretrendszer minimális verzióját.
Megjegyzé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 .NET-keretrendszer 4.5-nél kisebb verzióira vonatkozik. Ez a követelmény nincs hatással a PowerShell vagy a .NET-keretrendszer újabb verzióira.
Paramétertulajdonságok
| Típus: | Version |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ExternalModuleDependencies
Azoknak a külső moduloknak a listája, amelyektől ez a modul függ. Ez a lista csak a modul függőségeinek dokumentálására szolgál, és a PowerShell nem kényszeríti ki. A PowerShellGet- vagy PSResourceGet-parancsok, illetve a PowerShell-gyűjtemény nem használják.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-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.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-FormatsToProcess
A modul importálásakor futtatott formázási fájlokat (.ps1xml) adja meg.
Modul importálásakor a PowerShell a megadott fájlokkal futtatja a Update-FormatData parancsmagot.
Mivel a formázási fájlok nincsenek hatásukban korlátozva, a munkamenet összes állapotára hatással vannak.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | * (all) |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-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, New-ModuleManifest létrehoz egy GUID kulcsot a jegyzékben, és létrehoz egy GUID az értékhez.
Ha új GUID- szeretne létrehozni a PowerShellben, írja be a [guid]::NewGuid().
Paramétertulajdonságok
| Típus: | Guid |
| Alapértelmezett érték: | A GUID generated for the module |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 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. További információért a HelpInfo XML-fájllal kapcsolatban lásd a következőt: Frissíthető súgótámogatása.
Ezt a paramétert a PowerShell 3.0-ban vezettük be.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-IconUri
Megadja a modul ikonjának URL-címét. A megadott ikon megjelenik a modul katalógusának weblapján.
Paramétertulajdonságok
| Típus: | Uri |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-LicenseUri
Megadja a modul licencfeltételeinek URL-címét.
Paramétertulajdonságok
| Típus: | Uri |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ModuleList
Felsorolja a modulban szereplő összes modult.
Adja meg az egyes modulneveket sztringként vagy kivonattáblaként ModuleName és ModuleVersion kulcsokkal. A kivonatoló tábla rendelkezhet opcionális GUID kulccsal is. 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.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ModuleVersion
Megadja a modul verzióját.
Ez a paraméter nem kötelező, de a jegyzékben ModuleVersion kulcsra van szükség. Ha kihagyja ezt a paramétert, New-ModuleManifest létrehoz egy ModuleVersion kulcsot 1,0 értékkel.
Paramétertulajdonságok
| Típus: | Version |
| Alapértelmezett érték: | 1.0 |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-NestedModules
A modul munkamenet-állapotába importált szkriptmodulokat (.psm1) és bináris modulokat (.dll) adja meg. A Beágyazottmodulok kulcsban lévő fájlok abban a sorrendben futnak, amelyben szerepelnek az értékben.
Adja meg az egyes modulneveket sztringként vagy kivonattáblaként ModuleName és ModuleVersion kulcsokkal. A kivonatoló tábla rendelkezhet opcionális GUID kulccsal is. 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 paranccsal.
A modul munkamenet-állapotában lévő beágyazott modulok elérhetők a főmodul számára, de a hívó munkamenetállapotában lévő Get-Module parancs nem adja vissza őket.
A .ps1 kulcsban felsorolt szkriptek () 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 szereplő ScriptsToProcess kulcs értékében.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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. A Útvonal paraméter szükséges.
Ha egy meglévő fájl elérési útját adja meg, New-ModuleManifest figyelmeztetés nélkül lecseréli a fájlt, kivéve, ha a fájl írásvédett attribútummal rendelkezik.
A jegyzékfájlnak a modul könyvtárában kell lennie, és a jegyzékfájl nevének meg kell egyeznie a modul könyvtárának nevével, de .psd1 fájlnévkiterjesztéssel.
Megjegyzés:
Nem használhat változókat( például $PSHOME vagy $HOME) egy elérési út paraméterértékre vonatkozó kérdésre adott válaszként. Változó használatához adja meg a Path paramétert a parancsban.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 1 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-PowerShellHostName
Megadja annak a PowerShell-gazdagépprogramnak a nevét, amelyre a modulnak szüksége van. Adja meg a házigazda program nevét, például Windows PowerShell ISE házigazda vagy ConsoleHost. A helyettesítő karakterek használata nem engedélyezett.
A hosztprogram nevének megkereséséhez a programban írja be a $Host.Nameparancsot.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Paramétertulajdonságok
| Típus: | Version |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 5küld, a PowerShell hibát jelez.
Paramétertulajdonságok
| Típus: | Version |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Prerelease
A modul előzetes verziós lánca. A Prerelease-sztring hozzáadása a modult előzetes verzióként azonosítja. Amikor a modult közzéteszik a PowerShell-katalógusban, ezek az adatok az előzetes csomagok azonosítására szolgálnak. Az előzetes csomagok galériából való beszerzéséhez az AllowPrerelease paramétert kell használnia a PowerShellGet parancsokkal Find-Module, Install-Module, Update-Moduleés Save-Module.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-PrivateData
Azokat az adatokat adja meg, amelyeket a modulnak adnak át, amikor importálják.
Paramétertulajdonságok
| Típus: | Object |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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).
Paramétertulajdonságok
| Típus: | ProcessorArchitecture |
| Alapértelmezett érték: | None |
| Elfogadott értékek: | None, MSIL, X86, IA64, Amd64, Arm |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ProjectUri
Megadja a projekthez tartozó weblap URL-címét.
Paramétertulajdonságok
| Típus: | Uri |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ReleaseNotes
Kibocsátási megjegyzéseket ad meg.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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.
Ez a paraméter felsorolja a modul által igényelt összes szerelvényt, beleértve azokat a szerelvényeket is, amelyeket be kell tölteni a FormatsToProcess vagy TypeToProcess kulcsokban felsorolt formázási vagy típusfájlok frissítéséhez, még akkor is, ha ezek a szerelvények bináris modulként is szerepelnek a Beágyazott modulok kulcsban.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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áblaként ModuleName és ModuleVersion kulcsokkal. A kivonatoló tábla rendelkezhet opcionális GUID kulccsal is. A paraméterértékben sztringeket és kivonattáblákat kombinálhat.
Amikor modult telepít a parancsok vagy Install-PSResource parancsok Install-Module használatával, ezek a parancsok ellenőrzik ezt a listát. Ha a szükséges modulok nincsenek telepítve, a parancsok megpróbálják telepíteni a szükséges modulokat.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-RequireLicenseAcceptance
Jelző, amely jelzi, hogy a modulnak explicit felhasználói elfogadásra van-e szüksége a telepítéshez, frissítéshez vagy mentéshez.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-RootModule
A modul elsődleges vagy gyökérfájlját adja meg. Adja meg egy szkript (.ps1), egy szkriptmodul (.psm1), egy moduljegyzék (.psd1), egy szerelvény (.dll), egy parancsmagdefiníciós XML-fájl (.cdxml) vagy munkafolyamat (.xaml) fájl nevé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 kulcs nem tartalmaz gyökérfájlt, a jegyzékfájl lesz a modul elsődleges fájlja, és a modul jegyzékmodulná válik (ModuleType = Jegyzékfájl).
Ha egy jegyzékfájlt tartalmazó modulban lévő .psm1 vagy .dll fájlokból szeretne tagokat exportálni, a fájlok nevét meg kell adni a jegyzékben szereplő RootModule vagy beágyazottmodulok kulcsainak értékeiben. Ellenkező esetben a tagok nem lesznek exportálva.
Megjegyzés:
A PowerShell 2.0-ban ezt a kulcsot ModuleToProcess-nek nevezték. A RootModule paraméternevet vagy annak ModuleToProcess aliasát használhatja.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
| Aliasok: | ModuleToProcess |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ScriptsToProcess
Olyan szkriptfájlokat (.ps1) határoz meg, amelyek a modul importálásakor a hívó munkamenet-állapotában futnak.
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ágyazott modulok kulcsot.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Tags
Egy címkék tömbjét határozza meg.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-TypesToProcess
A modul importálásakor futtatott típusfájlokat (.ps1xml) adja meg.
A modul importálásakor a PowerShell a megadott fájlokkal futtatja a Update-TypeData parancsmagot.
Mivel a típusfájlok hatóköre nem terjed ki, a munkamenet összes munkamenetállapotára hatással vannak.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | 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 * (mind) értékkel, ami azt jelenti, hogy a modulban definiált összes változót exportálja a jegyzék.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | * (all) |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-WhatIf
Megjeleníti, mi történne, ha New-ModuleManifest futna. A parancsprogram nem lett futtatva.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | False |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
| Aliasok: | Wi |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
Bevitelek
None
Ehhez a parancsmaghoz nem lehet objektumokat csövezni.
Kimenetek
None
Ez a parancsmag alapértelmezés szerint nem ad vissza kimenetet.
String
A PassThru paraméter használatakor ez a parancsmag a moduljegyzéket képviselő sztringet adja vissza.
Jegyzetek
New-ModuleManifest windowsos és nem Windows rendszerű platformokon futó moduljegyzékfájlokat (.psd1) UTF8NoBOMkódolva 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 $PSHOME\Modules könyvtárban, indítsa el a PowerShellt a Futtatás rendszergazdaként beállítással.
Megjegyzés:
A PowerShell a PowerShell 6.2-től kezdve megpróbálja betölteni a moduljegyzék FileList tulajdonságában felsorolt összes DLL-fájlt. A natív DLL-ek a FileList fájlban találhatóak nem töltődnek be a folyamatban, és a hibát figyelmen kívül hagyják. Az összes felügyelt DLL betöltődik a folyamatba. Ez a viselkedés el lett távolítva a PowerShell 7.1-ben.
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.
A PowerShell 2.0-ban a New-ModuleManifest számos paramétere kötelező volt, még akkor is, ha nem volt kötelező a moduljegyzékben. A PowerShell 3.0-tól kezdve csak a Elérési út paraméter kötelező.
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.
