hardware-definition
重要
這是 Azure Sphere （舊版） 檔。 Azure Sphere（舊版）將於 2027 年 9 月 27 日淘汰，且使用者此時必須移轉至 Azure Sphere（整合式）。 使用位於 TOC 上方的版本選取器來檢視 Azure Sphere （整合式） 檔。
管理 Azure Sphere 裝置的硬體定義。
| 作業 | 描述 |
|---|---|
| generate-header | 產生對應至硬體定義的 C 頭檔，並將它放在 inc/hw 資料夾中，相對於輸入 JSON。 |
| test-header | 測試 inc/hw 資料夾中的 C 頭檔與輸入 JSON 有關的最新狀態。 |
generate-header
產生對應至硬體定義的 C 頭檔，並將它放在 inc/hw 資料夾中，相對於輸入 JSON。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --hardware-definition-file | 路徑 | 指定硬體定義 JSON 檔案的名稱和路徑。 您可以提供相對或絕對路徑。 |
全域參數
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 hardware-definition generate-header --hardware-definition-file C:\AppSamples\HardwareDefinitions\seeed_mt3620_mdb\sample_appliance.json
Generated header file at C:/AppSamples/HardwareDefinitions/seeed_mt3620_mdb/inc/hw/sample_appliance.h based on hardware definition at C:\AppSamples\HardwareDefinitions\seeed_mt3620_mdb\sample_appliance.json
test-header
測試 inc/hw 資料夾中的 C 頭檔與輸入 JSON 有關的最新狀態。
必要參數
| 參數 | 類型 | 描述 |
|---|---|---|
| --hardware-definition-file | 路徑 | 指定硬體定義 JSON 檔案的名稱和路徑。 檔案路徑可以是絕對路徑或相對路徑。 |
全域參數
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 hardware-definition test-header --hardware-definition-file "C:\Program Files (x86)\Microsoft Azure Sphere SDK\HardwareDefinitions\mt3620.json"
Hardware definition at C:\Program Files (x86)\Microsoft Azure Sphere SDK\HardwareDefinitions\mt3620.json is consistent with header at C:/Program Files (x86)/Microsoft Azure Sphere SDK/HardwareDefinitions/inc/hw/mt3620.h