共用方式為


Update-ModuleManifest

更新模組指令清單檔案。

語法

All

Update-ModuleManifest
    [-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[]>]
    [-PrivateData <Hashtable>]
    [-Tags <String[]>]
    [-ProjectUri <Uri>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ReleaseNotes <String[]>]
    [-Prerelease <String>]
    [-HelpInfoUri <Uri>]
    [-PassThru]
    [-DefaultCommandPrefix <String>]
    [-ExternalModuleDependencies <String[]>]
    [-PackageManagementProviders <String[]>]
    [-RequireLicenseAcceptance]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Cmdlet 會 Update-ModuleManifest 更新模組指令清單 (.psd1) 檔案。

這是 Update-PSModuleManifest 中 Cmdlet 的 Proxy Cmdlet。 如需詳細資訊,請參閱 Update-PSModuleManifest

範例

範例 1:更新模組指令清單

此範例會更新現有的模組指令清單檔。 分割是用來將參數值傳遞至 Update-ModuleManifest。 如需詳細資訊,請參閱 about_Splatting

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params 是一個 Splat,可儲存 PathAuthorCompanyNameCopyright 的參數值。 Update-ModuleManifest 會從 @Params 取得參數值,並更新模組指令清單 TestManifest.psd1

參數

-AliasesToExport

指定模組導出的別名。 允許使用通配符。

使用此參數來限制模組所導出的別名。 AliasesToExport 可以從導出的別名清單中移除別名,但無法將別名新增至清單。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Author

指定模組作者。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ClrVersion

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

備註

此設定僅適用於 PowerShell Desktop 版本,例如 Windows PowerShell 5.1,且僅適用於低於 4.5 的 .NET Framework 版本。 這項需求對較新版本的PowerShell或 .NET Framework 沒有任何作用。

參數屬性

類型:Version
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CmdletsToExport

指定模組匯出的 cmdlet。 允許使用通配符。

使用此參數來限制模組所導出的 Cmdlet。 CmdletsToExport 可以從導出的 Cmdlet 清單中移除 Cmdlet,但無法將 Cmdlet 新增至清單。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CompanyName

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

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-CompatiblePSEditions

指定模組的相容 PSEditions。 如需 PSEdition 的相關信息,請參閱 模組與相容的 PowerShell 版本

參數屬性

類型:

String[]

預設值:None
接受的值:Desktop, Core
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

在執行 Update-ModuleManifest之前,提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:cf

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

指定模組的著作權聲明。

