Azure Sphere CLI 概觀
重要
這是 Azure Sphere （舊版） 檔。 Azure Sphere（舊版）將於 2027 年 9 月 27 日淘汰，且使用者此時必須移轉至 Azure Sphere（整合式）。 使用位於 TOC 上方的版本選取器來檢視 Azure Sphere （整合式） 檔。
Azure Sphere CLI 是一組用來管理 Azure Sphere 資源的命令。
下列命令可供使用：
- ca-certificate
- 裝置
- device-group
- 反饋
- get-support-data
- hardware-definition
- image
- image-package
- 互動式 （命令處於預覽狀態）
- 登錄
- 註銷
- product
- 角色
- show-user
- show-version
- setting
- tenant
注意
register-user 命令現在已被取代。
Azure Sphere CLI 和 Azure Sphere 傳統 CLI
Azure Sphere CLI 會與 Windows 和 Linux 上的現有 CLI 一起安裝，因此您可以存取任一介面。 Azure Sphere 傳統 CLI 會繼續如往常般運作。
若要使用 Azure Sphere CLI：
- 在 Windows 上，使用 PowerShell 或標準 Windows 命令提示字元。
- 在 Linux 上，使用任何命令殼層。 如果您在 SDK 安裝期間將 Azure Sphere CLI 設定為預設值，或 將 Azure Sphere 傳統 CLI 設定為預設值，請指定 azsphere 命令;如果您將 Azure Sphere 傳統 CLI 設定為預設值，請指定 azsphere_v2 命令。
如需 Azure Sphere CLI 所支援功能和命令的詳細資訊，請參閱 Azure Sphere CLI 。
重要
- 在 Windows 上，淘汰的 Azure Sphere 傳統開發人員命令提示字元 快捷方式只能與 Azure Sphere 傳統 CLI 搭配使用。
命令行格式
azsphere 命令行具有下列格式：
azsphere [command] [subcommand] operation [parameters]
一般而言， 命令 和 子命令 是名詞，而 作業 是動詞，因此組合會同時識別動作和動作的物件。 大部分的命令和作業都有完整名稱和縮寫。 例如， 裝置 命令縮寫為 d。
大部分 參數 都有長名稱與縮寫。 在命令行上，使用兩個連字元來介紹長名稱，以及使用單一連字元的縮寫。 例如，下列兩個命令相等：
azsphere device wifi add --ssid MyNetwork --psk mynetworkkey
azsphere device wifi add -s MyNetwork -p mynetworkkey
某些命令允許單一參數的多個值。 在 Azure Sphere CLI 中，您可以提供單一參數，後面接著以空格分隔的值清單，在 Azure Sphere 傳統 CLI 中，值清單會以逗號分隔。 例如：
azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2
引號和逸出字元
當您使用 Azure Sphere CLI 命令時，請注意殼層如何使用引號和逸出字元。 如果您支援在不同殼層中使用的腳本，您必須瞭解它們的差異。
例如：
- Bash： 引用
- PowerShell： 關於引用規則
- Windows 命令提示字元： 操作說明：Windows 命令行上的逸出字元、分隔符和引號
雲端相依命令
下列 azsphere 命令需要雲端連線並登入 Azure Sphere 安全性服務：
- ca-certificate
- device-group
- get-support-data
- image
- login
- 登出
- product
- 角色 (role)
- show-user
- tenant
此外，下列 azsphere device 命令也需要雲端連線：
| azsphere device 命令 | 註解 |
|---|---|
| capability | 需要 Azure Sphere 安全性服務以下載裝置功能 |
| 索賠 | |
| enable-cloud-test | |
| enable-development | |
| image | |
| 清單 | |
| recover | 需要因特網連線，但不需要登入 Azure Sphere 安全性服務 |
| show | |
| show-count | |
| show-deployment-status | |
| show-os-version | 需要因特網連線，但不需要登入 Azure Sphere 安全性服務 |
| update |
裝置功能相依命令
下列 azsphere device 命令需要 裝置功能 ，才能用於製造狀態 DeviceComplete 中的裝置：
| 作業 | 描述 |
|---|---|
| 應用程式 | 管理連結裝置上的應用程式。 |
| capability | 管理裝置功能設定。 功能更新的必要專案。 |
| 憑證 (certificate) | 管理裝置證書存儲。 |
| image | 管理裝置映像。 |
| manufacturing-state | 管理附加裝置的製造狀態。 製造狀態更新的必要專案。 |
| restart | 重新啟動連結的裝置。 |
| show-deployment-status | 顯示連結裝置上作業系統和應用程式的部署狀態。 |
| show-os-version | 在連接的裝置上顯示作業系統版本。 |
| sideload | 在連結的裝置上部署和管理應用程式。 側載部署和側載刪除的必要專案。 |
| wifi | 管理連結裝置的Wi-Fi組態。 |
如果您嘗試在沒有功能的情況下執行這些命令，您會收到錯誤訊息，告知您執行 azsphere device enable-development 或使用 azsphere device capability 下載並選取裝置的功能檔案。