用 azd tool 管理Azure開發工具

Azure 開發者 CLI(azd)內建 azd tool 指令群組,用於發現、安裝、升級及檢查用於建置與發佈Azure應用程式的常用工具狀態。 它將每個平台上的底層套件管理器(如 winget、 brew、 apt、 npm及 VS Code code CLI)包裹在一組一致的子指令中,並支援互動式使用與自動化。

常見的使用情境 azd tool 包括:

  • 只需一個指令,就能在新電腦上安裝所有推薦的 Azure 開發工具。
  • 標準化團隊或一組 CI 代理的開發環境。
  • 審核某台機器安裝了哪些 Azure 工具(以及哪些版本)。
  • 檢查並套用已安裝工具的更新。
  • 在管線中設置腳本工具,使用非互動式旗標和 JSON 輸出。

內建工具

內建登錄檔包含以下工具。 利用分類欄和優先順序欄來判斷哪些工具適用於特定工作流程。

Id Name Category Priority 典型安裝策略
az-cli Azure CLI cli 建議使用 winget / brew / apt
github-copilot-cli GitHub Copilot 命令列界面 (CLI) cli 建議使用 winget / brew / npm
vscode-azure-tools Azure Tools (VS Code) extension 建議使用 code CLI(命令列介面)
vscode-bicep Bicep(VS Code) extension 建議使用 code CLI(命令列介面)
vscode-github-copilot GitHub Copilot(VS Code) extension Optional code CLI(命令列介面)
azure-mcp-server Azure MCP 伺服器 server Optional npm
azd-ai-extensions azd AI 擴充功能 library Optional azd extension

具體的安裝策略取決於作業系統及機器上可用的套件管理器。

備註

VS Code 擴充功能要求可在 code 上使用 PATH CLI。 如果 code 無法使用,這些工具會顯示為未安裝,而且你無法透過 azd tool 安裝它們。

命令概觀

azd tool指揮群組包含以下子指揮部。

命令 Description
azd tool 啟動互動式流程,顯示已安裝及可用工具,並提示工具安裝。
azd tool list 列出所有已註冊的工具,包括安裝狀態、版本、分類及優先權。
azd tool show <id> 顯示特定工具的詳細資訊,包括各平台的安裝策略及專案網站。
azd tool check 檢查已安裝的工具是否有可用的更新。
azd tool install [ids...] 透過 id 安裝一個或多個工具。
azd tool upgrade [ids...] 升級一個或多個已安裝的工具。
azd tool uninstall [ids...] 移除一個或多個工具。 省略 ids 互動式選擇工具。 支援大量移除, --dry-run且 --output json。

所有指令都支援 --output json,可提供適合指令碼與管線使用的機器可讀輸出。

對於工具技能,JSON 輸出會列出每位代理人的每項技能,並包含一個 agent 欄位。 例如:

{
  "skills": [
    {
      "id": "my-skill",
      "agent": "copilot"
    }
  ]
}

常見旗幟

以下旗幟可於 install 及 upgrade上取得:

  • --all:會安裝或升級所有符合條件的工具。 對於 install,此指令包含所有推薦的工具。 對於 upgrade,此指令包含所有已安裝且有更新可用的工具。

install這些 、 upgrade和 uninstall 指令支援--dry-run在不做更改的情況下預覽動作。

以下選項控制提示行為:

  • azd 當偵測到CI/CD或AI代理環境時,能自動以非互動模式運行。
  • --no-prompt明確抑制互動提示。
  • AZD_NON_INTERACTIVE=true明確抑制互動提示。
  • AZD_NON_INTERACTIVE=false: 明確地持續啟用提示,即使在偵測到的 CI/CD 或 AI 代理環境中。
  • 明確指定的 --no-prompt 和 AZD_NON_INTERACTIVE 值會覆寫環境自動偵測的結果。

範例使用案例:啟動開發機器

要在新電腦上設定完整的推薦 Azure 開發工具,請執行以下指令:

azd tool install --all

此指令會使用目前平台適用的套件管理器,安裝登錄中所有標記為 recommended 的工具。 若想預覽安裝操作而不做更改,請新增 --dry-run:

azd tool install --all --dry-run

為了保持已安裝工具的即時性,請執行以下指令:

