從傳統 CLI 遷移至 Azure Sphere CLI

如果您仍在使用 Azure Sphere 傳統 CLI，建議您移轉至 新的 Azure Sphere CLI。 目前這兩個 CLI 版本都可以並排安裝及使用，但不會再更新或維護傳統 CLI，而且會在未來的日期 (不在 2022 年底之前) 從 SDK 移除。 我們鼓勵您在 2022 年底之前熟悉這些差異，並移轉您的程式和腳本，以避免中斷。

若要更新至最新的 SDK，請參閱在 Linux 上安裝 Azure Sphere SDK 或安裝適用於 Windows 的 Azure Sphere SDK。

若要在 Windows 上使用 Azure Sphere CLI，請使用 PowerShell 或標準 Windows 命令提示字元。 對於 Linux，可使用任何命令殼層。 如需詳細資訊，請參閱執行 Azure Sphere CLI。

在 Windows 上，淘汰的自訂 Azure Sphere 傳統開發人員命令提示字元 (可當做在 Azure Sphere 下的開始功能表的捷徑來使用)，只能與 Azure Sphere 傳統 CLI 搭配使用。 如需詳細資訊，請參閱執行 Azure Sphere 傳統 CLI。

主要差異

• 在 Azure Sphere 傳統 CLI 中，多個參數可用來識別每個物件類型。 在 Azure Sphere CLI 中，會使用單一參數來識別每個物件類型。 這表示您可以使用名稱或識別碼來指定參數值。 這已針對 、--tenant、 --product和 --device-group 參數實作--device。

  Object type	Azure Sphere CLI	Azure Sphere 傳統 CLI (淘汰中)
  裝置	--device	--deviceid、 --deviceip或 --devicelocation
  裝置群組	--device-group	--devicegroupid 或 --devicegroupname
  Products	--product	--productid 或 --productname
  租用戶	--tenant	--tenantid

• 傳統版本支援命令的簡短格式。 在 Azure Sphere CLI 中，我們建議您使用 Tab 鍵自動完成 或 互動式 功能來檢視可用的命令清單。 例如，在傳統 CLI 中，您可以使用 azsphere device enable-development 或 azsphere dev edv 命令，而在新的 Azure Sphere CLI 中，您可以使用自動完成快速輸入 azsphere device enable-development 命令。

• 某些命令允許單一參數的多個值。 在 Azure Sphere CLI 中，您可以提供單一參數，後面接著以空格分隔的值清單，在 Azure Sphere 傳統 CLI 中，值清單會以逗號分隔。 例如：

  • Azure Sphere CLI
  • Azure Sphere 傳統 CLI

  azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2
  

• 在新 CLI 中，建立租使用者時 不會自動選取預設租使用者。 您必須執行 azsphere tenant select 命令，以選取要用於計算機上目前使用者的預設租使用者。 這是為了確保在執行一次性作業時，預設租用戶是正確的租使用者，您無法復原，例如 宣告裝置。

  使用文稿時，您可以使用 參數選取預設租 --tenant <tenant ID or tenant name> 使用者。

  使用下列專案，在腳本開頭設定預設租使用者：

  azsphere tenant select --tenant <tenant ID or tenant name>
  

  您也可以覆寫預設租使用者，或在執行 命令時指定必要的租使用者。 例如：

  azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>
  

• 參數 --device-group 會識別裝置群組。 裝置群組標識碼提供 GUID，可唯一識別所有產品的裝置群組。 或者，您可以使用 product-name>/device-group-name 格式的<產品名稱和裝置組名組名><組。 這組名稱可唯一識別特定產品的裝置群組。

• 下列命令是傳統 CLI 中的複合命令。 這表示一個命令執行多個工作。 在新的 CLI 中，您需要執行兩個命令。

  • 在傳統 CLI 中， azsphere device-group deployment create 命令上傳映射套件並建立新的部署。

    在新的 CLI 中，您需要：

    1. 使用 azsphere image add 將映像套件上傳至您的 Azure Sphere 租使用者。
    2. 使用 azsphere device-group deployment create 為上傳的映射建立裝置群組的新部署。

  • 在傳統 CLI 中， azsphere device capability download --select 命令已下載並暫時選取連結裝置的裝置功能組態。

    在新的 CLI 中，您需要：

    1. 使用 azsphere device capability download 下載功能檔案。
    2. 使用 azsphere device capability select 選取功能。

  • 在傳統 CLI 中， azsphere device capability download --apply 命令已下載並套用連結裝置的裝置功能組態。

    在新的 CLI 中，您需要：

    1. 使用 azsphere device capability download 下載功能檔案。
    2. 使用 azsphere device capability update 來套用功能。

• 在傳統 CLI 中， -o 會使用 或 --output 參數來指定用來儲存盤案的路徑和檔名。 在新的 Azure Sphere CLI 中，會使用內容特定的參數，例如 --destination 指定 輸入和輸出路徑。

• 在傳統 CLI 中，-dazsphere device app start 命令會使用 或 --debug 參數，以偵錯模式啟動應用程式。 在新 Azure Sphere CLI 中， --debug-mode 參數會用來以偵錯模式啟動應用程式，並使用 --debug 參數作為全域參數，以增加記錄詳細資訊以顯示所有偵錯記錄。

• 在傳統 CLI 中，無法控制輸出格式。 在 Azure Sphere CLI 中 -o ，會使用 或 --output 參數來指定 用來格式化 CLI 輸出的輸出格式。

• 從 21.02 版開始，已從 Azure Sphere CLI 產品名稱中移除明確的版本號碼。 這項變更可消除參考不同產品版本的混淆。

  • Azure Sphere CLI v2 和更新版本現在稱為「Azure Sphere CLI」。
  • 舊版 Azure Sphere CLI 版本（CLI v1 和更低版本）現在稱為「Azure Sphere 傳統 CLI」。

• 如果您使用腳本，這些腳本可能無法與新的 Azure Sphere CLI 相容，因為上述差異。 針對文稿進行必要的更新，以在新 CLI 中正確執行。

另請參閱

• 開始使用 Azure Sphere CLI
• Azure Sphere 傳統 CLI (淘汰中)