device
重要
這是 Azure Sphere (舊版) 檔。 Azure Sphere(舊版)將於 2027 年 9 月 27 日淘汰,且使用者此時必須移轉至 Azure Sphere(整合式)。 使用位於 TOC 上方的版本選取器來檢視 Azure Sphere (整合式) 檔。
管理 Azure Sphere 裝置。
作業 | 描述 |
---|---|
app | 變更裝置上應用程式的狀態。 |
capability | 管理裝置功能。 |
憑證 | 管理裝置證書存儲。 |
索賠 | 向 Azure Sphere 租使用者宣告先前未認領的裝置。 |
enable-cloud-test | 設定裝置以停用偵錯並接收更新。 |
enable-development | 設定裝置以進行本機偵錯。 |
image | 管理裝置的映像。 |
清單 | 顯示租使用者中的所有裝置。 |
list-attached | 列出連結的裝置。 |
manufacturing-state | 管理連結裝置的製造狀態。 |
網路 | 提供裝置上網路介面狀態的相關信息。 |
recover | 使用特殊恢復模式將新的韌體載入裝置上。 |
重新掃描附加 | 將連結的裝置重新掃描為疑難解答輔助功能(僅限 Windows)。 |
restart | 重新啟動連結的裝置。 |
show | 顯示裝置更新設定的詳細數據。 |
show-attached | 顯示來自裝置本身之連結裝置的詳細數據。 |
show-count | 顯示租使用者中的裝置總數。 |
show-deployment-status | 顯示最新部署更新的狀態。 |
show-os-version | 顯示本機裝置操作系統版本。 |
sideload | 將映像載入連結的裝置上。 |
update | 將裝置放在特定裝置群組中,以更新裝置。 |
wifi | 管理裝置的Wi-Fi組態。 |
應用程式
管理裝置上的應用程式。
許多應用程式選項都需要 appDevelopment 功能,您可以使用 azsphere device enable-development 來取得此功能。 若要啟動、停止或偵錯 SDK 簽署的應用程式或生產簽署的應用程式,裝置必須具備 appDevelopment 功能。
您可以使用 azsphere device app stop 和 azsphere device app start 來重新啟動執行中即時可用的應用程式,以判斷其執行所在的即時核心。
作業 | 描述 |
---|---|
show-memory-stats | 顯示連結裝置上應用程式的記憶體統計數據。 |
show-quota | 顯示裝置上目前應用程式所使用的記憶體數量。 |
show-status | 傳回裝置上目前應用程式的狀態。 |
start | 啟動在裝置上載入的應用程式。 |
停止 | 停止在裝置上執行的應用程式。 |
app show-memory-stats
顯示連結裝置上應用程式的記憶體統計數據。 只有在已設定 appDevelopment 裝置功能時,才能使用此命令。 如果 已設定堆積記憶體配置追蹤 ,則會顯示其他資訊。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device app show-memory-stats
-------------- -------------
Name Usage (bytes)
============================
Total 434176
User Mode 147456
Peak User Mode 147456
-------------- -------------
app show-quota
顯示已連結裝置上配置和使用中的可變記憶體數量。
您可以在應用程式指令清單中設定可變動的記憶體配額,而 Azure Sphere OS 會在為檔案配置扇區時強制執行配額。 因此,如果您減少 MutableStorage
值,使用中的記憶體數量將不會變更,但回報的配置值會不同。 例如,如果應用程式已經使用 16 KB,而您將值變更 MutableStorage
為 8 KB,則命令會報告應用程式使用 16 KB 的 8 KB 配置。 數據會保留在裝置上。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-i, --component-id | GUID | 指定要取得配額資訊的元件標識碼。 如果省略,會顯示所有元件的配額資訊。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device app show-quota
ae4714aa-03aa-492b-9663-962f966a9cc3: 0KB out of 8KB of mutable storage used.
app show-status
顯示裝置上應用程式的目前狀態。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-i, --component-id | GUID | 指定要顯示狀態之元件的識別碼。 如果省略,則會顯示所有元件的狀態。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device app show-status
9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
App state: running
應用程式啟動
啟動裝置上的應用程式。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
--debug-mode | 布林值 | 啟動應用程式以進行偵錯。 --component-id 必須提供 。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-i, --component-id | GUID | 指定要啟動之元件的識別碼。 如果省略,請啟動所有應用程式。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device app start
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: running
Core : High-level
應用程式停止
停止裝置上的應用程式。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-i, --component-id | GUID | 指定要停止的元件標識碼。 如果省略,則會停止所有應用程式。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device app stop
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: stopped
capability
管理裝置功能。 裝置功能會決定可在個別 Azure Sphere 裝置上執行的作業。
裝置功能會使用 azsphere device capability download 命令,從 Azure Sphere 安全性服務下載為檔案。 您可以使用 azsphere device capability update 命令,將裝置功能設定套用至連結的 Azure Sphere 裝置,而且您可以使用 azsphere device capability select 命令建立服務會話。 如需裝置功能的詳細資訊,請參閱 裝置功能和通訊。
作業 | 描述 |
---|---|
下載 | 從 Azure Sphere 安全性服務下載裝置功能設定。 |
select | 選取要用於維護會話的已下載功能檔案。 |
show-attached | 顯示連結裝置的功能組態。 |
update | 將裝置功能設定套用至連結的裝置。 |
功能下載
從 Azure Sphere 安全性服務下載裝置功能。
appDevelopment 功能可讓您側載 SDK 簽署的應用程式,並在裝置上啟動、停止、偵錯或刪除任何應用程式。 如果沒有 appDevelopment 功能,只能載入雲端載入的應用程式,並禁止啟動、停止、偵錯和刪除。 appDevelopment 功能會套用為 azsphere device enable-development 命令的一部分。
下載 fieldServicing 功能會產生包含單一 Azure Sphere 裝置功能的檔案。 fieldServicing 功能檔案會下載到本機計算機,並可搭配 azsphere device capability select 命令使用。
必要參數
參數 | 類型 | 描述 |
---|---|---|
--type | Capability-type | 指定要下載的裝置功能類型。 值為 appDevelopment、fieldServicing 或 none。 使用 none 來移除 appDevelopment 功能或 fieldServicing 功能。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
--目的地 | String | 指定要儲存功能組態的路徑和檔名。 包含絕對或相對路徑。 如果您沒有提供路徑,命令會使用裝置ID.cap的命名慣例<功能類型><前八個字元,將檔案儲存在本機目錄中。> |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device capability download --type appDevelopment
The appdevelopment capability was saved as:
--------------------------------------------
Result
============================================
C:\capability-file\appdevelopment-<first eight characters of device ID>.cap
--------------------------------------------
功能選取
選取要與連結的 Azure Sphere 裝置搭配使用的功能檔案。
azsphere device capability select 命令可以搭配任何功能使用,但最常與 fieldServicing 功能搭配使用,以啟用服務會話。 任何使用者角色都有權存取 azsphere device capability select 命令。
當您使用 fieldServicing 功能時,Azure Sphere 裝置與包含功能檔案的本機電腦之間會啟用通訊。 fieldServicing 功能檔案會用於本機電腦與 Azure Sphere 裝置之間的會話,而會話中的每個命令前面會加上指出使用中功能檔案的訊息。
若要結束服務會話,請使用 azsphere device capability select --none。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
--capability-file | String | 指定要選取之裝置功能組態檔的路徑和檔名。 您可以提供相對或絕對路徑。 |
-n, --none | - | 清除任何先前選取的裝置功能設定。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device capability select --capability-file appdevcap
The capability session uses C:\capability-file\appdevcap.
功能顯示附加功能
顯示儲存在連結裝置上的功能組態。
注意
此命令會顯示使用功能檔設定的功能,以及面板上默認呈現的某些功能,但並非全部的功能。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device capability show-attached
--------------------
DeviceCapabilities
====================
EnableFieldServicing
--------------------
azsphere device capability show-attached
--------------------
DeviceCapabilities
====================
EnableAppDevelopment
--------------------
功能更新
將裝置功能設定套用至連結的裝置。
必要參數
參數 | 類型 | 描述 |
---|---|---|
--capability-file | String | 指定要套用之裝置功能檔案的路徑和檔名。 您可以提供相對或絕對路徑。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device capability update --capability-file appdevcap.bin
Using selected capability file: C:\capability-file\appdevcap.bin
The capability file C:\capability-file\appdevcap.bin was added on the device. The device will restart.
憑證 (certificate)
管理連結裝置上的憑證。
作業 | 描述 |
---|---|
add | 將憑證新增至連結裝置上的證書存儲。 |
delete | 從連結裝置的證書存儲中刪除憑證。 |
清單 | 列出連結裝置證書存儲中可用的憑證標識碼。 |
show | 顯示附加裝置證書存儲中憑證的詳細數據。 |
show-quota | 顯示連結裝置證書存儲中的可用可用空間。 |
憑證新增
將憑證新增至連結裝置的證書存儲。
根 CA 和用戶端憑證必須是 .pem 格式,才能載入 Azure Sphere 裝置。 您必須從適當的伺服器取得根 CA 憑證,以及裝置的用戶端憑證和私鑰(以及選擇性地為私鑰的密碼)。 每個憑證都必須由EAP-TLS網路中的適當伺服器產生並簽署。 您的網路管理員或安全性小組可以提供取得憑證所需的詳細數據。 如需取得根 CA 憑證的詳細資訊,請參閱 取得和部署 EAP-TLS 網路的憑證。
警告
因為憑證標識碼是用戶端和根 CA 憑證的系統範圍, 因此 azsphere 命令或新增憑證的函式呼叫可以覆寫先前命令或函數調用所新增的憑證,可能會導致網路連線失敗。 強烈建議您開發明確的憑證更新程式,並仔細選擇憑證標識碼。
如需詳細資訊,請參閱 憑證標識符 。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-i, --cert-id | String | 指定要新增之憑證的標識碼。 字串標識碼(最多 16 個字元)。 有效字元包括大寫字母(A-Z)、小寫字母(a-z)、數位(0-9)、底線(_)、句號(.)和連字元(-)。 此標識碼也會用於 EAP-TLS 網路的 Wi-Fi 設定中。 |
--cert-type | String | 指定要新增的憑證類型,無論是客戶端還是rootca。 |
-p, --public-key-file | String | 指定公鑰憑證 .pem 檔案的路徑。 您可以提供相對或絕對路徑。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
--private-key-file | String | 指定客戶端私鑰憑證 .pem 檔案的路徑。 新增用戶端類型的憑證時為必要專案。 您可以提供相對或絕對路徑。 |
-w, --private-key-password | String | 指定客戶端私密的選擇性密碼。 新增加密的用戶端憑證私鑰時,需要密碼。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device certificate add --cert-id certroot --cert-type rootca --public-key-file publiccert.pem
Certificate 'certroot' successfully added.
azsphere device certificate add --cert-id certclient --cert-type client --private-key-file privatekey.pem --private-key-password 1234 --public-key-file publiccert.pem
Certificate 'certclient' successfully added.
憑證刪除
從連結裝置的證書存儲中刪除憑證。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-c、 --certificate 或 --cert-id [淘汰] |
String | 指定要刪除之憑證的標識碼。 自 --cert-id 變數將會淘汰,並將在未來版本中移除。 如需詳細資訊,請參閱 Azure Sphere CLI 中的重要變更(淘汰功能)。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device certificate delete --certificate certclient
憑證清單
列出裝置證書存儲中可用的憑證。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device certificate list
-----------
Identifiers
===========
rootCert
-----------
憑證顯示
顯示裝置證書存儲中個別憑證的詳細數據。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-c、 --certificate 或 --cert-id [淘汰] |
String | 指定要顯示詳細數據的憑證標識碼。 自 --cert-id 變數將會淘汰,並將在未來版本中移除。 如需詳細資訊,請參閱 Azure Sphere CLI 中的重要變更(淘汰功能)。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device certificate show --certificate certclient
---------- ------------------- ------------------- ----------------------------------- -----------------------------------
Id StartDate EndDate SubjectName IssuerName
==========================================================================================================================
certclient 06/08/2019 19:15:48 06/08/2069 19:25:44 /DC=local/DC=azsphere/CN=azsphereca /DC=local/DC=azsphere/CN=azsphereca
---------- ------------------- ------------------- ----------------------------------- -----------------------------------
憑證 show-quota
顯示連結裝置證書存儲中的可用可用空間。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device certificate show-quota
--------------
Available space (bytes)
==============
24514
--------------
宣告
針對目前 Azure Sphere 租使用者宣告先前未認領的裝置。
重要
在宣告裝置之前,請確定您已登入正確的 Azure Sphere 租使用者。 裝置只能宣告一次。 一旦宣告,就無法將裝置移至不同的租使用者。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
--force | 布林值 | 強制在目前用戶選取的 Azure Sphere 租使用者中宣告裝置。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device claim
warn: You are claiming a device to the following tenant:
warn: a323c263-2aa3-2559-aabb-a3fc32631900 (Tenant1)
warn: Do you want to claim the device ID 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968 to this tenant?
warn: You cannot change the Azure Sphere tenant this device is claimed to once this action has completed.
Enter 'yes' to continue. Enter anything else to exit.
> yes
Claiming device.
Successfully claimed device ID '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968' into tenant 'Tenant1' with ID 'a323c263-2aa3-2559-aabb-a3fc32631900'.
enable-cloud-test
藉由停用應用程式開發、刪除任何現有的應用程式,以及啟用雲端載入的應用程式更新,來讀取連結的裝置以測試雲端載入。
它需要將裝置連接至電腦,並只在連接的裝置上運作。
具體而言, enable-cloud-test:
- 拿掉連結裝置的appDevelopment功能。
- 將裝置指派給可啟用雲端載入應用程式更新的裝置群組。
- 重新啟動裝置。
啟用雲端測試的特定工作會根據是否已為此裝置指派產品和裝置群組而執行。
如果 azsphere device enable-cloud-test 在沒有參數的情況下執行,裝置會放在裝置目前產品的 Field Test 裝置群組中。 這是針對每個產品自動建立的預設裝置群組之一,可啟用應用程式更新。 如果裝置沒有產品,或現場測試裝置群組不存在,則會傳回錯誤。
如果指定產品,裝置會放在該產品的 [現場測試] 裝置群組中。 如果此裝置群組不存在,則會傳回錯誤。
如果指定裝置群組,裝置會放在其中。 如果目標裝置群組未啟用應用程式更新,則會傳回錯誤。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-p、 --product | GUID 或名稱 | 指定目標產品。 指定此選項時,除非也指定,否則 --device-group 裝置會移至此產品的預設 Field Test 裝置群組。 您可以指定 Azure Sphere 產品的識別碼或名稱。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
-g、 --device-group | GUID 或名稱 | 指定要行動裝置的裝置群組。 您可以指定裝置群組識別碼或裝置組名。 若要使用裝置群組名稱,您必須以 格式提供產品名稱和裝置組名 <product-name/device-group-name> 。 根據預設,這是產品的現場測試裝置群組。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
範例 1. 依裝置標識碼將裝置指派給現有的裝置群組
本範例會將連結的裝置指派給現有的產品和裝置群組。
azsphere device enable-cloud-test --device-group '3548b179-m16f-4f64-6dme-d3c643662e76'
Your internal capabilities will be retained, including the Enable App development capability. Sideloaded images may be removed by over-the-air application updates.
Getting device group by ID '3548b179-m16f-4f64-6dme-d3c643662e76'.
Leaving any existing applications on the device.
Setting device group to 'Field Test' with ID '3548b179-m16f-4f64-6dme-d3c643662e76')
Successfully updated device's device group.
Successfully set up device for application updates.
(Device ID: 'ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD')
範例 2. 將裝置指派給不同的裝置群組
此範例與上述範例類似,但會保留裝置的現有產品。 在這裡,enable-cloud-test 作業會變更裝置所屬的裝置群組,並移除 appDevelopment 功能。 此命令適用於將裝置從未啟用應用程式更新的開發環境移至執行環境。
azsphere device enable-cloud-test --device-group "Marketing/Field Test"
範例 3. 依產品名稱指派裝置
此範例會啟用雲端載入,並依名稱將裝置指派給產品。
azsphere device enable-cloud-test --product DW100
enable-development
啟用裝置以進行開發,方法是在裝置上啟用側載和偵錯,並將它指派給停用雲端應用程式更新的裝置群組。 根據預設,這是裝置產品的開發裝置群組,但可以指定其他裝置群組。 請勿在製造案例中使用。 如需詳細資訊,請參閱 製造連線的裝置 。
具體來說, 啟用開發:
- 下載並套 用連結裝置的 appDevelopment 功能。
- 將裝置指派給未啟用雲端載入應用程式更新的裝置群組。
- 重新啟動裝置。
如果您執行 azsphere device enable-development 命令,但沒有參數:
- 如果裝置還沒有產品或裝置群組,命令會下載並套用 連結裝置的 appDevelopment 功能,並重新啟動裝置。 任何現有的應用程式都會保留在裝置上,且操作系統會更新。 宣告裝置的安裝程式和建置高階應用程式的快速入門不會受到影響。
- 如果裝置已經有產品,命令會將裝置移至產品的 開發 裝置群組。 根據預設,此群組會停用應用程式更新,以確保不會覆寫側載的應用程式。
如果您使用 參數執行 azsphere device enable-development 命令 --product
:
- 將裝置放在產品的開發裝置群組中。 如果此裝置群組不存在,則會傳回錯誤。
如果您使用 參數執行 azsphere device enable-development 命令 --device-group
:
- 將裝置放在指定的裝置群組中。 目標裝置群組不得啟用應用程式更新或傳回錯誤。
在某些情況下, azsphere device enable-development 會回報錯誤,並建議您宣告裝置。 如果您已經宣告裝置,請使用 azsphere tenant show-selected 來確保您已登入您宣告裝置的租使用者。 如果沒有,請使用 azsphere login 登入正確的租使用者。 當您確定已登入適當的租使用者時,請使用 azsphere device claim 來宣告裝置。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-g、 --device-group | GUID 或名稱 | 指定要行動裝置的裝置群組。 如果省略,請將裝置指派給預設群組。 您可以指定裝置群組識別碼或裝置組名。 若要使用裝置群組名稱,您必須以 格式提供產品名稱和裝置組名 <product-name/device-group-name> 。 |
-r, --enable-rt-core-debugging | 布林值 | 安裝在即時核心上執行之應用程式偵錯所需的驅動程式。 此選項需要系統管理員許可權。 |
-p、 --product | GUID 或名稱 | 指定目標產品。 當您指定此值時,除非也指定,否則--device-group 裝置會移至此產品的預設開發裝置群組。 您可以指定 Azure Sphere 產品的識別碼或名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device enable-development
Capability configuration has been successfully cleared.
PS C:\Users\v-shypr> azsphere device enable-development
Getting device group 'Development' for product 'DW100'.
The device already has the 'Enable App development' capability. No changes will be applied to its existing capabilities.
Setting device group to 'Development' with ID '7f860cc1-4949-4000-a541-9a988ba4c3cd'.
Successfully disabled application updates.
Installing debugging server to device.
Deploying 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' to the attached device.
Image package 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' has been deployed to the attached device.
Previous device capabilities retained. Ensure that you have the correct development capabilities installed before continuing.
Successfully set up device for application development, and disabled application updates.
(Device ID: '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968')
image
傳回安裝在或以連結裝置為目標之映像的相關信息。
作業 | 描述 |
---|---|
list-installed | 提供有關目前安裝在連結裝置上之映像的詳細數據。 |
list-targeted | 提供以連結裝置為目標之映像的詳細數據。 |
映射清單安裝
列出安裝在連結裝置上的映像。 資訊清單包含元件和映像標識碼。
注意
長映像名稱會截斷為31個字元。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-f、 --full | 布林值 | 列出安裝在裝置上的所有軟體映像。 根據預設,只會列出應用程式映像、調試程式和面板組態映像。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device image list-installed
Installed images:
--> gdbserver
--> Image type: Application
--> Component ID: 8548b129-b16f-4f84-8dbe-d2c847862e78
--> Image ID: dc6205bd-4478-4c9b-81ad-5e41ac23ed68
--> CrashApplicatio
--> Image type: Application
--> Component ID: 9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
--> Image ID: cc77124e-6447-4c0f-9f99-fc0ad5ef46ef
image list-targeted
列出已上傳至 Azure Sphere 安全性服務的映像,並在裝置更新時安裝。 如需確保 Azure Sphere 裝置已準備好接受雲端式應用程式更新的詳細資訊,請參閱 為您的裝置啟用雲端式部署。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
-f、 --full | 布林值 | 列出 Azure Sphere 租使用者中的所有映像。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device image list-targeted
----------------------- ------------------------------------ ------------------------------------ ---------------- --------------------
Name ComponentId ImageId ImageType RegionalDataBoundary
=======================================================================================================================================
HelloWorld_HighLevelApp 1689d8b2-c835-2e27-27ad-e894d6d15fa9 50419cb6-a33b-4cbe-8bd0-425048664b6f Applications None
----------------------- ------------------------------------ ------------------------------------ -------------------------------------
清單
列出租使用者中的所有裝置。 清單會在前 500 個裝置之後截斷。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device list
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
DeviceId TenantId ChipSku ProductId DeviceGroupId
========================================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
您可以使用 --query
參數來自定義針對此命令顯示的輸出。 如需詳細資訊,請參閱 查詢 CLI 命令輸出。
下列範例示範如何只選取 [裝置標識符] 和 [產品標識符]:
azsphere device list --query '[].{DeviceId:deviceId, ProductId:productId}'
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
DeviceId ProductId
=====================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 4f48d618-09f7-45dc-a5a4-1433cabbee91
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD 4f48d618-09f7-45dc-a5a4-1433cabbee91
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
提示
執行 azsphere product show --product-ID<> 以檢視產品名稱或 azsphere device-group show --device-group <devicegroup-ID> 以檢視裝置組名。
list-attached
列出連結至本機電腦的裝置。
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device list-attached
1 device attached:
--> Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
--> Is responsive: yes
--> IP address: 192.128.48.1
--> Connection path: 21143
manufacturing-state
管理連結裝置的製造狀態。
作業 | 描述 |
---|---|
show | 顯示連結裝置的製造狀態。 |
update | 更新連結裝置的製造狀態。 |
警告
製造狀態變更是永久性且無法復原的。
manufacturing-state show
顯示連結裝置的製造狀態。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device manufacturing-state show
------------------
ManufacturingState
==================
Module1Complete
------------------
manufacturing-state update
更新連結裝置的製造狀態。 如需詳細資訊,請參閱 設定裝置製造狀態。
警告
製造狀態變更是永久性且無法復原的。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-s、-state | 製造狀態 | 指定要為裝置設定的製造狀態。 可能的狀態包括 DeviceComplete 和 Module1Complete 。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device manufacturing-state update --state Module1Complete
Updating manufacturing state to Module1Complete.
Restarting device for changes to take effect.
The device was successfully restarted.
network
提供連結裝置上網路介面狀態的相關信息。
作業 | 描述 |
---|---|
enable | 在連接的裝置上啟用網路介面。 |
禁用 | 停用連結裝置上的網路介面。 |
list-firewall-rules | 列出連結裝置的防火牆規則。 |
list-interfaces | 列出連結裝置的網路介面。 |
Proxy | 管理網路 Proxy 設定。 |
show-diagnostics | 顯示連結裝置上一或所有無線網路的網路診斷。 |
show-status | 顯示連結裝置的網路狀態。 |
update-interface | 更新裝置的網路介面組態。 |
網路啟用
在連接的裝置上啟用網路介面。
注意
支援此命令來設定乙太網路 eth0
和 wlan0
連線。 如果您設定 lo
或 azspheresvc
,則會傳回錯誤。
必要參數
參數 | 類型 | 描述 |
---|---|---|
--介面 | 字串 | 指定要啟用的介面。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network enable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.
網路停用
停用連結裝置上的網路介面。
注意
支援此命令來設定乙太網路 eth0
和 wlan0
連線。 如果您設定 lo
或 azspheresvc
,則會傳回錯誤。
必要參數
參數 | 類型 | 描述 |
---|---|---|
--介面 | 字串 | 指定要啟用的介面。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network disable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.
network list-firewall-rules
列出連結裝置的防火牆規則。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
顯示下列規則:
- 防火牆規則集名稱:顯示防火牆規則集區塊的名稱。
- 這些值為 PREROUTING、POSTROUTING、INPUT、FORWARD 和 OUTPUT。
- 規則集有效:顯示規則集的狀態。 值為 True 或 False。
- 防火牆規則集規則:顯示下列規則的值:
- 來源IP:顯示傳送電腦的IP位址。
- 來源遮罩:顯示傳送計算機的網路遮罩。
- 目的地 IP:顯示目的地電腦的 IP 位址。
- 目的地遮罩:顯示還原設定計算機的網路遮罩。
- UID:顯示套用至規則的用戶識別。 4294967295(0xFFFFFFFF)表示未套用任何 UID,因此適用於所有人。
- 動作:顯示要採取的動作。 這些值可以是 接受 或 卸除。
- 介面 IN 名稱:顯示輸入介面名稱。 例如, wlan0。
- 介面 OUT 名稱:顯示輸出介面名稱。 例如, wlan0。
- 狀態:顯示連線狀態。 這些值是 無、 已建立或 相關的。
- TCP 遮罩:顯示 TCP 遮罩的陣列。 這些值為 fin、syn、rst、psh、ack 和 urg。
- TCP Cmp:顯示 TCP 旗標的陣列。 這些值是敦促、ack、psh、rst、syb 和 fin。
- TCP Inv:布爾值表示應該反轉 TCP 旗標的感覺。 值為 True 或 False。
- 通訊協議:顯示防火牆規則的通訊協定。 這些值為icmp、igmp、tcp、udp。
- 來源埠範圍:顯示從傳送流量的來源埠範圍。 此值可以介於 0 到 65535 之間。
- 目的地埠範圍:在接收流量的目的地上顯示埠範圍。 此值可以介於 0 到 65535 之間。
- 封包:顯示封包數目。
- 位元組:顯示位元組數目。
旗標的簡短摘要如下:
- URG:緊急指標欄位顯著
- ACK:通知欄位顯著
- PSH:Push 函式
- RST:重設連線
- SYN:同步處理序號
- FIN:寄件人不再有任何數據
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network list-firewall-rules
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
Ruleset IsValid SourceIp SourceMask DestinationIp DestinationMask UID Action InterfaceInName TcpInv Protocol SourcePortRange DestinationPortRange Packets Bytes TcpMask TcpCmp
=====================================================================================================================================================================================================
PREROUTING False None None None None None None None None None None None None None None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True <value> <value> <value> <value> <value> accept False any 0-65535 0-65535 0 0 None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True <value> <value> <value> <value> <value> accept True tcp 0-65535 0-65535 823 394754 syn,ack syn
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True 192.168.35.1 <value> <value> <value> <value> accept azspheresvc False any 0-65535 0-65535 15 780 None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True <value> <value> <value> <value> <value> accept False udp 53-53 0-65535 0 0 None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True <value> <value> <value> <value> <value> accept False udp 53-53 0-65535 0 0 None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
INPUT True <value> <value> <value> <value> <value> accept False udp 53-53 0-65535 0 0 None None
----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
network list-interfaces
列出連結裝置的網路介面。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network list-interfaces
------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
InterfaceName InterfaceUp ConnectedToNetwork IpAcquired IpAddresses ConnectedToInternet IpAssignment HardwareAddress
========================================================================================================================
azspheresvc True False False <value> False None None
------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
eth0 True True True <value> True dynamic <value>
------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
lo True False False <value> False None None
------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
wlan0 True True True <value> True dynamic <value>
------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
網路 Proxy
管理用於網路連線的 Proxy 位址。 如需設定 Azure Sphere 裝置以透過 Proxy 伺服器連線到因特網的詳細資訊,請參閱 透過 Proxy 伺服器連線。
注意
目前僅支援 HTTP Proxy。
作業 | 描述 |
---|---|
Proxy 套用 | 在連結的裝置上設定網路 Proxy。 |
Proxy 刪除 | 刪除連結裝置上的 Proxy 連線。 |
Proxy 顯示 | 顯示連結裝置上的 Proxy 連線。 |
Proxy 套用
在連結的裝置上設定網路 Proxy。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-a, --address | String | 指定要使用之 Proxy 的網路位址。 |
-t、 --authentication | String | 指定要使用的驗證類型。 允許值:anonymous 或 basic 。 如果 Proxy 需要使用者名稱和密碼,請將此設定為 basic ,否則請使用 anonymous 。 |
-r、 --port | 整數 | 指定要使用之網路位址上的埠。 值必須等於或小於 65535。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
--使 | String | 指定是否應該啟用 Proxy。 您必須設定 --enable 或 --disable 。 |
--禁用 | String | 指定是否應該停用 Proxy。 您必須設定 --enable 或 --disable 。 |
-n, --no-proxy-addresses | String | 指定裝置應避免用於 Proxy 連線的空間分隔網路位址數位。 |
-p、 --password | String | 指定 Proxy 驗證的密碼僅適用於基本身份驗證。 最大長度:64 個字元。 |
-u, --username | String | 指定 Proxy 驗證的用戶名稱。 僅用於基本身份驗證。 最大長度:64 個字元。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network proxy apply --address contoso.com --authentication anonymous --port 8080 --enable
----------- ------- ----- ------------------ ----------------
Address Enabled Port AuthenticationType NoProxyAddresses
=============================================================
contoso.com True 8080 anonymous
----------- ------- ----- ------------------ ----------------
Proxy 刪除
刪除連結裝置上的 Proxy 連線。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network proxy delete
Proxy 顯示
顯示連結裝置上的 Proxy 連線。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network proxy show
----------- ------- ----- ------------------ ----------------
Address Enabled Port AuthenticationType NoProxyAddresses
=============================================================
contoso.com True 8080 anonymous
----------- ------- ----- ------------------ ----------------
網路 show-diagnostics
顯示連結裝置上一或所有Wi-Fi網路的診斷。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-n, --network | 整數 | 指定要顯示診斷之Wi-Fi網路的識別碼。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network show-diagnostics
------------------------- --------- ----- ------------- --------------- --------
Timestamp NetworkId Ssid ConfigState ConnectionState Error
================================================================================
2021-06-16T20:51:29+00:00 0 <value> temp-disabled disconnected WrongKey
------------------------- --------- ----- ------------- --------------- --------
network show-status
顯示連結裝置的網路狀態。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network show-status
--------------------------- --------------- -----
DeviceAuthenticationIsReady NetworkTimeSync Proxy
=================================================
True complete ready
--------------------------- --------------- -----
network update-interface
更新裝置的乙太網路介面。 如需設定裝置 MAC 位址的詳細資訊,請參閱 設定乙太網路的裝置。
注意
這項命令支援設定乙太網路 eth0
連線。 如果您設定 lo
、 azspheresvc
或 wlan0
,則會傳回錯誤。
必要參數
參數 | 類型 | 描述 |
---|---|---|
--hardware-address | String | 指定要以下欄取一格式設定裝置的硬體位址: AA:BB:33:DD:EE:FF 或 aa:bb:33:dd:ee:ff 。 |
--介面 或 --interface-name [淘汰] |
String | 指定要設定的介面名稱。 執行 azsphere device network list-interfaces 來檢視連結裝置網路介面的詳細數據。 自 --interface-name 變數將會淘汰,並將在未來版本中移除。 如需詳細資訊,請參閱 Azure Sphere CLI 中的重要變更(淘汰功能)。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device network update-interface --interface eth0 --hardware-address ba:98:76:54:32:10
recover
取代裝置上的系統軟體。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 預設會使用目前連結的裝置。 指定裝置的識別碼、IP 位址或本機連線標識碼。 |
-c、 --capability | String | 指定要在復原期間套用至裝置的裝置功能映像。 |
-i, --images | String | 指定要寫入裝置之映像套件的資料夾路徑。 根據預設,除非使用此旗標提供替代路徑,否則復原會使用SDK中的映像。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
範例 1:
azsphere device recover
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 17 images. (5443272 bytes to send)
Sent 1 of 17 images. (5440896 of 5443272 bytes remaining)
Sent 2 of 17 images. (5414844 of 5443272 bytes remaining)
Sent 3 of 17 images. (5311892 of 5443272 bytes remaining)
Sent 4 of 17 images. (5311500 of 5443272 bytes remaining)
Sent 5 of 17 images. (5041520 of 5443272 bytes remaining)
Sent 6 of 17 images. (5024908 of 5443272 bytes remaining)
Sent 7 of 17 images. (4994856 of 5443272 bytes remaining)
Sent 8 of 17 images. (2397456 of 5443272 bytes remaining)
Sent 9 of 17 images. (885796 of 5443272 bytes remaining)
Sent 10 of 17 images. (861220 of 5443272 bytes remaining)
Sent 11 of 17 images. (758608 of 5443272 bytes remaining)
Sent 12 of 17 images. (135796 of 5443272 bytes remaining)
Sent 13 of 17 images. (70048 of 5443272 bytes remaining)
Sent 14 of 17 images. (41164 of 5443272 bytes remaining)
Sent 15 of 17 images. (32768 of 5443272 bytes remaining)
Sent 16 of 17 images. (16384 of 5443272 bytes remaining)
Sent 17 of 17 images. (0 of 5443272 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.
範例 2:
azsphere device recover --capability "C:\Users\capability file\capability_352FE1F_5.bin"
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 16 images. (5474668 bytes to send)
Sent 1 of 16 images. (5447384 of 5474668 bytes remaining)
Sent 2 of 16 images. (5343788 of 5474668 bytes remaining)
Sent 3 of 16 images. (5343396 of 5474668 bytes remaining)
Sent 4 of 16 images. (5073416 of 5474668 bytes remaining)
Sent 5 of 16 images. (5056612 of 5474668 bytes remaining)
Sent 6 of 16 images. (5026240 of 5474668 bytes remaining)
Sent 7 of 16 images. (2479376 of 5474668 bytes remaining)
Sent 8 of 16 images. (889892 of 5474668 bytes remaining)
Sent 9 of 16 images. (865316 of 5474668 bytes remaining)
Sent 10 of 16 images. (754512 of 5474668 bytes remaining)
Sent 11 of 16 images. (135796 of 5474668 bytes remaining)
Sent 12 of 16 images. (70048 of 5474668 bytes remaining)
Sent 13 of 16 images. (41164 of 5474668 bytes remaining)
Sent 14 of 16 images. (32768 of 5474668 bytes remaining)
Sent 15 of 16 images. (16384 of 5474668 bytes remaining)
Sent 16 of 16 images. (0 of 5474668 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.
重新掃描附加
透過電源迴圈所有 FTDI 埠來重新掃描連接的裝置,並顯示連結裝置的總計數。 針對 Windows 上的裝置連線問題進行疑難解答時,請使用此命令。 此命令只會在 Windows 上執行。
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device rescan-attached
-----------
Count
===========
2
-----------
restart
重新啟動連結的裝置。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device restart
Restarting device.
Device restarted successfully.
show
顯示 Azure Sphere 租使用者中連結裝置的詳細數據。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device show
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
DeviceId TenantId ChipSku ProductId DeviceGroupId
========================================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
您可以使用 --query
參數來自定義針對此命令顯示的輸出。 如需詳細資訊,請參閱 查詢 CLI 命令輸出。
下列範例示範如何只選取 [裝置標識符] 和 [產品標識符]:
azsphere device show --device 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 --query '{DeviceId:deviceId, ProductId:productId}'
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
DeviceId ProductId
=====================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
show-attached
顯示來自裝置本身之連結裝置的相關信息。 這些詳細數據與 Azure Sphere 安全性服務儲存裝置的詳細數據不同。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device show-attached
Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
IP address: 192.128.48.1
Connection path: 21143
show-deployment-status
顯示裝置的應用程式和作業系統更新部署狀態。
使用此命令來找出裝置正在執行的 Azure Sphere OS 版本,或目前的部署更新是否已完成。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device show-deployment-status
Your device is running Azure Sphere OS version <version-number>.
The Azure Sphere Security Service is targeting this device with Azure Sphere OS version <version-number>.
Your device has the expected version of the Azure Sphere OS: <version-number>.
在此範例中, <版本號碼> 代表目前的操作系統版本。
show-count
顯示目前租使用者中的裝置數目。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device show-count
------
Result
======
2
------
show-os-version
在連接的裝置上顯示目前的操作系統版本。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device show-os-version
Your device is running Azure Sphere OS version <version-number>
在此範例中, <版本號碼> 代表目前的操作系統版本。
sideload
管理裝置上的應用程式。
一旦裝置處於製造狀態 DeviceComplete,某些側載選項需要額外的功能。 fieldServicing 功能可讓您部署和刪除暫時的生產簽署映射,以及部署永久的生產簽署映像。 appDevelopment 功能可讓您部署和刪除生產簽署和 SDK 簽署的映像。
作業 | 描述 |
---|---|
delete | 從裝置刪除目前的應用程式。 |
部署 | 將應用程式載入裝置。 |
set-deployment-timeout | 設定部署逾時期間,以秒為單位。 |
show-deployment-timeout | 顯示部署逾時期間,以秒為單位。 |
請注意,、、 和的參數start
已移至 azsphere device app show-quota
命令。 show-status
stop
sideload delete
從裝置刪除應用程式。
只有在已設定 appDevelopment 裝置功能時,才能使用此命令。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-i, --component-id | GUID | 指定要從裝置刪除的應用程式識別碼。 如果省略,則會刪除所有應用程式。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device sideload delete
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.
側載部署
將應用程式載入連結的裝置上,並啟動應用程式。
如果應用程式指令清單要求裝置上的應用程式正在使用的資源,此命令就會失敗。 在此情況下,請使用 azsphere device sideload delete 來刪除 現有的應用程式,然後再試一次側載。 azsphere device sideload delete 命令會刪除高階應用程式和即時應用程式。 若要刪除一個應用程式並保留另一個應用程式,請指定要刪除之應用程式的元件標識碼。
相同的命令可用來部署高階應用程式和即時可用的應用程式。
注意
安裝使用周邊的新應用程式,並符合下列條件時,就會觸發裝置重新啟動:
- 裝置的製造狀態設定為 DeviceComplete。
- 裝置上沒有 appDevelopment 功能。 如需詳細資訊,請參閱 周邊組態鎖定。
如果起始裝置重新啟動,請等到重新啟動完成,裝置才會回應。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-p, --image-package | String | 指定要在裝置上載入之映像套件的路徑和檔名。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-m, --manual-start | 布林值 | 指定在載入應用程式之後不要自動啟動應用程式。 |
--force | 布林值 | 強制部署已不再支援使用 Beta API 的映像。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device sideload deploy --image-package C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage
Deploying 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' to the attached device.
Image package 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' has been deployed to the attached device.
sideload set-deployment-timeout
設定部署逾時值,以秒為單位在裝置上側載映像。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-v、 --value | 整數 | 指定側載命令逾時前秒的持續時間。值必須是正整數。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device sideload set-deployment-timeout --value 60
------------------
Deployment timeout
==================
60
------------------
sideload show-deployment-timeout
顯示裝置上側載映射的目前部署逾時值,以秒為單位。
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device sideload show-deployment-timeout
------------------
Deployment timeout
==================
60
------------------
update
將裝置移至 Azure Sphere 租使用者中的不同裝置群組。
除了您在產品中建立的裝置群組之外,在建立產品時會新增五個預設裝置群組:
- 開發:只接受系統軟體更新。 不接受應用程式更新。
- 現場測試:接受來自 Azure Sphere 安全性服務的所有更新。
- 生產:接受來自 Azure Sphere 安全性服務的所有更新。
- 生產操作系統評估:接受來自 Azure Sphere 安全性服務的所有更新。
- 現場測試 OS 評估:接受來自 Azure Sphere 安全性服務的所有更新。
如需有關部署中基本元素的詳細資訊,請參閱 部署基本概念。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-g、 --device-group | GUID 或名稱 | 指定要在其中行動裝置的裝置群組。 您可以指定裝置群組識別碼或裝置組名。 若要使用裝置群組名稱,您必須以 格式提供產品名稱和裝置組名 <product-name/device-group-name> 。 |
-d, --device | String | 指定要在其中執行命令的裝置。 附加多個裝置或未連結任何裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以為未連結的裝置提供裝置標識碼,也可以指定連結裝置的IP位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
-t、 --tenant | GUID 或名稱 | 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device update --device-group AW100/Marketing
------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------
DeviceId TenantId ChipSku ProductId DeviceGroupId
==============================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
427D205E46A166B7E41135EB968
------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------
您可以使用 --query
參數來自定義針對此命令顯示的輸出。 如需詳細資訊,請參閱 查詢 CLI 命令輸出。
下列範例示範如何只選取 [裝置標識符] 和 [產品標識符]:
azsphere device update --device-group AW100/Marketing --query '{DeviceId:deviceId, ProductId:productId}'
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
DeviceId ProductId
=====================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
wifi
管理連結裝置的Wi-Fi組態。
若要在Wi-Fi網路上使用裝置,您必須新增網路的相關信息,並在裝置上啟用網路。 雖然您可以在 SSID 中輸入非 ASCII 字元, 但 azsphere 不會正確顯示它們。
如果您的應用程式使用 Wi-Fi組態 API,您也必須在應用程式的 app_manifest.json 檔案中包含 WifiConfig 功能。
作業 | 描述 |
---|---|
add | 將無線網路的詳細數據新增至裝置。 |
禁用 | 停用裝置上的無線網路。 |
enable | 啟用裝置上的無線網路。 |
forget | 從裝置移除無線網路的詳細數據。 |
清單 | 列出裝置目前的Wi-Fi組態。 |
reload-config | 重載裝置 Wi-Fi 設定。 |
掃描 | 掃描可用的網路。 |
show | 顯示Wi-Fi設定的詳細數據。 |
show-status | 顯示無線介面的狀態。 |
wifi add
將Wi-Fi網路的詳細數據新增至連結的裝置。
裝置可以有多個Wi-Fi連線。 雖然您可以在 SSID 中輸入非 ASCII 字元, 但 azsphere 不會正確顯示它們。
您可以包含 --targeted-scan
參數以連線到隱藏的 SSD。 如需詳細資訊,請參閱 將 Azure Sphere 連線至 Wi-Fi。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-s、-ssid | String | 指定網路的 SSID。 網路 SSD 會區分大小寫。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
--client-cert-id | String | [EAP-TLS]指定識別客戶端憑證的識別碼 (最多 16 個字元)(包含公開和私鑰)。 設定 EAP-TLS 網路的必要專案。 |
--client-id <user@domain> | String | [EAP-TLS]指定由網路RADIUS伺服器辨識用於驗證的識別碼。 某些 EAP-TLS 網路的必要專案。 |
--config-name | String | 指定指定網路組態名稱的字串(最多 16 個字元)。 |
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
--root-ca-cert-id | String | [EAP-tLS]指定標識元(最多 16 個字元),以識別裝置驗證伺服器之 EAP-TLS 網路的根 CA 憑證。 |
--targeted-scan | 布林值 | 即使網路壅塞未廣播或隱藏網路壅塞,仍會嘗試連線到網路。 |
-p、 --psk | String | 指定新網路的 WPA/WPA2 金鑰。 省略以將 SSID 新增為開啟的網路。 如果您的金鑰包含和 (&),請以引弧括住索引鍵。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi add --ssid MyNetwork --psk MyPassword
Successfully added network:
----- -------- ------------------ --------------- ------------- ------------
ID SSID ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
1 MyNetwork enabled unknown psk False
----- -------- ------------------ --------------- ------------- ------------
如果網路 SSID 或金鑰具有內嵌空格或連字元,請以單引弧括住 SSID 或索引鍵。 如果 SSID 或索引鍵包含引號,請使用反斜杠來逸出引號。 反斜杠不一定是值的一部分,就不必逸出。 如需詳細資訊,請參閱 引號和逸出字元。 例如:
azsphere device wifi add --ssid "New SSID" --psk "key \'value\' with quotes"
wifi disable
停用連結裝置上的Wi-Fi網路。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-i, --id | 整數 | 指定要停用的網路識別碼。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi disable --id 0
Successfully disabled network:
----- -------- ------------------ --------------- ------------- ------------
ID SSID ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
0 MyNetwork disabled disconnected psk False
----- -------- ------------------ --------------- ------------- ------------
wifi enable
在連接的裝置上啟用Wi-Fi網路。
若要在兩者都在範圍內時從一個網路變更為另一個網路,請在啟用新網路之前停用目前連線的網路。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-i, --id | 整數 | 指定要啟用的網路識別碼。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi enable --id 0
Successfully enabled network:
----- -------- ------------------ --------------- ------------- ------------
ID SSID ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
0 MyNetwork enabled disconnected psk False
----- -------- ------------------ --------------- ------------- ------------
wifi forget
從連結的裝置移除Wi-Fi網路的詳細數據。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-i, --id | 整數 | 指定要刪除的網路識別碼。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi forget --id 0
Successfully forgotten network.
wifi 清單
列出連接的裝置目前的Wi-Fi組態。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi list
----- --------- ------------------ --------------- ------------- ------------
ID SSID ConfigurationState ConnectionState SecurityState TargetedScan
=============================================================================
0 MyNetwork1 enabled connected psk False
----- --------- ------------------ --------------- ------------- ------------
1 MyNetwork2 enabled disconnected psk False
----- --------- ------------------ --------------- ------------- ------------
2 MyNetwork3 enabled disconnected eaptls False
----- --------- ------------------ --------------- ------------- ------------
wifi reload-config
重載連結裝置上的Wi-Fi網路設定。 新增或移除憑證之後,請使用此命令(azsphere device certificate),以確保 EAP-TLS 網路使用證書存儲的最新內容。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi reload-config
Wi-Fi configuration was successfully reloaded.
wifi 掃描
掃描連結裝置可看見的可用Wi-Fi網路。 此命令最多會傳回 64 個 Wi-Fi 網路,但顯示的 Wi-Fi 網路數目可能會受限於環境因素,例如範圍中的訪問點密度。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi scan
----------------- ------------- ----------------- ----------- ---------
SSID SecurityState BSSID SignalLevel Frequency
=======================================================================
MyNetwork0 psk <value> -66 2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork1 psk <value> -75 2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork2 psk <value> -86 2412
----------------- ------------- ----------------- ----------- ---------
wifi show
顯示連結裝置上Wi-Fi網路的詳細數據。
必要參數
參數 | 類型 | 描述 |
---|---|---|
-i, --id | 整數 | 指定要顯示之網路組態的識別碼。 |
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi show --id 0
----- --------- ------------------ --------------- ------------- ------------
ID SSID ConfigurationState ConnectionState SecurityState TargetedScan
=============================================================================
0 MyNetwork enabled disconnected psk False
----- --------- ------------------ --------------- ------------- ------------
wifi show-status
顯示連結裝置上Wi-Fi介面的狀態。
選擇性參數
參數 | 類型 | 描述 |
---|---|---|
-d, --device | String | 指定要在連結多個裝置時執行命令的裝置。 附加多個裝置時,需要此參數。 預設會使用目前連結的裝置。 您可以指定連結裝置的裝置識別碼、IP 位址或本機線上標識碼。 Azure Sphere CLI 支援 Windows 上的多個 MT3620 裝置,但您一次只能在 Linux 上連線一部裝置。 基於這個理由,Windows 不支援此參數,但不支援 Linux。 如果您使用此參數搭配Linux上的命令,則會傳回錯誤。 |
全域參數
Azure Sphere CLI 提供下列全域參數:
參數 | 描述 |
---|---|
--debug | 增加記錄詳細信息以顯示所有偵錯記錄。 如果您發現錯誤,可在提交錯誤報告時提供使用 --debug 旗標產生的輸出。 |
-h, --help | 列印 CLI 參考命令及其自變數的相關信息,並列出可用的子群組和命令。 |
--only-show-errors | 只顯示錯誤,隱藏警告。 |
-o, --output | 變更輸出格式。 可用的輸出格式為 json、jsonc(色彩化 JSON)、tsv (Tab-Separated Values)、數據表(人類可讀取的 ASCII 數據表),以及 yaml。 根據預設,CLI 會輸出 table 。 若要深入瞭解可用的輸出格式,請參閱 Azure Sphere CLI 命令的輸出格式。 |
--查詢 | 使用 JMESPath 查詢語言來篩選從 Azure Sphere 安全性服務傳回的輸出。 如需詳細資訊和範例,請參閱 JMESPath 教學 課程和 查詢 Azure CLI 命令輸出 。 |
--verbose | 列印作業期間在 Azure Sphere 中建立之資源的相關信息和其他實用資訊。 使用 --debug 以取得完整的偵錯記錄。 |
注意
如果您使用 Azure Sphere 傳統 CLI,請參閱 全域參數 ,以取得可用選項的詳細資訊。
範例
azsphere device wifi show-status
----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------
SSID ConfigurationState ConnectionState SecurityState Frequency Mode KeyManagement WpaState IpAddress MacAddress
================================================================================================================================
<value> enabled connected psk 2412 station WPA2-PSK COMPLETED <value> <value>
----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------