影響 PowerShell 資源庫 UI 的封裝元數據值

  • 發行項

本文說明 PowerShell 資源庫 如何使用套件中的元數據。 對於模組，元數據會儲存在模組指令清單中。 針對腳本，元數據會使用批注型關鍵詞來儲存。 下列 Cmdlet 可用來建立或更新此元數據：

下列清單顯示模組指令清單所控制之 PowerShell 資源庫 套件頁面 UI 的元素。

  • 標題 - 發佈至資源庫的套件名稱。

  • Version - 顯示的版本是元數據中的版本字串，如果指定了發行前版本標籤，則為 。 指定的發行前版本字串會附加至 ModuleVersion。 如需模組中發行前版本字串的相關信息，請參閱 發行前版本模組版本。

  • 描述 - 這是模組指令清單中的 描述 。

  • 需要接受授權 - 模組可以藉由設定 RequireLicenseAcceptance = $true、提供 LicenseURI，以及在模組資料夾的根目錄中提供 license.txt 檔案，要求使用者接受授權。 如需詳細資訊，請參閱 要求接受授權。

  • 版本資訊 - 此資訊來自 下的 PSData\PrivateDataReleaseNotes 區段。

  • 擁有者 - 擁有者是可更新套件之 PowerShell 資源庫 中的使用者清單。 套件指令清單中不包含擁有者清單。 描述如何管理項目擁有者的其他文件。

  • 作者 - 這包含在模組指令清單中作為 作者。 [建立者] 欄位通常是用於指定與某個套件相關聯的公司或組織。

  • 著作權 - 這是模組指令清單中的 [著作權 ] 欄位。

  • FileList - 當套件發佈至 PowerShell 資源庫 時，就會建立檔案清單。 它無法由指令清單資訊控制。 PowerShell 資源庫 會.nuspec建立出現在每個封裝檔案清單中的檔案。 此檔案未隨系統上的套件一起安裝。 這是套件的 NuGet 套件指令清單，可以忽略。

  • 標籤 - 標籤 會包含在模組指令清單的底下 PrivateData\PSData 。 卷標具有特定需求和意義，如 標籤詳細 數據一節中所述。

  • Cmdlet - 這是使用 CmdletsToExport 在模組指令清單中提供。 最佳做法是明確列出 Cmdlet 名稱，而不是使用通配符 *。 擁有清單可改善載入模組的效能。

  • 函式 - 這會在使用 FunctionsToExport 的模組指令清單中提供。 最佳做法是明確列出 Cmdlet 名稱，而不是使用通配符 *。 擁有清單可改善載入模組的效能。

  • DSC 資源 - 這會在使用 DscResourcesToExport 的指令清單中提供。 只有 PowerShell 5.0 和更新版本中的模組才支援此值。

  • 角色功能 - 當模組有一或多個角色功能 (.psrc) 檔案時，就會列出角色。 JEA 會使用這些檔案。 如需詳細資訊，請參閱 角色功能。

  • PowerShell 版本 - 針對專為 PowerShell 5.0 和更低版本設計的模組，這是使用 標籤來控制。 針對 Desktop，請使用 PSEdition_Desktop 標籤；針對 Core，請使用 PSEdition_Core。 針對專為 PowerShell 5.1 和更新版本設計的模組，指令清單中有 CompatiblePSEditions 索引鍵。 如需詳細資訊，請參閱 模組的 PSEdition 支援。

  • 相依性 - 這會使用 RequiredModules 在指令清單中提供。

  • 最低 PowerShell 版本 - 這是使用 PowerShellVersion 在指令清單中提供。

  • 版本歷程記錄 - 顯示已發行至資源庫之模組的版本清單。 除非您是套件擁有者，否則使用 刪除 功能隱藏的套件不會顯示在版本歷程記錄中。

  • 項目網站 - 藉由指定 ProjectURI，為模組指令清單區段中的模組PrivateData\PSData提供項目網站。

  • 授權 - 藉由指定 LicenseURI，為模組指令清單區段中的模組PrivateData\PSData提供授權連結。

    重要

    如果未透過 LicenseURI 或套件內提供授權，則 PowerShell 資源庫 適用的使用條款適用於套件。 如需詳細資訊，請參閱 使用規定。

  • 圖示 - 藉由指定 IconURI，為模組指令清單區段中的模組PrivateData\PSData提供連結。 URI 應該指向具有透明度背景的 85x85 影像。 URI 必須是圖像檔案的直接連結，而且不得移至網頁或 PowerShell 資源庫 套件中的檔案。

