共用方式為


product

重要

這是 Azure Sphere (舊版) 檔。 Azure Sphere(舊版)將於 2027 年 9 月 27 日淘汰,且使用者此時必須移轉至 Azure Sphere(整合式)。 使用位於 TOC 上方的版本選取器來檢視 Azure Sphere (整合式) 檔。

管理產品。

作業 描述
create 建立新產品。
delete 刪除現有的產品。
裝置 顯示此產品的裝置。
device-group 管理產品裝置群組。
清單 列出 Azure Sphere 租使用者中的所有產品。
show 顯示產品的詳細數據。
update 更新指定的元數據。

create

建立新產品。

azsphere product create 命令會自動將五個預設裝置群組新增至已建立的產品:

  • 開發 裝置群組會停用雲端應用程式更新,並傳遞零售操作系統。
  • 現場測試 裝置群組可啟用雲端應用程式更新並傳遞零售操作系統。
  • 生產 裝置群組可啟用雲端應用程式更新並傳遞零售OS。
  • 生產 OS 評估 裝置群組可啟用雲端應用程式更新,並提供零售評估 OS。
  • 現場測試 OS 評估 裝置群組可啟用雲端應用程式更新,並傳遞零售評估 OS。

必要參數

參數 類型 描述
-n, --name String 指定產品的名稱。 名稱只能包含英數位元。 如果名稱包含空格,請以引號括住它。 產品名稱不能超過 50 個字元,不區分大小寫,而且在租用戶內必須是唯一的。

選擇性參數

參數 類型 描述
-g, --no-default-device-groups 布林值 指定選擇性旗標,以防止建立預設裝置群組。
-t、 --tenant GUID 或名稱 指定要在中執行這項作業的租使用者。 覆寫預設選取的租使用者。 您可以指定租使用者識別碼或租用戶名稱。
-d, --description String 指定要描述產品的選擇性文字。 最大長度為 100 個字元。 如果描述包含空格,請以引號括住它。
全域參數

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 product create --name DW100 --description "Contoso DW100 models"
Default device groups will been created for this product, use the 'azsphere product device-group list' command to see them.
 ------------------------------------ -------------------- ----- ------------------------------------
 TenantId                             Description          Name  Id
 ====================================================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb Contoso DW100 models DW100 6f52bead-700d-4289-bdc2-2f11f774270e
 ------------------------------------ -------------------- ----- ------------------------------------

delete

刪除 Azure Sphere 租使用者中的指定產品。

只有在下列情況下,才能刪除產品:

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要刪除的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product delete --product 6f52bead-700d-4289-bdc2-2f11f774270e

依名稱指定產品的範例:

azsphere product delete --product DW100

您應該會看到如下的輸出:

Successfully deleted the product

device

顯示產品內的裝置。

作業 描述
list 顯示指定產品內的裝置。
show-count 傳回產品內的裝置計數。

裝置清單

顯示指定產品內的裝置,並依裝置標識碼列出。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要列出裝置的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product device list --product 6f52bead-700d-4289-bdc2-2f11f774270e

依名稱指定產品的範例:

azsphere product device list --product DW100

您應該會看到如下的輸出:

-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
DeviceId                                                                                                                         TenantId                             ProductId                            DeviceGroupId
===============================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------

裝置 show-count

傳回產品內所有裝置群組中的所有裝置總數。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定顯示目標裝置數目的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product device show-count --product 6f52bead-700d-4289-bdc2-2f11f774270e

依名稱指定產品的範例:

azsphere product device show-count --product DW100

您應該會看到如下的輸出:

------
Result
======
2
------

device-group

管理產品裝置群組。

作業 描述
create-defaults 在指定的產品內建立預設裝置群組。
清單 顯示指定產品內的裝置群組。

device-group create-defaults

在現有產品內建立預設裝置群組。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要取得的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product device-group create-defaults --product 6f52bead-700d-4289-bdc2-2f11f774270e

依名稱指定產品的範例:

azsphere product device-group create-defaults --product  DW100

您應該會看到如下的輸出:

