New-ModuleManifest
建立新的模組資訊清單。
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[]>]
[-PrivateData <Object>]
[-Tags <string[]>]
[-ProjectUri <uri>]
[-LicenseUri <uri>]
[-IconUri <uri>]
[-ReleaseNotes <string>]
[-HelpInfoUri <string>]
[-PassThru]
[-DefaultCommandPrefix <string>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Cmdlet New-ModuleManifest
會在) 檔案 (.psd1
建立新的模組指令清單、填入其值,並將指令清單檔儲存在指定的路徑中。
模組作者可以使用這個 Cmdlet 建立其模組資訊清單。 模組指令清單是 .psd1
包含哈希表的檔案。 雜湊表中的索引鍵和值描述模組的內容和屬性、定義先決條件,和決定元件的處理方式。 模組不需要指令清單。
New-ModuleManifest
會建立包含所有常用指令清單索引鍵的指令清單,因此您可以使用預設輸出作為指令清單範本。 若要新增或變更值,或新增此 Cmdlet 未新增的模組索引鍵,請在文本編輯器中開啟產生的檔案。
除了 Path 和 PassThru 以外,每個參數都會建立模組指令清單索引鍵及其值。
在模組資訊清單中,只有 ModuleVersion 索引鍵是必要的。 除非在參數描述中指定,否則如果您省略命令中的參數, New-ModuleManifest
請為沒有作用的相關聯值建立批注字串。
在 PowerShell 2.0 中,除了必要的參數值之外, New-ModuleManifest
還會提示您輸入命令中未指定之常用參數的值。 從 PowerShell 3.0 開始, New-ModuleManifest
只有在未指定必要的參數值時,才會提示。
範例
範例 1 - Create 新的模組指令清單
此範例會在 Path 參數指定的檔案中建立新的模組指令清單。 PassThru 參數會將輸出傳送至管線和檔案。
輸出顯示資訊清單中所有索引鍵的預設值。
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'
# 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 the .NET Framework required by this module
# DotNetFrameworkVersion = ''
# Minimum version of the common language runtime (CLR) required by this module
# 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
FunctionsToExport = '*'
# Cmdlets to export from this module
CmdletsToExport = '*'
# Variables to export from this module
VariablesToExport = '*'
# Aliases to export from this module
AliasesToExport = '*'
# 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
# PrivateData = ''
# HelpInfo URI of this module
# HelpInfoURI = ''
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''
}
範例 2 - 使用一些預先填入的設定 Create 新的指令清單
此範例會建立新的模組指令清單。 它使用 PowerShellVersion 和 AliasesToExport 參數,將值新增至對應的資訊清單索引鍵。
New-ModuleManifest -PowerShellVersion 1.0 -AliasesToExport JKBC, DRC, TAC -Path C:\ps-test\ManifestTest.psd1
範例 3 - Create 需要其他模組的指令清單
此範例會使用字串格式來指定 BitsTransfer 模組的名稱和哈希表格式,以指定名稱、 GUID 和 PSScheduledJob 模組的版本。
$moduleSettings = @{
RequiredModules = ("BitsTransfer", @{
ModuleName="PSScheduledJob"
ModuleVersion="1.0.0.0";
GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
})
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings
此範例示範如何使用 ModuleList、 RequiredModules 和 NestedModules 參數的字串串和哈希表格式。 您可以在相同的參數值中結合字串和雜湊表。
範例 4 - Create 支援可更新說明的指令清單
此範例會使用 HelpInfoUri 參數,在模組指令清單中建立 HelpInfoUri 密鑰。 參數和索引鍵的值必須以 HTTP 或 HTTPs 開頭。 此值指示「可更新的說明」系統尋找模組 HelpInfo XML 可更新的說明資訊檔案的位置。
$moduleSettings = @{
HelpInfoUri = 'https://https://go.microsoft.com/fwlink/?LinkID=603'
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings
如需可更新的說明資訊,請參閱 about_Updatable_Help。 如需 HelpInfo XML 檔案的相關信息,請參閱 支援可更新的說明。
範例 5 - 取得模組資訊
此範例示範如何取得模組的組態值。 模組指令清單中的值會反映在模組對象的屬性值中。
Cmdlet Get-Module
可用來使用 List 參數取得 Microsoft.PowerShell.Diagnostics 模組。 命令會將模組傳送至 Format-List
Cmdlet,以顯示模組物件的所有屬性和值。
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}
參數
-AliasesToExport
指定模組匯出的別名。 允許使用萬用字元。
您可以使用此參數來限制模組匯出的別名。 它可以從導出的別名清單中移除別名,但無法將別名新增至清單。
如果您省略此參數,New-ModuleManifest
請使用 (所有) 的值*
建立 AliasesToExport 索引鍵,這表示指令清單會匯出模組中定義的所有別名。
Type: | String[] |
Position: | Named |
Default value: | * (all) |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Author
指定模組作者。
如果您省略此參數, New-ModuleManifest
請使用目前用戶的名稱建立 Author 金鑰。
Type: | String |
Position: | Named |
Default value: | Name of the current user |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ClrVersion
指定模組所需要的 Microsoft .NET Framework Common Language Runtime (CLR) 最低版本。
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CmdletsToExport
指定模組匯出的 Cmdlet。 允許使用萬用字元。
您可以使用此參數來限制模組匯出的 Cmdlet。 它可以從導出的 Cmdlet 清單中移除 Cmdlet,但無法將 Cmdlet 新增至清單。
如果您省略此參數, New-ModuleManifest
請建立 CmdletsToExport 索引鍵,其值為 *
(所有) ,這表示指令清單會匯出模組中定義的所有 Cmdlet。
Type: | String[] |
Position: | Named |
Default value: | * (all) |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-CompanyName
識別建立模組的公司或廠商。
如果您省略此參數, New-ModuleManifest
請建立值為 “Unknown” 的 CompanyName 機碼。
Type: | String |
Position: | Named |
Default value: | "Unknown" |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
在執行 Cmdlet 前提示您確認。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Copyright
指定模組的著作權聲明。
如果您省略此參數, New-ModuleManifest
請建立 值為 的 (c) <year> <username>. All rights reserved.
Copyright 索引鍵,其中 <year>
是目前的年份,而 <username>
是 Author 索引鍵的值。
Type: | String |
Position: | Named |
Default value: | (c) <year> <username>. All rights reserved. |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultCommandPrefix
指定前置詞,在模組中彙入至會話時,會加上模組中所有命令的名詞。 輸入前置詞字串。 前置詞可避免使用者工作階段中的命令名稱衝突。
模組用戶可以藉由指定 Cmdlet 的 Import-Module
Prefix 參數來覆寫此前置詞。
此參數是在 PowerShell 3.0 中引進。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
說明模組的內容。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DotNetFrameworkVersion
指定模組所需要的 Microsoft .NET Framework 最低版本。
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DscResourcesToExport
指定模組匯出 Desired State Configuration (DSC) 資源。 允許使用萬用字元。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-FileList
指定模組中所包含的所有項目。
這個索引鍵被設計來做為模組詳細目錄。 發佈模組時會包含金鑰中列出的檔案,但不會自動匯出任何函式。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FormatsToProcess
指定匯入模組時執行的格式化檔案 (.ps1xml
) 。
當您匯入模組時,PowerShell 會 Update-FormatData
以指定的檔案執行 Cmdlet。
因為格式設定檔案的範圍不是,所以會影響會話中的所有會話狀態。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FunctionsToExport
指定模組匯出的函式。 允許使用萬用字元。
您可以使用此參數來限制模組匯出的函式。 它可以從導出的別名清單中移除函式,但無法將函式新增至清單。
如果您省略此參數,New-ModuleManifest
請建立值為 (所有) 的 *
FunctionsToExport 索引鍵,這表示模組中定義的所有函式都會由指令清單匯出。
Type: | String[] |
Position: | Named |
Default value: | * (all) |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Guid
指定模組的唯一識別碼。 GUID 可用來區分具有相同名稱的模組。
如果您省略此參數, New-ModuleManifest
請在指令清單中建立 GUID 金鑰,併產生值的 GUID 。
若要在 PowerShell 中建立新的 GUID ,請輸入 [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
指定模組之 HelpInfo XML 檔案的因特網位址。 輸入以 HTTP 或 HTTPs 開頭的統一資源識別碼 (URI) 。
HelpInfo XML 檔案支援 PowerShell 3.0 中引進的可更新說明功能。 它包含模組可下載說明檔案的位置,以及每個支援的地區設定最新說明檔案版本號碼。
如需可更新說明的相關信息,請參閱 about_Updatable_Help。 如需 HelpInfo XML 檔案的相關信息,請參閱 支援可更新的說明。
此參數是在 PowerShell 3.0 中引進。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IconUri
指定模組圖示的 URL。 指定的圖示會顯示在模組的資源庫網頁上。
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LicenseUri
指定模組授權條款的 URL。
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ModuleList
列出此模組中所包含的所有模組。
輸入每個模組名稱做為字串或含 ModuleName 和 ModuleVersion 索引鍵的雜湊表。 雜湊表也可以有選用的 GUID 索引鍵。 您可以在參數值中結合字串和雜湊表。
這個索引鍵被設計來做為模組詳細目錄。 不會自動處理此索引鍵值中列出的模組。
Type: | Object[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ModuleVersion
指定模組的版本。
此參數並非必要,但指令清單中需要 ModuleVersion 密鑰。 如果您省略此參數, New-ModuleManifest
請建立值為 1.0 的 ModuleVersion 金鑰。
Type: | Version |
Position: | Named |
Default value: | 1.0 |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NestedModules
指定 () 和二進位模組.dll
的腳本模組.psm1
, () 匯入模組的會話狀態。 NestedModules 機碼中的檔案會依照值中列出的順序執行。
輸入每個模組名稱做為字串或含 ModuleName 和 ModuleVersion 索引鍵的雜湊表。 雜湊表也可以有選用的 GUID 索引鍵。 您可以在參數值中結合字串和雜湊表。
一般而言,巢狀模組包含根模組內部處理所需要的命令。
根據預設,巢狀模組中的命令會從模組的會話狀態匯出到呼叫端的會話狀態,但根模組可以限制其導出的命令。 例如,使用 Export-ModuleMember
命令。
模組會話狀態中的巢狀模組可供根模組使用,但不會由呼叫端會話狀態中的命令傳 Get-Module
回。
在 NestedModules 機碼中列出的腳本 (.ps1
) 是在模組的會話狀態中執行,而不是在呼叫端的會話狀態中執行。 如果要在呼叫者工作階段狀態下執行指令碼,請在資訊清單的 ScriptsToProcess 索引鍵值中列出指令碼檔案名稱。
Type: | Object[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
將產生的模組指令清單寫入主控台,並建立檔案 .psd1
。 根據預設,此 Cmdlet 不會產生任何輸出。
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
指定新模組資訊清單的路徑和檔案名稱。 輸入延伸名為 .psd1
的路徑與檔案名稱, 例如 $pshome\Modules\MyModule\MyModule.psd1
。 需要 Path 參數。
如果您指定現有檔案的路徑,除非檔案具有只讀屬性, New-ModuleManifest
否則會取代檔案而不發出警告。
指令清單應該位於模組的目錄中,而指令清單檔名應該與模組目錄名稱相同,但擴展名 .psd1
為 。
注意
您無法使用 或 $HOME
之類的$PSHOME
變數來回應 Path 參數值的提示。 如果要使用變數,請在命令中包含 Path 參數。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PowerShellHostName
指定模組所需的 PowerShell 主機程式名稱。 輸入主機程式的名稱,例如 Windows PowerShell ISE 主機或 ConsoleHost。 不允許通配符。
若要尋找主機程式的名稱,請在程式中輸入 $Host.Name
。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PowerShellHostVersion
指定與模組搭配運作的PowerShell主機程式最低版本。 輸入版本號碼,例如 1.1。
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PowerShellVersion
指定與本課程模組搭配運作的PowerShell最低版本。 例如,您可以輸入 1.0、2.0 或 3.0 作為參數的值。
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivateData
指定匯入模組時傳遞至模組的數據。
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProcessorArchitecture
指定模組需要的處理器架構。 有效值為 x86、AMD64、IA64、MSIL 和 None (未知或未指定的) 。
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
指定此項目相關網頁的 URL。
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReleaseNotes
指定版本資訊。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RequiredAssemblies
指定模組所需的元件 (.dll
) 檔案。 輸入組件檔案名稱。
PowerShell 會先載入指定的元件,再更新類型或格式、匯入巢狀模組,或匯入 RootModule 索引鍵值中指定的模組檔案。
使用這個參數來列出模組需要的所有組件,包含必須載入以更新任何格式的組件,或是 FormatsToProcess 或 TypesToProcess 索引鍵中列出的類型檔案,即使這些組件也在 NestedModules 索引鍵中列為二進位模組。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RequiredModules
指定必須在全域工作階段狀態的模組。 如果必要的模組不在全域會話狀態,PowerShell 會匯入這些模組。 如果無法使用所需的模組,命令就會 Import-Module
失敗。
輸入每個模組名稱做為字串或含 ModuleName 和 ModuleVersion 索引鍵的雜湊表。 雜湊表也可以有選用的 GUID 索引鍵。 您可以在參數值中結合字串和雜湊表。
在 PowerShell 2.0 中, Import-Module
不會自動匯入必要的模組。 它只會驗證必要的模組會在全域工作階段狀態。
Type: | Object[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RootModule
指定模組的主要或根檔案。 輸入腳本 () .ps1
的檔名、腳本模組 () 、模組指令清單 .psd1
(.psm1
) 、元件 .dll
() 、cmdlet 定義 XML 檔案 (.cdxml
) 或工作流程 (.xaml
) 。 匯入模組時,從根模組檔案匯出的成員會匯入呼叫者工作階段狀態。
如果模組具有指令清單檔,而且 RootModule 機碼中未指定根檔案,則指令清單會變成模組的主要檔案,而模組會變成指令清單模組, (ModuleType = 指令清單) 。
若要從 .psm1
模組中匯出具有指令清單的成員或 .dll
檔案,這些檔案的名稱必須在指令清單中的 RootModule 或 NestedModules 索引鍵值中指定。 否則,不會匯出其成員。
注意
在 PowerShell 2.0 中,此金鑰稱為 ModuleToProcess。 您可以使用 RootModule 參數名稱或其 ModuleToProcess 別名。
Type: | String |
Aliases: | ModuleToProcess |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScriptsToProcess
指定文稿 (.ps1
) 在匯入模組時,在呼叫端的會話狀態中執行的檔案。
您可以使用這些指令碼來準備環境,就像您使用登入指令碼一般。
如果要指定在模組工作階段狀態中執行的指令碼,請使用 NestedModules 索引鍵。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tags
指定標記的陣列。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TypesToProcess
指定匯入模組時所執行之類型檔案 (.ps1xml
) 。
當您匯入模組時,PowerShell 會使用指定的檔案執行 Update-TypeData
Cmdlet。
因為類型檔案未限定範圍,所以會影響會話中的所有會話狀態。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VariablesToExport
指定模組匯出的變數。 允許使用萬用字元。
您可以使用此參數來限制模組匯出的變數。 它可以從導出的變數清單中移除變數,但無法將變數新增至清單中。
如果您省略此參數,New-ModuleManifest
請建立值為 (所有) 的 *
VariablesToExport 索引鍵,這表示模組中定義的所有變數都會由指令清單匯出。
Type: | String[] |
Position: | Named |
Default value: | * (all) |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-WhatIf
顯示執行時 New-ModuleManifest
會發生什麼情況。 不會執行此 Cmdlet。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
輸入
None
您無法使用管線將輸入傳送至此 Cmdlet。
輸出
None or System.String
根據預設, New-ModuleManifest
不會產生任何輸出。 不過,如果您使用 PassThru 參數,它會產生代表模組指令清單的 System.String 物件。
備註
New-ModuleManifest
會建立模組指令清單 (.psd1
) 編碼為 UTF16 的檔案。
模組資訊清單通常為選擇性。 不過,需要模組資訊清單才能匯出安裝在全域組件快取中的組件。
若要在目錄中新增或變更檔案 $pshome\Modules
,請使用 [ 以系統管理員身分執行 ] 選項啟動 PowerShell。
在 PowerShell 2.0 中,許多 的參數都是必要參數 New-ModuleManifest
,即使模組指令清單中不需要參數也一樣。 從 PowerShell 3.0 開始,只有 Path 參數是必要的。
會話是PowerShell執行環境的實例。 工作階段可以有一或多個工作階段狀態。 依預設,工作階段只有全域工作階段狀態,但每個匯入的模組有自己的工作階段狀態。 工作階段狀態允許執行模組中的命令,而不會影響全域工作階段狀態。
呼叫端的工作階段狀態是模組匯入的工作階段狀態。 一般而言,它會參考全域會話狀態,但是當模組匯入巢狀模組時,呼叫端是模組,而呼叫端的會話狀態則是模組的會話狀態。