下列清單顯示文本檔案中以批註為基礎的元數據所控制之 PowerShell 資源庫 套件頁面 UI 的元素。

  • 標題 - 這是發佈至資源庫的套件名稱

  • Version - 顯示的版本是元數據中的版本字串，如果指定了發行前版本標籤，則為 。 值來自 .VERSION 元數據批注區塊中的 關鍵詞。 發佈發行前版本文本時，請將發行前版本字串附加至版本。 如需在模組中指定發行前版本字串的相關信息，請參閱 腳本的發行前版本。

  • 描述 - 此資訊來自 .DESCRIPTION 文稿檔案之批注式說明中的 關鍵詞。

  • 需要接受授權 - 腳本不支援接受授權。 不過，指令碼相依於需要接受授權之模組的案例是受到支援的。 如需詳細資訊，請參閱 要求接受腳本的授權。

  • 版本資訊 - 此資訊來自 .RELEASENOTES 文稿檔案之批注型元數據中的 關鍵詞。

  • 擁有者 - 擁有者是可更新套件之 PowerShell 資源庫 中的使用者清單。 套件指令清單中不包含擁有者清單。 如需詳細資訊，請參閱 管理項目擁有者。

  • 作者 - 此資訊來自 .AUTHOR 文稿檔案之批注型元數據中的 關鍵詞。 [建立者] 欄位通常是用於指定與某個套件相關聯的公司或組織。

  • Copyright - 這項資訊來自 .COPYRIGHT 腳本檔案之批注型元數據中的 關鍵詞。

  • FileList - 當套件發佈至 PowerShell 資源庫 時，就會建立檔案清單。 它無法由指令清單資訊控制。 PowerShell 資源庫 會.nuspec建立出現在每個封裝檔案清單中的檔案。 此檔案未隨系統上的套件一起安裝。 這是套件的 NuGet 套件指令清單，可以忽略。

  • 標記 - *這項資訊來自 .TAGS 腳本檔案之批注型元數據中的 關鍵詞。 卷標具有特定需求和意義，如 標籤詳細 數據一節中所述。

  • PowerShell 版本 - 針對專為 PowerShell 5.0 和更低版本設計的模組，這是使用 標籤來控制。 針對 Desktop，請使用 PSEdition_Desktop 標籤；針對 Core，請使用 PSEdition_Core。 針對專為 PowerShell 5.1 和更新版本設計的模組，指令清單中有 CompatiblePSEditions 索引鍵。 如需詳細資訊，請參閱 模組的 PSEdition 支援。

  • 版本歷程記錄 - 顯示已發行至資源庫之模組的版本清單。 除非您是套件擁有者，否則使用 刪除 功能隱藏的套件不會顯示在版本歷程記錄中。

  • 項目網站 - 此資訊來自 .PROJECTURI 文稿檔案之批注型元數據中的 關鍵詞。

  • 授權 - 這項資訊來自 .LICENSEURI 文稿檔案之批注型元數據中的 關鍵詞。

    重要

    如果未透過 .LICENSEURI 或套件內提供授權，則 PowerShell 資源庫 適用的使用條款會套用至套件。 如需詳細資訊，請參閱 使用規定。

  • 圖示 - 此資訊來自 .ICONURI 文稿檔案之批註型元數據中的 關鍵詞。 URI 應該指向具有透明度背景的 85x85 影像。 URI 必須是圖像檔案的直接連結，而且不得移至網頁或 PowerShell 資源庫 套件中的檔案。

編輯套件詳細資料

PowerShell 資源庫 [編輯套件] 頁面可讓發行者變更針對套件顯示的數個欄位，特別是：

  • Title
  • 描述
  • 摘要
  • Icon URL (圖示 URL)
  • Project home page URL (專案首頁 URL)
  • Authors
  • 著作權
  • Tags
  • 版本資訊
  • Require license (需要授權)

您應該只編輯資源庫中的這項資訊，以更正舊版模組所顯示的內容。 下載套件的使用者會看到元數據不符合 PowerShell 資源庫。 每當您在資源庫中變更資訊時，都應該使用相同的變更來發佈新版本的套件。

標記詳細數據

標籤是取用者用來尋找套件的簡單字串。 卷標在相關套件之間一致地使用時，最有價值。 使用相同字組的變化，例如資料庫和資料庫或測試及測試，則提供一些好處。 卷標是單字不區分大小寫的字串，而且不能包含空白。 如果您認為使用者將搜尋的詞組，請將該詞新增至套件描述，以便在搜尋結果中找到。 使用 Pascal 大小寫、連字元、底線或句點來改善可讀性。 請小心建立容易拼錯的冗長、複雜且不尋常的標記。

PowerShell 資源庫 和 PowerShellGet Cmdlet 對於 和 PSEdition_Core 標記具有特殊意義PSEdition_Desktop。 請參閱 上述 PowerShell 版本的討論。

如先前所述，標籤會在特定時提供最大價值，並在許多套件之間一致地使用。 當發行者嘗試找出最合適的標籤時，最簡單的方法是在 PowerShell 資源庫搜尋您所考慮的標籤。 在理想情況下，傳回的套件會與您使用該關鍵詞一致。

下表顯示一些最常使用的標記。 慣用的標籤應該會傳回最佳搜尋結果。

偏好的標籤 替代選項和注意事項
ActiveDirectory AD 目前不會自行使用
Appveyor
自動化
AWS
Azure
AzureAD
AzureAutomation
AzureRm 主要用於 AzureRM 模組
備份
建置
ChatOps
雲端
色彩
設定
CrescendoBuilt 當您匯出模組時，Crescendo 會自動新增此標記
資料庫 不建議使用 Databases (複數)
DBA
部署 相較之下較少使用 Deploy
DevOps
DNS
Docker
DSC DesiredStateConfiguration 太長，因此不建議使用
DSCResource
DSCResourceKit
Excel
Exchange
防火牆
GIT
GitHub
Gitlab
Google
HTML
Hyper-V 通常不以 HyperV 作為標籤
IaaS
IIS
Json
Linux
Log 建議用於將「記錄」當成一個東西
記錄 建議用於將「記錄」當成一個動作
MacOS
監視
MSI
網路 Networking 為相似的字，但較少使用
Office365 建議拼為 Office。 雖然 O365 較簡短，但較少使用
PackageManagement
Pester
PoshBot
Report Report 是一個東西
報告 Reporting 是一個動作，Report 是一個東西
ResourceManager “Arm” 用來描述處理器群組，不應用於 Azure Resource Manager
REST
安全性 Defense 較不精確
SharePoint
SQL
SQLServer
儲存體
測試 不建議使用 Testing
VersionControl Version 較不精確，但使用的頻率較高
VSTS
Windows
WinRM
WMI
Zip