------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- -------------------------
Id                                   Name                     Description                                   ProductId                            OsFeedType UpdatePolicy                                                           AllowCrashDumpsCollection     RegionalDataBoundary
=====================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb Development              Default development device group              ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail     Accept only system software updates. Don't accept application updates. False                         None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b Field Test               Default test device group                     ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail     Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 Production               Default production device group               ac181192-2569-4d95-8f70-f8fd9e8dd2e3 Retail     Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc Production OS Evaluation Default Production OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d Field Test OS Evaluation Default Field Test OS Evaluation device group ac181192-2569-4d95-8f70-f8fd9e8dd2e3 RetailEval Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------

device-group list

列出產品中的所有裝置群組。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要列出裝置群組的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product device-group list --product 6f52bead-700d-4289-bdc2-2f11f774270e

依名稱指定產品的範例:

azsphere product device-group list --product DW100

您應該會看到如下的輸出:

------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- -------------------------
Id                                   TenantId                             OsFeedType ProductId                            Name                     Description                                   UpdatePolicy                                                           AllowCrashDumpsCollection     RegionalDataBoundary
==========================================================================================================================================================================================================================================================================================================================
6406868c-19bb-4bea-b4cf-fd80608ee5cb 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Development              Default development device group              Accept only system software updates. Don't accept application updates. False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
d2e2b2e7-e219-4af8-8876-f8d10624778b 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test               Default test device group                     Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
822f1bda-32d7-404a-bf37-9f90aad09509 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Production               Default production device group               Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
a6c64cda-4ff0-48bb-8a30-6ffab322b846 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Production OS Evaluation Default Production OS Evaluation device group Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
3fafc0e1-f336-4a8a-9be4-fb275322d2cc 143adbc9-1bf0-4be2-84a2-084a331d81cb RetailEval 4f48d618-09f7-45dc-a5a4-1433cabbee91 Field Test OS Evaluation Default Field Test OS Evaluation device group Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
b9b7f388-2ad4-4a7e-a4dc-6559fb80741d 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     4f48d618-09f7-45dc-a5a4-1433cabbee91 Marketing                Default Marketing device group                Accept all updates from the Azure Sphere Security Service.             False                         None
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------

清單

列出 Azure Sphere 租使用者中的所有產品。

選擇性參數

參數 類型 描述
-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 product list
------------------------------------ ------------------------------------ --------- --------------------
Id                                   TenantId                             Name      Description
========================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100     Contoso DW100 models
------------------------------------ ------------------------------------ --------- --------------------
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200     Contoso DW200 models
------------------------------------ ------------------------------------ --------- --------------------

show

顯示產品的詳細數據。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要取得的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-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 product show --product 6f52bead-700d-4289-bdc2-2f11f774270e --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb

依名稱指定產品和租使用者的範例:

azsphere product show --product DW100 --tenant MyTenant

您應該會看到如下的輸出:

------------------------------------ ------------------------------------ ----- --------------------
Id                                   TenantId                             Name  Description
====================================================================================================
6f52bead-700d-4289-bdc2-2f11f774270e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW100 Contoso DW100 models
------------------------------------ ------------------------------------ ----- --------------------

update

更新指定的產品元數據。

至少必須提供選擇性參數,或 --newname --newdescription。 這兩者都可以在單一命令中指定。

必要參數

參數 類型 描述
-p、 --product GUID 或名稱 指定要更新的產品。 您可以指定 Azure Sphere 產品的識別碼或名稱。

選擇性參數

參數 類型 描述
-n, --new-name String 指定產品的新名稱。 名稱只能包含英數位元。 如果名稱包含空格,請以引號括住它。 產品名稱不能超過 50 個字元,不區分大小寫,而且在租用戶內必須是唯一的。
-d, --new-description String 指定要描述產品的選擇性文字。 最大長度為 100 個字元。
-t、 --tenant 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 product update --product 6f52bead-700d-4289-bdc2-2f11f774270e --new-description Contoso DW100 models

依名稱指定產品的範例:

azsphere product update --product DW100 --new-description Contoso DW100 models

您應該會看到如下的輸出:

------------------------------------ ------------------------------------ ----- ------------------
Id                                   TenantId                             Name  Description
==================================================================================================
6a82518f-8965-4bd6-ba79-43aa3fcafe5e 143adbc9-1bf0-4be2-84a2-084a331d81cb DW200 Contoso DW200 models
------------------------------------ ------------------------------------ ----- ------------------