device-group
重要
これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。
デバイス グループを作成および管理します。
デバイス グループは、識別子 (ID) または製品名とデバイス グループ名のペアによって場所が指定されます。
| 操作 | 説明 |
|---|---|
| create | 新しいデバイス グループを作成します。 |
| list | Azure Sphere テナント内のすべてのデバイス グループを一覧表示します。 |
| delete | 既存のデバイス グループを削除します。 |
| 展開 | デバイス グループ内の展開を管理します。 |
| device | デバイス グループ内のデバイスを一覧表示します。 |
| show | デバイス グループに関する情報を表示します。 |
| update | 既存のデバイス グループを変更します。 |
create
指定した製品のために、指定した名前でデバイス グループを作成します。 デバイス グループは、同じ製品を備えたデバイスをまとめ、クラウドから同じアプリケーションを受信します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -p、--product | GUID または名前 | このデバイス グループを追加する製品を指定します。 Azure Sphere 製品の ID または名前を指定できます。 |
| -n, --name | String | デバイス グループの名前を指定します。 名前には英数字のみを含めることができます。 名前にスペースが含まれている場合は、引用符で囲みます。 デバイス グループ名は 50 文字を超えることはできません。大文字と小文字は区別されません。製品内で一意である必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -a, --application-update | 列挙型 | このデバイス グループに適用するアプリケーション更新ポリシーを指定します。 受け入れ可能な値: No3rdPartyAppUpdates、 UpdateAll、および NoUpdates。 既定値は UpdateAll です。 現在、 NoUpdates ポリシーは内部使用専用に予約されています。 |
| -f、--os-feed | 列挙型 | OS の更新に使用する OS フィードの種類を指定します。 指定できる値: Retail、RetailEval。 |
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
| -d、--description | String | デバイス グループを説明する省略可能なテキストを指定します。 最大長は 100 文字です。 説明にスペースが含まれる場合は、二重引用符で囲みます。 |
| -r、--regional-data-boundary | String | このイメージの地域データ境界。 使用できる値: EU、None。 既定値は None です。 値が指定されていない場合は、既定値が使用されます。 詳細については、「 クラッシュ ダンプの構成 - Pivacy に関する考慮事項」を参照してください。 |
グローバル パラメーター
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 device-group create --name Marketing --product DW100
------------------------------------ ------------------------------------ ---------- ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- ---------------------
Id TenantId OsFeedType ProductId Name UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
===================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 6f52bead-700d-4289-bdc2-2f11f774270e Marketing 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 device-group list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- ---------------------
Id Name Description ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
=====================================================================================================================================================================================================================================================================================
a3a49688-4601-4422-8b51-a0838ea84627 Development Default development device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept only system software updates. Don't accept application updates. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
7cb46b96-8c17-4afd-bd3f-614acad9d264 Field Test Default test device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
30c39bae-f525-4094-8008-d03705429ef0 Production Default production device group 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
cb5c9685-5dbe-470c-91a9-91dc129884d6 Production OS Evaluation Default Production OS Evaluation device group 6f52bead-700d-4289-bdc2-2f11f774270e RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- ----------------------------- --------------------
63e72035-3fcf-4fdc-b88a-05e30d1ba224 Field Test OS Evaluation Default Field Test OS Evaluation device group 6f52bead-700d-4289-bdc2-2f11f774270e RetailEval Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------ --------------------------------------------- ------------------------------------ ---------- ---------------------------------------------------------------------- --------------------------------------------------
delete
Azure Sphere テナント内の指定されたデバイス グループを削除します。
デバイス グループは、次の場合にのみ削除できます。
- ユーザーはテナントに対する管理者権限を持っています。
- デバイス グループが空で、デバイスがありません。 azsphere device-group device list コマンドは、デバイス グループ内のすべてのデバイスを一覧表示します。 azsphere device update --device-group を実行して、デバイスを別のデバイス グループに移動します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | 削除するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 device-group delete --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
Successfully deleted the device group
azsphere device-group delete --device-group DW100/Development
Successfully deleted the device group
deployment
デバイス グループのためのデプロイを管理します。
| 操作 | 説明 |
|---|---|
| create | 指定したデバイス グループのために新しいデプロイを作成します。 |
| list | デバイス グループのためのデプロイを表示します。 |
deployment create
指定されたイメージを使用して、デバイス グループの新しい展開を作成します。
デバイス グループは、識別子 (ID) または製品名とデバイス グループ名のペアのいずれかによって識別できます。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | 展開を作成するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
| -i、--images | String | デプロイに含める 1 つ以上のイメージのイメージ ID を指定します。 複数のイメージを追加するには、パラメーターを追加するか、複数のイメージ ID をスペース区切りのリスト内の 1 つのパラメーターに組み合わせることができます。 azsphere image add コマンドを実行して、イメージ 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 を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。
例
--device-group パラメーターは、デバイス グループを識別します。 デバイス グループ ID は GUID を提供し、すべての製品のデバイス グループを一意に識別します。 または、製品名とデバイス グループ名のペアを <product-name>/<device-group-name> 形式で使用することもできます。 この名前のペアによって、特定の製品のデバイス グループが一意に識別されます。
ID でデバイス グループを指定する例:
azsphere device-group deployment create --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd --images 5572509b-43a4-45b0-88c5-365cbf9732c1
デバイス グループを名前で指定する例:
azsphere device-group deployment create --device-group DW100/Development --images 5572509b-43a4-45b0-88c5-365cbf9732c1
スペースで区切られた値のリストを指定して、複数のイメージ ID を指定する例:
azsphere device-group deployment create --device-group DW100/Development --images 5572509b-43a4-45b0-88c5-365cbf9732c1 3bbd2d2a-2870-4dde-9db8-ae50548ea7b4
次のような出力結果が表示されます。
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
Id TenantId DeployedImages DeploymentDateUtc
===================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb 5572509b-43a4-45b0-88c5-365cbf9732c1 2021-04-01T18:48:41.721662+00:00
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
deployment list
デバイス グループのデプロイ履歴を表示します。 デプロイ ID、タイムスタンプ、および含まれるイメージの一覧を返します。 一覧は、最新のデプロイの順に並べられています。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | 展開履歴の一覧を表示するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 device-group deployment list --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
デバイス グループを名前で指定する例:
azsphere device-group deployment list --device-group DW100/Development
次のような出力結果が表示されます。
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
Id TenantId DeployedImages DeploymentDateUtc
===================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb e3769536-dc4b-48d9-afd4-22ed321ba4bc 2020-11-18T19:46:50.514429+00:00
------------------------------------ ------------------------------------ ------------------------------------ ------------------------------------
device
デバイス グループのデバイスを管理します。
| 操作 | 説明 |
|---|---|
| list | デバイス グループ内のデバイスを表示します。 |
| show-count | デバイス グループ内のデバイスの数を示します。 |
device list
デバイス グループ内のデバイスを表示します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | デバイス リストを表示するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 device-group device list --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
デバイス グループを名前で指定する例:
azsphere device-group device list --device-group DW100/Marketing
次のような出力結果が表示されます。
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ----------------------------------------
DeviceId TenantId ProductId DeviceGroupId
===================================================================================================================================================================================================================================================
352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
-------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ ------------------------------------ ----------------------------------------
device show-count
デバイス グループ内のデバイスの数を表示します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | デバイス数を表示するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 で device-group を指定する例:
azsphere device-group device show-count --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
名前で device-group を指定する例:
azsphere device-group device show-count --device-group DW100/Marketing
次のような出力結果が表示されます。
------
Result
======
1
------
show
デバイス グループに関する情報を返します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | 詳細を表示するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -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 で device-group を指定する例:
azsphere device-group show --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd
名前で device-group を指定する例:
azsphere device-group show --device-group DW100/Marketing
次のような出力結果が表示されます。
------------------------------------ --------- ---------------------- ------------------------------------ ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- --------------------
Id Name Description TenantId ProductId OsFeedType UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
========================================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd Marketing Marketing device group 143adbc9-1bf0-4be2-84a2-084a331d81cb 6f52bead-700d-4289-bdc2-2f11f774270e Retail Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ --------- ---------------------- ------------------------------------ ------------------------------------ ---------- ---------------------------------------------------------- ----------------------------- --------------------
update
ID または製品名とデバイス グループ名のペアによって識別される、既存のデバイス グループを更新します。
必須のパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -g、--device-group | String | 詳細を更新するデバイス グループを指定します。デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 |
省略可能なパラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| -c、--allow-crash-dumps-collection | String | デバイス グループに対する Microsoft によるクラッシュ ダンプの収集に対する同意を設定します。 既定値は Off です。 使用できる値: Off と On。 --regional-data-boundary パラメーターを使用して、クラッシュ ダンプ ファイルを格納する場所を指定します。 詳細については、「 クラッシュ ダンプの構成」を参照してください。 |
| -a, --application-update | ApplicationUpdatePolicyType | デバイス グループのアプリケーション更新ポリシーを指定します。 使用できる値: No3rdPartyAppUpdates、UpdateAll、および NoUpdates。 既定値は UpdateAll です。 現在、 NoUpdates ポリシーは内部使用専用に予約されています。 |
| -d、--new-description | String | デバイス グループを説明する省略可能なテキストを指定します。 最大長は 100 文字です。 |
| -n、--new-name | String | デバイス グループの新しい名前を指定します。 名前には英数字のみを含めることができます。 名前にスペースが含まれている場合は、引用符で囲みます。 デバイス グループ名は 50 文字を超えることはできません。大文字と小文字は区別されず、製品内で一意である必要があります。 |
| -f、--os-feed | String | デバイス グループのオペレーティング システム フィードを指定します。 設定可能な値は Retail および RetailEval です。 |
| -t、--tenant | GUID または名前 | この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。 |
| -r、--regional-data-boundary | String | このイメージの地域データ境界。 使用できる値: EU、None。 既定値は None です。 値が指定されていない場合は、既定値が使用されます。 詳細については、「 クラッシュ ダンプの構成 - Pivacy に関する考慮事項」を参照してください。 |
グローバル パラメーター
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 で device-group を指定する例:
azsphere device-group update --device-group 7f860cc1-4949-4000-a541-9a988ba4c3cd --new-description "Marketing device group"
名前で device-group を指定する例:
azsphere device-group update --device-group DW100/Marketing --new-description "Marketing device group"
次のような出力結果が表示されます。
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- ----------------------------- --------------------
Id TenantId OsFeedType ProductId Name Description UpdatePolicy AllowCrashDumpsCollection RegionalDataBoundary
========================================================================================================================================================================================================================================================================
7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail 6f52bead-700d-4289-bdc2-2f11f774270e Marketing Marketing device group Accept all updates from the Azure Sphere Security Service. False None
------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- ----------------------------- --------------------