az sphere device-group

Note

このリファレンスは、Azure CLI (バージョン 2.45.0 以降) の azure-sphere 拡張機能の一部です。 拡張機能は、az sphere device-group コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

リソース グループとカタログ内のデバイス グループを管理します。

コマンド

名前	説明	型	Status
az sphere device-group create	デバイス グループを作成します。	拡張機能	GA
az sphere device-group create-defaults	製品を対象とする既定のデバイス グループを作成します。	拡張機能	GA
az sphere device-group delete	指定したデバイス グループを削除します。	拡張機能	GA
az sphere device-group list	カタログ内のすべてのデバイス グループを一覧表示します。	拡張機能	GA
az sphere device-group show	デバイス グループの詳細を表示します。	拡張機能	GA
az sphere device-group update	デバイス グループの詳細を更新します。	拡張機能	GA

az sphere device-group create

デバイス グループを作成します。

az sphere device-group create --catalog
                              --description
                              --name
                              --product
                              --resource-group
                              [--allow-crash-dumps-collection {Disabled, Enabled}]
                              [--application-update {No3rdPartyAppUpdates, UpdateAll}]
                              [--os-feed {Retail, RetailEval}]
                              [--regional-data-boundary {EU, None}]

例

リソース グループ "MyResourceGroup"、カタログ "MyCatalog"、製品 "MyProduct"、説明 "MyDescription"、および既定のリージョン データ境界に新しいデバイス グループ "MyDeviceGroup" を作成します。

az sphere device-group create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --name MyDeviceGroup --description MyDescription

リソース グループ "MyResourceGroup"、カタログ "MyCatalog"、製品 "MyProduct"、説明 "MyDescription" に新しいデバイス グループ "MyDeviceGroup" を作成し、地域のデータ境界を指定します。

az sphere device-group create --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --name MyDeviceGroup --description MyDescription --regional-data-boundary EU

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--description -d

デバイス グループの説明。

--name -n

デバイス グループの英数字名。

--product -p

製品名。

開始値: az sphere product list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

省略可能のパラメーター

--allow-crash-dumps-collection -cd

このデバイス グループについて、Microsoft によるクラッシュ ダンプの収集に同意します。 詳細については、https://aka.ms/AzureSphereCrashDumpsCollectionを参照してください。

承認された値: Disabled, Enabled

既定値: Disabled

--application-update -a

このデバイス グループのアプリケーション更新ポリシー。

承認された値: No3rdPartyAppUpdates, UpdateAll

既定値: UpdateAll

--os-feed -f

OS の更新に使用する OS フィードの種類。

承認された値: Retail, RetailEval

既定値: Retail

--regional-data-boundary -r

このデバイス グループの地域データ境界。

承認された値: EU, None

既定値: None

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az sphere device-group create-defaults

製品を対象とする既定のデバイス グループを作成します。

az sphere device-group create-defaults --catalog
                                       --product
                                       --resource-group

例

リソース グループ "MyResourceGroup"、カタログ "MyCatalog"、および製品 "MyProduct" に既定のデバイス グループを作成します。

az sphere device-group create-defaults --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--product -p

製品名。

開始値: az sphere product list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az sphere device-group delete

指定したデバイス グループを削除します。

az sphere device-group delete --catalog
                              --device-group
                              --product
                              --resource-group

例

リソース グループ、カタログ名、製品名、デバイス グループ名を使用してデバイス グループを削除します。

az sphere device-group delete --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--device-group -dg

デバイス グループ名。

開始値: az sphere device-group list

--product -p

デバイス グループを削除する対象の製品。

開始値: az sphere product list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az sphere device-group list

カタログ内のすべてのデバイス グループを一覧表示します。

az sphere device-group list --catalog
                            --resource-group
                            [--device-group]
                            [--product]

例

リソース グループとカタログ内のすべてのデバイス グループを一覧表示します。

az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog

リソース グループとカタログ内の指定した名前を持つすべてのデバイス グループを一覧表示します。

az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog --device-group Development

リソース グループ、カタログ、および製品内のすべてのデバイス グループを一覧表示します。

az sphere device-group list --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

省略可能のパラメーター

--device-group -dg

指定した名前を持つすべてのデバイス グループを一覧表示します。

--product -p

製品内のすべてのデバイス グループを一覧表示します。

開始値: az sphere product list

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az sphere device-group show

デバイス グループの詳細を表示します。

az sphere device-group show --catalog
                            --device-group
                            --product
                            --resource-group

例

リソース グループ、カタログ名、製品名、デバイス グループ名を使用して、デバイス グループの詳細を表示します。

az sphere device-group show --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--device-group -dg

表示するデバイス グループ。

開始値: az sphere device-group list

--product -p

デバイス グループを表示する製品名。

開始値: az sphere product list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az sphere device-group update

デバイス グループの詳細を更新します。

az sphere device-group update --catalog
                              --device-group
                              --product
                              --resource-group
                              [--allow-crash-dumps-collection {Disabled, Enabled}]
                              [--application-update {No3rdPartyAppUpdates, UpdateAll}]
                              [--description]
                              [--os-feed {Retail, RetailEval}]
                              [--regional-data-boundary {EU, None}]

例

デバイス グループのプロパティを更新します。

az sphere device-group update --resource-group MyResourceGroup --catalog MyCatalog --product MyProduct --device-group MyDeviceGroup --description NewDescription

必須のパラメーター

--catalog -c

この操作を実行する Azure Sphere カタログ。 Azure Sphere カタログ名を指定します。 を使用して、既定の Azure Sphere カタログを az config set defaults.sphere.catalog=<name>構成できます。 値の由来: az sphere catalog list。

--device-group -dg

デバイス グループ名。

開始値: az sphere device-group list

--product -p

製品名。

開始値: az sphere product list

--resource-group -g

Azure リソース グループの名前。 az config set defaults.group=<name> を使用して、既定のグループを構成できます。 値の由来: az group list。

省略可能のパラメーター

--allow-crash-dumps-collection -cd

このデバイス グループについて、Microsoft によるクラッシュ ダンプの収集に同意します。 詳細については、https://aka.ms/AzureSphereCrashDumpsCollectionを参照してください。

承認された値: Disabled, Enabled

--application-update -a

このデバイス グループのアプリケーション更新ポリシー。

承認された値: No3rdPartyAppUpdates, UpdateAll

--description -d

デバイス グループの新しい説明。

--os-feed -f

OS の更新に使用する OS フィードの種類。

承認された値: Retail, RetailEval

--regional-data-boundary -r

このデバイス グループの地域データ境界。

承認された値: EU, None

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。