product
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
製品を管理します。
| 操作 | 説明 |
|---|---|
| create | 新しい製品を作成します。 |
| delete | 既存の製品を削除します。 |
| device | この製品のデバイスを表示します。 |
| device-group | 製品のデバイス グループを管理します。 |
| list | Azure Sphere テナント内のすべての製品を一覧表示します。 |
| show | 製品に関する詳細を表示します。 |
| update | 指定したメタデータを更新します。 |
create
新しい製品を作成します。
azsphere product create コマンドは、作成された製品に 5 つの既定のデバイス グループを自動的に追加します。
- Development デバイス グループは、クラウド アプリケーション更新を無効にして、Retail OS を提供します。
- フィールド テスト デバイス グループは、クラウド アプリケーションの更新を有効にし、Retail OS を提供します。
- 運用環境 デバイス グループは、クラウド アプリケーションの更新を有効にし、Retail OS を提供します。
- Production OS Evaluation デバイス グループは、クラウド アプリケーション更新を有効にして、Retail Evaluation OS を提供します。
- Field Test OS Evaluation デバイス グループは、クラウド アプリケーション更新を有効にして、Retail Evaluation OS を提供します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -n, --name | String | 製品の名前を指定します。 名前には英数字のみを含めることができます。 名前にスペースが含まれている場合は、引用符で囲みます。 製品名は 50 文字を超えることはできません。大文字と小文字は区別されず、テナント内で一意である必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--no-default-device-groups | Boolean | 既定のデバイス グループの作成を妨げる省略可能なフラグを指定します。 |
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
| -d、--description | String | 製品を説明する省略可能なテキストを指定します。 最大長は 100 文字です。 説明にスペースが含まれる場合は、二重引用符で囲みます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
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 テナント内の指定した製品を削除します。
製品は、次の場合にのみ削除できます。
- ユーザーはテナントに対する管理者権限を持っています。
- 製品が空で、デバイス グループにデバイスがありません。 azsphere 製品デバイスリストコマンドは、製品内のすべてのデバイスを一覧表示します。 azsphere device update --device-group を実行してデバイスを別のデバイス グループに移動するかazsphere device-group deleteデバイス グループを削除します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | 削除する製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
azsphere product delete --product 6f52bead-700d-4289-bdc2-2f11f774270e
名前で製品を指定する例:
azsphere product delete --product DW100
次のような出力結果が表示されます。
Successfully deleted the product
device
製品内のデバイスを表示します。
| 操作 | 説明 |
|---|---|
| list | 指定された製品内のデバイスを表示します。 |
| show-count | 製品内のデバイスの数を返します。 |
device list
指定された製品内のデバイスをデバイス ID 別に一覧表示します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | デバイスを一覧表示する製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
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
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ------------------------------------
device show-count
製品内のすべてのデバイス グループに含まれるすべてのデバイスの合計数を返します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | 対象となるデバイスの数が表示される製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
azsphere product device show-count --product 6f52bead-700d-4289-bdc2-2f11f774270e
名前で製品を指定する例:
azsphere product device show-count --product DW100
次のような出力結果が表示されます。
------
Result
======
2
------
device-group
製品のデバイス グループを管理します。
| 操作 | 説明 |
|---|---|
| create-defaults | 指定された製品内に既定のデバイス グループを作成します。 |
| list | 指定された製品内のデバイス グループを表示します。 |
device-group create-defaults
既存の製品内に既定のデバイス グループを作成します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | 取得する製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
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 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
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
------------------------------------ ------------------------------------ ---------- ------------------------------------ ------------------------ --------------------------------------------- ---------------------------------------------------------------------- ----------------------------- --------------------
list
Azure Sphere テナント内のすべての製品を一覧表示します。
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
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 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品とテナントを指定する例:
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
指定された製品のメタデータを更新します。
少なくとも 1 つの省略可能なパラメーター ( --newname または --newdescription) を指定する必要があります。 1 つのコマンドに両方を指定することもできます。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | 更新する製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -n、--new-name | String | 製品の新しい名前を指定します。 名前には英数字のみを含めることができます。 名前にスペースが含まれている場合は、引用符で囲みます。 製品名は 50 文字を超えることはできません。大文字と小文字は区別されず、テナント内で一意である必要があります。 |
| -d、--new-description | String | 製品を説明する省略可能なテキストを指定します。 最大長は 100 文字です。 |
| -t、--tenant | String | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
グローバル パラメーター
Azure Sphere CLI では、次のグローバル パラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| --debug | ログの詳細度を上げて、すべてのデバッグ ログを表示します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 |
| -h, --help | コマンドとその引数に関する CLI 参照情報を出力し、使用可能なサブグループとコマンドを一覧表示します。 |
| --only-show-errors | エラーのみを表示し、警告を抑制します。 |
| -o, --output | 出力形式を変更します。 使用可能な出力形式は、json、jsonc (色分けされた JSON)、tsv (タブ区切り値)、テーブル (人間が判読できる ASCII テーブル)、yaml です。 既定では、CLI は table を出力します。 使用可能な出力形式の詳細については、「Azure Sphere CLI コマンドの出力形式を参照してください。 |
| --query | JMESPath クエリ言語を使用して、Azure Sphere Security Services から返される出力をフィルター処理します。 詳細と例については、 JMESPath チュートリアル および azure CLI コマンド出力の Query を参照してください 。 |
| --verbose | 操作中に Azure Sphere で作成されたリソースに関する情報とその他の有用な情報を出力します。 完全なデバッグ ログを表示するには --debug を使用します。 |
Note
Azure Sphere クラシック CLI を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
ID で製品を指定する例:
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
------------------------------------ ------------------------------------ ----- ------------------