az sphere device capability

Note

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

デバイス機能の構成を管理します。

コマンド

Name 説明 型 状態
az sphere device capability apply

接続されているデバイスに機能セッションを一時的に適用します。

 Extension GA
az sphere device capability download

Azure Sphere Security Service からデバイス機能ファイルをダウンロードします。

 Extension GA
az sphere device capability show-attached

接続されているデバイスの現在のデバイス機能の構成を表示します。

 Extension GA
az sphere device capability update

接続されているデバイスのデバイス機能の構成を更新します。

 Extension GA

az sphere device capability apply

接続されているデバイスに機能セッションを一時的に適用します。

az sphere device capability apply [--acquire-policy-token]
                                  [--capability-file]
                                  [--change-reference]
                                  [--none {false, true}]

例

デバイス機能セッションを一時的に適用します。

az sphere device capability apply --capability-file myCapabilities.cap

一時的に適用されたデバイス機能セッションを終了します。

az sphere device capability apply --none

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--capability-file

機能ファイルのパスとファイル名。 相対または絶対パスを指定できます。

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--none -n

接続されているデバイスで一時的な機能セッションを終了します。

プロパティ 値
規定値: False
指定可能な値: false, true
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az sphere device capability download

Azure Sphere Security Service からデバイス機能ファイルをダウンロードします。

az sphere device capability download --catalog
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--device]
                                     [--output-file]
                                     [--type {ApplicationDevelopment, FieldServicing}]

例

リソース グループ、カタログ名、デバイス ID、および機能を使用して、デバイスの "ApplicationDevelopment" 機能をダウンロードします。

az sphere device capability download --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue> --type ApplicationDevelopment --output-file myCapabilities.cap

リソース グループ、カタログ名、およびデバイス ID を使用して、デバイスの "None" 機能をダウンロードします。

az sphere device capability download --resource-group MyResourceGroup --catalog MyCatalog --device <DeviceIdValue> --output-file myCapabilities.cap

必須パラメーター

--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。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--device -d

このコマンドの対象となるデバイス。 これは、どのデバイスをターゲットにするかを明確にするために、デバイスまたは複数のデバイスが接続されていない場合に必要です。 デバイスが接続されている場合は、デバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 それ以外の場合は、デバイス ID のみを指定する必要があります。

プロパティ 値
値の取得元: az sphere device list
--output-file -of

機能をダウンロードするパスとファイル名。 このパラメーターが設定されていない場合、ファイルは既定の名前 (capability-device.cap) で現在のフォルダーに保存されます。

--type -t

ダウンロードする機能のスペース区切りの一覧。 このパラメーターが設定されていない場合は、機能 "None" がダウンロードされます。

プロパティ 値
指定可能な値: ApplicationDevelopment, FieldServicing
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az sphere device capability show-attached

接続されているデバイスの現在のデバイス機能の構成を表示します。

az sphere device capability show-attached [--acquire-policy-token]
                                          [--change-reference]
                                          [--device]

例

接続されているデバイスのデバイス機能の構成を表示します。

az sphere device capability show-attached

指定したデバイスのデバイス機能の構成を表示します。

az sphere device capability show-attached --device <DeviceIdValue>

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--device -d

複数のデバイスが接続されているときにコマンドを実行するデバイス。 接続されているデバイスの ID、IP アドレス、またはローカル接続 ID を指定します。

プロパティ 値
値の取得元: az sphere device list-attached
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az sphere device capability update

接続されているデバイスのデバイス機能の構成を更新します。

az sphere device capability update --capability-file
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--device]

例

接続されているデバイスのデバイス機能の構成を更新します。

az sphere device capability update --capability-file myCapabilities.cap

指定したデバイスのデバイス機能の構成を更新します。

az sphere device capability update --capability-file myCapabilities.cap --device <DeviceIdValue>

必須パラメーター

--capability-file

適用するデバイス機能構成ファイルのパスとファイル名。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--device -d

複数のデバイスが接続されているときにコマンドを実行するデバイス。 接続されているデバイスの ID、IP アドレス、またはローカル接続 ID を指定します。

プロパティ 値
値の取得元: az sphere device list-attached
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

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

--only-show-errors

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

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False