共用方式為


PowerShell 檔體驗的更新

這篇文章是由 Azure Growth and Ecosystem 小組總經理 Jeff Sandquist Jeff Sandquist 所撰寫。

今天,我們已針對 docs.microsoft.com 推出已改造的 Azure PowerShell 體驗。 此體驗的改善包括模組版本控制、程式代碼語法醒目提示、更容易瀏覽的目錄、編輯和改善檔的能力等等。 我們從客戶的意見反應中得知PowerShell內容是改進的領域,這是我們改善內容品質的下一步。 我們已開始使用 Azure,但將會在未來幾個月內將所有 PowerShell 內容移至此體驗。

整合 PowerShell 模組參考

PowerShell 模組參考文件的目標是為所有Microsoft隨附的 PowerShell 模組提供統一的體驗。 這包括:

  • 一致的 URL 模式 - 如果您知道模組或 Cmdlet 的名稱,您就會知道 URL。 我們在 Docs 上使用的 URL 模式為:docs.microsoft.com/powershell/module/{module-name}/{cmdlet-name}/。 針對位於 AzureRM.Storage 模組中的 Get-AzureRMStorageAccount Cmdlet,URL 會是:/powershell/module/azurerm.storage/get-azurermstorageaccount
  • 一致的用戶體驗 - 模組、Cmdlet 和範例的格式設定現在與整個 PowerShell 檔體驗相同。
  • 簡單貢獻 - PowerShell 使用者可以直接按下檔頁面上的 [編輯] 按鈕,來新增程式碼範例或編輯參考檔。
  • 支援舊版 PowerShell 版本設定 - 若要篩選特定版本的 Azure PowerShell,請使用我們的頁面內版本選擇器。

PowerShell 版本控制

雖然我們提到特定模組的版本設定,但某些模組會以一組其他模組的形式提供,每個模組都有自己的版本控制配置。 例如,客戶透過 PowerShellGet下載 Azure PowerShell。 過去客戶必須手動解密適用於其安裝的檔版本。 例如,如果您已安裝 Azure PowerShell 3.7,則必須知道 AzureRM 3.7 隨附於 AzureRM.Automation 2.7 和 AzureRM.CognitiveServices v0.5.0 的每個個別模組,並尋找這些檔。

有了新的體驗,您只需要挑選一個版本,我們會根據您安裝的模組來篩選正確的模組。

Azure 瀏覽器視窗Microsoft螢幕快照,其中顯示 [版本控制] 下拉式清單以選取 Power Shell 版本。

改良的目錄

除了 Cmdlet 參考之外,我們還新增了概觀內容、安裝步驟、用戶入門和範例。 針對 Azure 參考,我們也根據 Azure 服務將 Cmdlet 分組。

Azure 瀏覽器視窗Microsoft螢幕快照,其中顯示目錄和篩選欄位。

在輸入時輕鬆篩選 - 從目錄

當您輸入符合該名稱的 Cmdlet 或服務時,可以輕鬆地篩選左側 TOC。

Azure 瀏覽器視窗Microsoft動畫 GIF,其顯示使用者在篩選欄位中輸入來篩選 T O C。

Cmdlet 頁面改善

改善色彩設定和格式設定

PowerShell Cmdlet 現在已正確著色並格式化,以提升可讀性。

Power Shell 命令 let 的螢幕快照,其中顯示新的色彩配置和格式化系統。

參數改善

雖然我們先前將參數分組為必要或選擇性,但參數清單似乎未排序。 相反地,我們新增了區段標題,以將必要的參數和選擇性參數分組,並改善參數名稱的著色/樣式。

Azure 文章中精選的參數清單螢幕快照、列出區段標題,以及顯示新的色彩配置。

更聰明的複製/貼上行為

我們的許多 PowerShell Cmdlet 程式代碼範例前面會加上文字 PS C:\>。 當您按下程式代碼範例的 [複製] 按鈕時,我們現在會移除 PS C:\> 前置詞,如下方記事本螢幕快照所示。

Power Shell 命令 let 和 [記事本] 視窗的螢幕快照,其中顯示使用者可以從命令 let 複製並貼到 [記事本]。

您的意見反應

我們希望您看到此版本的大幅改善。