Update-PSModuleManifest

模組:

Microsoft.PowerShell.PSResourceGet

更新模組資訊清單檔案。

語法

Update-PSModuleManifest
      [-Path] <String>
      [-NestedModules <Object[]>]
      [-Guid <Guid>]
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RootModule <String>]
      [-ModuleVersion <Version>]
      [-Description <String>]
      [-ProcessorArchitecture <ProcessorArchitecture>]
      [-CompatiblePSEditions <String[]>]
      [-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[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-RequireLicenseAcceptance]
      [-PrivateData <Hashtable>]
      [<CommonParameters>]

Description

此 Cmdlet 會更新儲存在模組資訊清單檔中的資料。 參數可讓您指定更新的屬性。 Update-PSModuleManifest 覆寫模組資訊清單中的任何現有值。

Cmdlet 不會傳回 物件。

範例

範例 1

此範例會將模組資訊清單中的 Author 屬性變更為 New Author 。

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'

範例 2

本範例會將 發行前版本 屬性變更為 beta2 。

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'

範例 3

此範例會更新多個屬性。

$parameters = @{
    Path = 'C:\MyModules\TestModule'
    Tags = 'Windows', 'Linux'
    Description = 'A module for managing packages.'
}
Update-PSModuleManifest

參數

-AliasesToExport

指定模組匯出的別名。 允許使用萬用字元。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	True

-Author

指定模組作者。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ClrVersion

指定模組所需 Microsoft .NET Framework的最低版本 Common Language Runtime (CLR) 。

類型:	Version
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-CmdletsToExport

指定模組匯出的 Cmdlet。 允許使用萬用字元。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	True

-CompanyName

指定建立模組的公司或廠商。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-CompatiblePSEditions

指定模組的相容 PSEditions 。 如需 PSEdition的相關資訊，請參閱 具有相容 PowerShell 版本的模組。

類型:	String[]
接受的值:	Desktop, Core
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Copyright

指定模組的著作權聲明。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DefaultCommandPrefix

指定預設命令前置詞。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Description

指定模組的描述。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DotNetFrameworkVersion

指定模組所需的 Microsoft .NET Framework最低版本。

類型:	Version
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DscResourcesToExport

指定模組匯出Desired State Configuration (DSC) 資源。 允許使用萬用字元。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	True

-ExternalModuleDependencies

指定外部模組相依性的陣列。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FileList

指定模組中所包含的所有項目。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FormatsToProcess

指定匯入模組時所處理之格式化檔案 (.ps1xml) 。

當您匯入模組時，PowerShell 會使用指定的檔案執行 Update-FormatData Cmdlet。 由於格式設定檔案的範圍不相同，因此會影響會話中的所有會話狀態。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FunctionsToExport

指定模組匯出的函式。 允許使用萬用字元。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	True

-Guid

指定模組的唯一識別碼。 GUID可用來區分具有相同名稱的模組。

類型:	Guid
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-HelpInfoUri

指定模組 HelpInfo XML 檔案的網際網路位址。 輸入以 或 https: 開頭的統一資源識別項 (URI) http: 。

如需詳細資訊，請參閱 可更新的說明。

類型:	Uri
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-IconUri

指定模組圖示的 URI。 指定的圖示會顯示在模組的資源庫網頁上。

類型:	Uri
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-LicenseUri

指定模組授權條款的 URL。

類型:	Uri
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ModuleList

指定模組中包含的模組陣列。

以字串或 ModuleName 和 ModuleVersion 索引鍵輸入每個模組名稱作為雜湊表。 雜湊表也可以有選擇性 的 GUID 金鑰。 您可以在參數值中結合字串和雜湊表。

這個索引鍵被設計來做為模組詳細目錄。

類型:	Object[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ModuleVersion

指定模組的版本。

類型:	Version
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-NestedModules

指定 () 和二進位模組 .dll 的腳本模組 .psm1 ， () 匯入模組的會話狀態。 NestedModules機碼中的檔案會依列出的循序執行。

以字串或 ModuleName 和 ModuleVersion 索引鍵輸入每個模組名稱作為雜湊表。 雜湊表也可以有選擇性 的 GUID 金鑰。 您可以在參數值中結合字串和雜湊表。

類型:	Object[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Path

指定模組資訊清單的路徑和檔案名。 輸入副檔名為 .psd1 的檔案名。

類型:	String
Position:	0
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-PowerShellHostName

指定模組所需的 PowerShell 主機程式名稱。 輸入主機程式的名稱，例如 PowerShell ISE 主機或 ConsoleHost。 不允許萬用字元。

主機程式的名稱會儲存在 中 $Host.Name 。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PowerShellHostVersion

指定與模組搭配運作的 PowerShell 主機程式最低版本。 輸入版本號碼，例如 1.1。

類型:	Version
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PowerShellVersion

指定與本課程模組搭配運作的 PowerShell 最低版本。 例如，您可以指定 或 之類的 5.17.2 版本。

類型:	Version
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Prerelease

指定附加至模組版本的發行前版本值。 例如，如果 發行前版本 為 preview ，而 ModuleVersion 為 1.0.0 ，則模組的版本為 1.0.0-preview 。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-PrivateData

指定匯入模組時傳遞至模組的資料。 這可以是儲存在雜湊表中的任何任意值。

類型:	Hashtable
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ProcessorArchitecture

指定模組需要的處理器架構。

此參數可接受的值為：

• Amd64
• Arm
• IA64
• MSIL
• None (未知或未指定的)
• X86

類型:	ProcessorArchitecture
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ProjectUri

指定此專案相關網頁的 URI。

類型:	Uri
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ReleaseNotes

指定包含模組版本資訊或批註的字串。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-RequiredAssemblies

指定模組所需的元件 (.dll) 檔案。 PowerShell 會先載入指定的元件，再更新類型或格式、匯入巢狀模組，或匯入 RootModule 金鑰中指定的模組檔案。

針對必須載入的元件使用 RequiredAssemblies 來更新 FormatsToProcess 或 TypesToProcess 機碼中列出的任何格式或類型檔案，即使這些元件也會列在 NestedModules 索引鍵中。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-RequiredModules

指定必須在全域工作階段狀態的模組。 如果必要的模組不在全域會話狀態，PowerShell 會匯入這些模組。 如果無法使用所需的模組，命令就會 Import-Module 失敗。

此值可以是包含模組名稱或模組規格的陣列。 模組規格是具有下列索引鍵的雜湊表。

• ModuleName - 必填 指定模組名稱。
• GUID - 選 指定模組的 GUID。
• 另外，至少需要指定下列三個索引鍵的其中一個。
  • ModuleVersion - 指定模組的最低可接受版本。
  • MaximumVersion - 指定模組可接受的最大版本。
  • RequiredVersion - 指定模組的確切必要版本。 這無法與其他版本金鑰搭配使用。

類型:	Object[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-RequireLicenseAcceptance

指定模組需要接受授權。

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-RootModule

指定模組的主要或根檔案。 輸入腳本 () .ps1 的檔案名、腳本模組 () 、模組資訊清單 .psd1 (.psm1) 、元件 .dll () ，或 Cmdlet 定義 XML 檔案 () .cdxml 。 匯入模組時，從根模組匯出的成員會匯入呼叫端的會話狀態。

如果模組有資訊清單檔，而且 RootModule 機碼中未指定任何檔案，資訊清單就會成為模組的主要檔案。 模組稱為資訊清單模組 (ModuleType = Manifest) 。

若要從 .psm1 或 .dll 檔案匯出成員，這些檔案的名稱必須在資訊清單中 RootModule 或 NestedModules 索引鍵的值中指定。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-ScriptsToProcess

指定腳本 (.ps1) 在匯入模組時，在呼叫端的會話狀態中執行的檔案。 您可以使用這些指令碼來準備環境，就像您使用登入指令碼一般。

如果要指定在模組工作階段狀態中執行的指令碼，請使用 NestedModules 索引鍵。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-Tags

指定標記的陣列。

類型:	String[]
別名:	Tag
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-TypesToProcess

指定匯入模組時所執行之類型檔案 (.ps1xml) 。

當您匯入模組時，PowerShell 會使用指定的檔案執行 Update-TypeData Cmdlet。 因為類型檔案未限定範圍，所以會影響會話中的所有會話狀態。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-VariablesToExport

指定模組匯出的變數。 允許使用萬用字元。

使用此參數來限制模組所匯出的變數。

類型:	String[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	True

輸入

None

輸出

Object

備註

如需模組資訊清單檔的完整描述，請參閱 about_Module_Manifests。

相關連結

• New-ModuleManifest