類型:String
預設值:None
支援萬用字元:False
不要顯示:False
(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DefaultCommandPrefix

指定預設命令前置詞。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Description

指定模組的描述。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DotNetFrameworkVersion

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

備註

此設定僅適用於 PowerShell Desktop 版本,例如 Windows PowerShell 5.1,且僅適用於低於 4.5 的 .NET Framework 版本。 這項需求對較新版本的PowerShell或 .NET Framework 沒有任何作用。

參數屬性

類型:Version
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-DscResourcesToExport

指定模組匯出的 Desired State Configuration (DSC) 資源。 允許使用通配符。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ExternalModuleDependencies

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-FileList

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-FormatsToProcess

指定匯入模組時執行的格式化檔案 (.ps1xml)。

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-FunctionsToExport

指定模組導出的函式。 允許使用通配符。

使用此參數來限制模組所導出的函式。 FunctionsToExport 可以從導出的別名清單中移除函式,但無法將函式新增至清單。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Guid

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

參數屬性

類型:Guid
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-HelpInfoUri

指定模組 HelpInfo XML 檔案的因特網位址。 輸入以 HTTPhttps開頭的統一資源識別碼 (URI)。

HelpInfo XML 檔案支援 PowerShell 3.0 版中引進的可更新說明功能。 其中包含模組可下載說明檔的位置,以及每個支援地區設定的最新說明檔版本號碼的相關信息。

如需取得可更新說明的相關資訊,請參閱 about_Updatable_Help。 如需 HelpInfo XML 檔案的相關信息,請參閱 支援可更新的說明

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-IconUri

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

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LicenseUri

指定模組的授權條款 URL。

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ModuleList

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

輸入每個模組名稱做為字串,或輸入具有 ModuleNameModuleVersion 索引鍵的哈希表。 哈希表也可以有可選的 GUID 鍵值。 您可以在參數值中結合字串和哈希表。

此金鑰的設計目的是作為模組庫存。 不會自動處理此索引鍵值中列出的模組。

參數屬性

類型:

Object[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ModuleVersion

指定模組的版本。

參數屬性

類型:Version
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-NestedModules

指定匯入模組會話狀態的腳本模組(.psm1)和二進位模組(.dll)。 NestedModules 中的檔案 索引鍵會依照值中所列的順序執行。

輸入每個模組名稱做為字串,或輸入具有 ModuleNameModuleVersion 索引鍵的哈希表。 哈希表也可以有可選的 GUID 鍵值。 您可以在參數值中結合字串和哈希表。

參數屬性

類型:

Object[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PackageManagementProviders

指定封裝管理提供者的陣列。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PassThru

傳回 代表您正在處理的項目的物件。 根據預設,Update-ModuleManifest 不會產生任何輸出。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Path

指定模組指令清單的路徑和檔名。 輸入延伸名為 .psd1 的路徑和檔案名,例如 $PSHOME\Modules\MyModule\MyModule.psd1

如果您指定現有檔案的路徑,除非檔案具有只讀屬性,否則 Update-ModuleManifest 取代檔案而不發出警告。

指令清單應該位於模組的目錄中,而指令清單檔名稱應該與模組目錄名稱相同,但擴展名為 .psd1

您無法使用 或 $PSHOME$HOME變數來回應 Path 參數值的提示。 若要使用變數,請在 命令中包含 Path 參數。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-PowerShellHostName

指定模組所需的 PowerShell 主機程式名稱。 輸入主機程序的名稱,例如 PowerShell ISE 主機或 ConsoleHost。 不允許通配符。

若要尋找主機程式的名稱,請在程式中輸入 $Host.Name

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PowerShellHostVersion

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

參數屬性

類型:Version
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PowerShellVersion

指定將搭配此課程模組使用的PowerShell最低版本。 例如,您可以將 3.0、4.0 或 5.0 指定為此參數的值。

參數屬性

類型:Version
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Prerelease

表示模組為發行前版本。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-PrivateData

指定匯入模組時傳遞給模組的數據。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ProcessorArchitecture

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

此參數可接受的值為:

  • Amd64
  • 手臂
  • IA64
  • MSIL
  • 沒有指定未知或未指定 )
  • X86

參數屬性

類型:ProcessorArchitecture
預設值:None
接受的值:None, MSIL, X86, IA64, Amd64, Arm
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ProjectUri

指定關於此項目的網頁 URL。

參數屬性

類型:Uri
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ReleaseNotes

指定字串陣列,其中包含您想要用於此腳本版本的版本資訊或批註。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RequiredAssemblies

指定模組所需的元件 (.dll) 檔案。 輸入元件檔名。 PowerShell 會先載入指定的元件,再更新類型或格式、匯入巢狀模組,或匯入 RootModule 索引鍵值中指定的模組檔案。

使用此參數指定模組所需的所有元件,包括必須載入的元件,以更新 FormatsToProcessTypesToProcess 索引鍵中列出的任何格式或類型檔案,即使這些元件也列為 NestedModules 索引鍵中的二進位模組。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RequiredModules

指定必須處於全域會話狀態的模組。 如果所需的模組不是處於全域會話狀態,PowerShell 會匯入它們。 如果無法使用所需的模組,Import-Module 命令會失敗。

參數屬性

類型:

Object[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RequireLicenseAcceptance

指定模組需要接受授權。

參數屬性

類型:SwitchParameter
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-RootModule

指定模組的主要或根檔案。 輸入文稿的檔名 (.ps1)、腳本模組 (.psm1)、模組指令清單 (.psd1)、元件 (.dll)、Cmdlet 定義 XML 檔案 (.cdxml), 或工作流程 (.xaml)。 匯入模組時,從根模組檔案導出的成員會匯入呼叫端的會話狀態。

如果模組具有指令清單檔,而且 RootModule 機碼中未指定任何根檔案,指令清單就會成為模組的主要檔案。 而且,模組會變成指令清單模組(ModuleType = Manifest)。

若要從具有指令清單的模組中 .psm1.dll 檔案匯出成員,這些檔案的名稱必須在指令清單中的 RootModuleNestedModules 索引鍵的值中指定。 否則其成員不會被匯出。

在 PowerShell 2.0 中,此金鑰稱為 ModuleToProcess

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-ScriptsToProcess

指定匯入模組時,在呼叫端工作階段狀態中執行的腳稿 (.ps1) 檔案。 您可以使用這些腳本來準備環境,就像您可能使用登入腳本一樣。

若要指定在模組會話狀態中執行的腳本,請使用 NestedModules 機碼。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Tags

指定一組標記的陣列。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-TypesToProcess

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

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-VariablesToExport

指定模組導出的變數。 允許使用通配符。

使用此參數來限制模組所導出的變數。 VariablesToExport 可以從導出的變數清單中移除變數,但無法將變數新增至清單。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

顯示當 Update-ModuleManifest 執行時會發生什麼事。 該 Cmdlet 未被執行。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:無線

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

String

輸出

Object