azd tool check
azd tool upgrade --all

已安裝及可用工具列表

執行 azd tool list 以顯示所有已註冊的工具、安裝狀態及已安裝版本:

$ azd tool list

  Id                     Name                      Category    Priority      Status          Version
  ─────────────────────  ────────────────────────  ──────────  ────────────  ──────────────  ────────
  az-cli                 Azure CLI                 cli         recommended   Installed       2.67.0
  github-copilot-cli     GitHub Copilot CLI        cli         recommended   Not Installed
  vscode-azure-tools     Azure Tools (VS Code)     extension   recommended   Installed       0.9.0
  vscode-bicep           Bicep (VS Code)           extension   recommended   Installed       0.30.0
  vscode-github-copilot  GitHub Copilot (VS Code)  extension   optional      Not Installed
  azure-mcp-server       Azure MCP Server          server      optional      Not Installed
  azd-ai-extensions      azd AI Extensions         library     optional      Not Installed

要回傳與 JSON 相同的腳本資料,請執行:

azd tool list --output json

顯示工具的詳細資訊

執行 azd tool show <id> 以檢查特定工具,包括適用於各支援平台及專案網站的安裝策略:

azd tool show az-cli

安裝一個或多個工具

傳遞一個或多個工具 id 值以安裝特定工具:

azd tool install az-cli vscode-bicep

要安裝所有推薦的工具,請使用 --all:

azd tool install --all

若要預覽安裝指令而不執行,請新增 --dry-run:

azd tool install az-cli --dry-run

執行 azd tool 且不帶任何子指令時,會啟動互動式流程,顯示已安裝的工具、讓您選取其他工具,並在單一步驟中完成安裝。

請留意最新消息

Run azd tool check 掃描已安裝的工具是否有可用的更新:

azd tool check

升級工具

透過傳入各工具的 id 值來升級特定工具:

azd tool upgrade az-cli github-copilot-cli

升級所有有可用更新的設備:

azd tool upgrade --all

在不套用升級方案的情況下預覽:

azd tool upgrade --all --dry-run

卸載工具

透過傳遞工具 id 的值來移除一個或多個工具。

azd tool uninstall az-cli azure-mcp-server

預覽移除過程而不做更改:

azd tool uninstall vscode-bicep --dry-run

在沒有工具 ID 的情況下執行 azd tool uninstall ,可以互動式選擇工具。 要移除特定 AI 代理的技能,請使用 --agent。

azd tool uninstall my-skill --agent copilot

當你需要移除結果時,請在腳本或流程中加入 --output json 。

首次執行體驗

要發現並安裝推薦的 Azure 開發工具,請明確執行azd tool。 與先前版本不同,工作流程指令 azd init如 、 azd up、 azd deploy 不再觸發自動工具檢查提示。

在執行 azd tool 指令時,請使用以下任一選項跳過互動提示:

  • 將 --no-prompt 傳遞給該命令。
  • 設定環境變數 AZD_NON_INTERACTIVE=true。
  • 在偵測到的 CI/CD 或 AI 代理環境中執行。 azd 能自動跳過互動提示。

若要在偵測到的 CI/CD 或 AI 代理環境中持續啟用提示,請設定 AZD_NON_INTERACTIVE=false。 明確 --no-prompt 與 AZD_NON_INTERACTIVE 值會覆蓋自動偵測。

CI 與非互動情境

指令群組透過 azd tool 以下選項支援管線與腳本:

  • 使用 id 帶有 install、 upgrade、 的位置參數,以避免 uninstall 互動式選擇。
  • 新增 --no-prompt、設定 AZD_NON_INTERACTIVE=true,或在CI/CD或AI代理環境中依賴自動偵測來抑制提示。
  • 設定 AZD_NON_INTERACTIVE=false 在 CI/CD 或 AI 代理環境中選擇退出自動偵測並保持提示啟用。
  • 明確 --no-prompt 與 AZD_NON_INTERACTIVE 值會覆蓋自動偵測。
  • 用於 --output json 捕捉後續步驟的結構化結果。

以下範例會在管線步驟中安裝 Azure CLI 和 Bicep 擴充功能:

azd tool install az-cli vscode-bicep --no-prompt --output json