共用方式為


影響 PowerShell 資源庫 UI 的封裝中繼資料值

本文說明 PowerShell 資源庫如何使用套件中的中繼資料。 對於模組,中繼資料會儲存在模組資訊清單中。 對於指令碼,中繼資料會使用註解型關鍵字來儲存。 下列 Cmdlet 可用來建立或更新此中繼資料:

下列清單顯示由模組資訊清單控制的 PowerShell 資源庫套件頁面 UI 元素。

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

  • 版本 - 顯示的版本是中繼資料中的版本字串,如果已指定,則為發行前版本標籤。 指定的發行前版本字串會附加至 ModuleVersion。 如需模組中發行前版本字串的相關資訊,請參閱 發行前版本模組版本

  • 描述 - 這是模組資訊清單中的 描述

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

  • 發行說明 — 此資訊來自 ReleaseNotes 區段的 PSData\PrivateData

  • 擁有者 - 擁有者是 PowerShell 資源庫中可以更新套件的使用者清單。 擁有者清單不包含在套件資訊清單中。 其他文件說明如何 管理項目擁有者

  • 作者 — 這包含在模組資訊清單中作為 作者。 「作者」欄位通常用來指定與封裝相關聯的公司或組織。

  • 版權 — 這是模組資訊清單中的 版權 欄位。

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

  • 標籤 - 標籤 包含在模組資訊清單下 PrivateData\PSData 。 標籤具有特定的需求和意義,如 標籤詳細資料 一節所述。

  • Cmdlet - 這是使用 CmdletsToExport 在模組資訊清單中提供。 最佳做法是明確列出 Cmdlet 名稱,而不是使用萬用字元 *。 具有清單可增進載入模組效能。

  • 函式 - 這是使用 FunctionsToExport 在模組資訊清單中提供的。 最佳做法是明確列出 Cmdlet 名稱,而不是使用萬用字元 *。 具有清單可增進載入模組效能。

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

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

  • PowerShell 版本 - 針對針對 PowerShell 5.0 和更低版本設計的模組,這是使用 標籤來控制。 對於桌面,請使用標籤PSEdition_Desktop,對於核心,請使用標籤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 中繼資料註解區塊中的關鍵字。 發佈發行前版本指令碼時,請將發行前版本字串附加至版本。 如需在模組中指定發行前版本字串的相關資訊,請參閱 指令碼的發行前版本

  • 說明 - 此資訊來自 .DESCRIPTION 指令碼檔案註解型說明中的關鍵字。

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

  • 版本資訊 - 此資訊來自 .RELEASENOTES 指令碼檔案註解型中繼資料中的關鍵字。

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

  • 作者 — 此資訊來自 .AUTHOR 指令碼檔案註解型中繼資料中的關鍵字。 「作者」欄位通常用來指定與封裝相關聯的公司或組織。

  • 版權 - 此資訊來自 .COPYRIGHT 指令碼檔案註解型中繼資料中的關鍵字。

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

  • 標籤 - *此資訊來自 .TAGS 指令碼檔案的註解型中繼資料中的關鍵字。 標籤具有特定的需求和意義,如 標籤詳細資料 一節所述。

  • PowerShell 版本 - 針對針對 PowerShell 5.0 和更低版本設計的模組,這是使用 標籤來控制。 對於桌面,請使用標籤PSEdition_Desktop,對於核心,請使用標籤PSEdition_Core。 針對針對 PowerShell 5.1 和更新版本設計的模組,資訊清單中有 CompatiblePSEditions 索引鍵。 如需詳細資訊,請參閱 模組的 PSEdition 支援

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

  • 專案網站 - 此資訊來自 .PROJECTURI 腳本檔案註解型中繼資料中的關鍵字。

  • 授權 — 此資訊來自 .LICENSEURI 指令碼檔案註解型中繼資料中的關鍵字。

    這很重要

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

  • Icon - 此資訊來自 .ICONURI 指令碼檔案註解型中繼資料中的關鍵字。 URI 應該指向具有透明度背景的 85x85 影像。 URI 必須 是影像檔案的直接連結,而且 不得 移至 PowerShell 資源庫套件中的網頁或檔案。

編輯套件詳細資料

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

  • Title
  • Description
  • 總結
  • Icon URL (圖示 URL)
  • 專案首頁 URL
  • Authors
  • 著作權
  • Tags
  • 發布說明
  • 需要授權

您應該只在資源庫中編輯此資訊,以更正舊版模組所顯示的內容。 下載套件的使用者會看到中繼資料不符合 PowerShell 資源庫。 每當您變更資源庫中的資訊時,都應該發佈具有相同變更的新版本套件。

標籤詳細資料

標籤是取用者用來尋找套件的簡單字串。 當標籤在相關套件中一致使用時,標籤最有價值。 使用相同單字的變體,例如資料庫和資料庫或測試和測試,幾乎沒有什麼好處。 標籤是不區分大小寫的單字字串,不能包含空白。 如果您認為使用者會搜尋某個片語,請將其新增至套件說明中,以便在搜尋結果中找到它。 使用帕斯卡大小寫、連字號、底線或句點來提高可讀性。 請謹慎創建容易拼寫錯誤的長、複雜和不尋常的標籤。

PowerShell 資源庫和 PowerShellGet Cmdlet 對 和 PSEdition_DesktopPSEdition_Core 標籤具有特殊意義。 請參閱先前 PowerShell 版本的討論。

如前所述,當標籤是特定的,並且在許多套件中一致使用時,它們會提供最大的價值。 作為嘗試尋找要使用的最佳標籤的發行者,最簡單的方法是在 PowerShell 資源庫中搜尋您正在考慮的標籤。 理想情況下,傳回的套件會與您對該關鍵字的使用一致。

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

偏好標籤 替代方案和註釋
活動目錄 AD 目前不會自行使用
Appveyor(軟體)
Automation
AWS
Azure雲服務
AzureAD
AzureAutomation 自動化服務
AzureRm 主要用於 AzureRM 模組
備份
建造
聊天運營
顏色
設定
漸強建造 當您導出模塊時,Crescendo 會自動添加此標籤
資料庫 資料庫(複數)不太理想
工商管理學士
部署 部署的使用頻率稍低
DevOps
DNS
Docker
DSC DesiredStateConfiguration 不太理想,因為它太長了
DSC資源
DSCResourceKit
Excel
交換
防火牆
GIT
GitHub
吉特實驗室
Google
HTML
Hyper-V HyperV 作為標籤不太常見
IaaS
IIS
Json
Linux
Log 首選使用 Log 作為物件
森林伐木業 偏好使用記錄作為動作
MacOS
監測
MSI
網路 網絡類似,使用頻率較低
辦公室365 最好拼寫 Office。 O365 不太常用,儘管較短
套件管理
糾纏
Posh機器人
報告 報告是一回事
報告 舉報是一種行動,舉報是一種東西
資源管理器 「Arm」 是用來描述處理器群組,不應該用於 Azure Resource Manager
REST
安全性 防守不太精準
SharePoint
SQL
SQLServer
儲存體
Test 測試不太理想
版本控制 版本不太精確,儘管使用頻率更高
VSTS
窗戶
WinRM
WMI
壓縮檔