device

Azure Sphere デバイスを管理します。

操作	説明
app	デバイス上のアプリケーションの状態を変更します。
capability	デバイスの機能を管理します。
証明書 (certificate)	デバイス証明書ストアを管理します。
claim	以前に要求されていないデバイスを Azure Sphere テナントに要求します。
enable-cloud-test	デバッグを無効にして更新プログラムを受信するようにデバイスを設定します。
enable-development	ローカル デバッグ用のデバイスを設定します。
image	デバイスのイメージを管理します。
list	テナント内のすべてのデバイスを表示します。
list-attached	接続されているデバイスを一覧表示します。
manufacturing-state	接続されているデバイスの製造状態を管理します。
network	デバイス上のネットワーク インターフェイスの状態に関する情報を提供します。
recover	特別な回復モードを使用して、新しいファームウェアをデバイスに読み込みます。
rescan-attached	接続されているデバイスをトラブルシューティングの支援として再スキャンします (Windows のみ)。
restart	接続されたデバイスを再起動します。
show	デバイスの更新構成に関する詳細を表示します。
show-attached	デバイス自体から接続されているデバイスに関する詳細を表示します。
show-count	テナント内のデバイスの合計数を表示します。
show-deployment-status	最新の展開更新プログラムの状態を表示します。
show-os-version	ローカル デバイスのオペレーティング システムのバージョンを表示します。
sideload	接続されているデバイスにイメージを読み込みます。
update	特定のデバイス グループに配置してデバイスを更新します。
wifi	デバイスの Wi-Fi 構成を管理します。

app

デバイス上のアプリケーションを管理します。

アプリ オプションの多くは、 appDevelopment 機能を必要とします。この機能は、 azsphere device enable-development を使用して取得できます。 SDK 署名済みアプリケーションまたは製品署名済みアプリケーションを開始、停止、またはデバッグする場合、デバイスは appDevelopment 機能を備えている必要があります。

azsphere device app stop と azsphere device app start を使用して、実行中のリアルタイム対応アプリケーションを再起動して、実行されているリアルタイム コアを特定できます。

操作	説明
show-memory-stats	接続されているデバイス上のアプリケーションのメモリ統計を表示します。
show-quota	デバイス上の現在のアプリケーションによって使用されているストレージの量を表示します。
show-status	デバイス上の現在のアプリケーションの状態を返します。
start	デバイスに読み込まれているアプリケーションを開始します。
stop	デバイス上で実行されているアプリケーションを停止します。

app show-memory-stats

接続されているデバイス上のアプリケーションのメモリ統計を表示します。 このコマンドは、 appDevelopment デバイス機能が構成されている場合にのみ使用できます。 メモリ割り当ての追跡が構成されている場合は、追加情報が表示されます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 app show-memory-stats
 -------------- -------------
 Name           Usage (bytes)
 ============================
 Total          434176
 User Mode      147456
 Peak User Mode 147456
 -------------- -------------

app show-quota

接続されたデバイス上の変更可能ストレージの割り当て済み使用量を表示します。

アプリケーション マニフェストで不変ストレージクォータを設定しファイルにセクターを割り当てるときに Azure Sphere OS によってクォータが適用されます。 このため、MutableStorage 値を小さくすると、ストレージの使用量は変わりませんが、報告される割り当て済みの値は変わります。 たとえば、アプリケーションが既に 16 KB を使用していて、 MutableStorage の値を 8 KB に変更した場合、コマンドは、割り当てられた 8 KB の 16 KB をアプリケーションが使用することを報告します。 データはデバイスに残ります。

省略可能なパラメーター

パラメーター	型	説明
-i、--component-id	GUID	クォータ情報を取得するコンポーネントの ID を指定します。 省略すると、すべてのコンポーネントのクォータ情報が表示されます。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 app show-quota
ae4714aa-03aa-492b-9663-962f966a9cc3: 0KB out of 8KB of mutable storage used.

app show-status

デバイス上のアプリケーションの現在の状態を表示します。

省略可能なパラメーター

パラメーター	型	説明
-i、--component-id	GUID	状態を表示するコンポーネントの ID を指定します。 省略した場合は、すべてのコンポーネントの状態を表示します。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 app show-status
9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
App state: running

app start

デバイス上のアプリケーションを開始します。

省略可能なパラメーター

パラメーター	型	説明
--debug-mode	Boolean	デバッグのためにアプリケーションを開始します。 --component-idを指定する必要があります。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-i、--component-id	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 app start
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: running
Core     : High-level

app stop

デバイス上のアプリケーションを開始します。

省略可能なパラメーター

パラメーター	型	説明
-i、--component-id	GUID	停止するコンポーネントの ID を指定します。 省略した場合、すべてのアプリケーションが停止します。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 app stop
836cbcf1-0b4d-45ab-963a-eadcd5017b6a
App state: stopped

機能

デバイスの機能を管理します。 Azure Sphere の個々のデバイスで実行できる操作は、デバイス機能によって決まります。

デバイス機能は、 azsphere device capability download コマンドを使用して、Azure Sphere Security Service からファイルとしてダウンロードされます。 azsphere device capability update コマンドを使用して、接続されている Azure Sphere デバイスにデバイス機能の構成を適用できます。また、azsphere device capability select コマンドを使用してサービス セッションを作成できます。 デバイスの機能の詳細については、「 Device の機能と通信を参照してください。

操作	説明
download	Azure Sphere Security Service からデバイス機能の構成をダウンロードします。
選択	サービス セッションに使用するダウンロードした機能ファイルを選択します。
show-attached	接続されているデバイスの機能構成を表示します。
update	接続されているデバイスにデバイスの機能構成を適用します。

capability download

Azure Sphere Security Service からデバイスの機能をダウンロードできます。

appDevelopment 機能を使用すると、SDK 署名済みアプリケーションをサイドロードし、デバイス上の任意のアプリケーションを開始、停止、デバッグ、または削除することができます。 appDevelopment 機能を使用しない場合、クラウドで読み込まれたアプリケーションに対する操作は読み込みのみが可能で、開始、停止、デバッグ、および削除は禁止されます。 appDevelopment 機能は azsphere device enable-development コマンドの一部として適用されます。

fieldServicing 機能をダウンロードすると、1 台の Azure Sphere デバイスの機能を含むファイルが生成されます。 fieldServicing 機能ファイルがお使いのローカル コンピューターにダウンロードされ、azsphere device capability select コマンドと共に使用できるようになります。

必須のパラメーター

パラメーター	型	説明
--type	Capability-type	ダウンロードするデバイス機能の種類を指定します。 値は、appDevelopment、fieldServicing または none です。 appDevelopment 機能または fieldServicing 機能を削除するには、none を使用します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
--行き先	String	機能構成を保存するパスとファイル名を指定します。 絶対パスまたは相対パスを含めます。 パスを指定しない場合、コマンドは、デバイス ID >.cap の名前付け規則<キャパビリティ型><最初の 8 文字を使用して、ローカル ディレクトリにファイルを格納します。
-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 capability download --type appDevelopment
The appdevelopment capability was saved as:
 --------------------------------------------
 Result
 ============================================
 C:\capability-file\appdevelopment-<first eight characters of device ID>.cap
 --------------------------------------------

capability select

接続されている Azure Sphere デバイスで使用する機能ファイルを選択できます。

azsphere device capability select コマンドはどの機能でも使用できますが、サービス セッションを有効にするために fieldServicing 機能で最も頻繁に使用されます。 すべてのユーザー ロールは、azsphere device capability select コマンドにアクセスできます。

fieldServicing 機能を使用した場合、Azure Sphere デバイスと機能ファイルを含むローカル コンピューター間で通信が有効になります。 fieldServicing 機能ファイルは、ローカル コンピューターと Azure Sphere デバイス間のセッションで使用され、そのセッション内の各コマンドには、機能ファイルが使用されていることを示すメッセージが付加されます。

サービス セッションを終了するには、azsphere device capability select --none を使用します。

省略可能なパラメーター

パラメーター	型	説明
--capability-file	String	選択するデバイス機能構成ファイルのパスとファイル名を指定します。 相対または絶対パスを指定できます。
-n、--none	-	以前に選択したデバイス機能の構成を消去します。

グローバル パラメーター

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 capability select --capability-file appdevcap
The capability session uses C:\capability-file\appdevcap.

capability show-attached

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

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableFieldServicing
 --------------------

azsphere device capability show-attached
 --------------------
 DeviceCapabilities
 ====================
 EnableAppDevelopment
 --------------------

capability update

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

必須のパラメーター

パラメーター	型	説明
--capability-file	String	適用するデバイス機能ファイルのパスとファイル名を指定します。 相対または絶対パスを指定できます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 capability update --capability-file appdevcap.bin
Using selected capability file: C:\capability-file\appdevcap.bin
The capability file C:\capability-file\appdevcap.bin was added on the device. The device will restart.

certificate

接続されているデバイスの証明書を管理します。

操作	説明
add	接続されているデバイスの証明書ストアに証明書を追加します。
delete	接続されているデバイスの証明書ストアから証明書を削除します。
list	接続されているデバイスの証明書ストアで使用できる証明書 ID を一覧表示します。
show	接続されているデバイスの証明書ストア内の証明書の詳細を表示します。
show-quota	接続されているデバイスの証明書ストアで使用可能な空き領域を表示します。

certificate add

接続されているデバイスの証明書ストアに証明書を追加します。

Azure Sphere デバイスに証明書を読み込むには、ルート CA およびクライアント証明書が .pem 形式である必要があります。 デバイスのクライアント証明書と秘密キー (および必要に応じて秘密キーのパスワード) と共に、適切なサーバーからルート CA 証明書を取得する必要があります。 各証明書は、EAP-TLS ネットワーク内の適切なサーバーによって生成および署名される必要があります。 ネットワーク管理者またはセキュリティ チームは、証明書を取得するために必要な詳細情報を提供できます。 ルート CA 証明書の取得の詳細については、「 EAP-TLS ネットワークの証明書を取得して展開するを参照してください。

必須のパラメーター

パラメーター	型	説明
-i、--cert-id	String	追加する証明書の識別子を指定します。 文字列識別子 (最大 16 文字)。 有効な文字には、大文字 (A ~ Z)、小文字 (a ~ z)、数字 (0 ~ 9)、アンダースコア (_)、ピリオド (.)、ハイフン (-) が含まれます。 この識別子は、EAP-TLS ネットワークの Wi-Fi 構成でも使用されます。
--cert-type	String	追加する証明書の種類 (クライアントまたはルートカ) を指定します。
-p、--public-key-file	String	公開キー証明書 .pem ファイルへのパスを指定します。 相対または絶対パスを指定できます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
--private-key-file	String	クライアント秘密キー証明書 .pem ファイルへのパスを指定します。 クライアント型の証明書を追加するときに必要です。 相対または絶対パスを指定できます。
-w、--private-key-password	String	クライアント秘密キーの省略可能なパスワードを指定します。 パスワードは、暗号化されたクライアント証明書の秘密キーを追加する場合に必須です。

グローバル パラメーター

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 certificate add --cert-id certroot --cert-type rootca --public-key-file publiccert.pem
Certificate 'certroot' successfully added.

azsphere device certificate add --cert-id certclient --cert-type client --private-key-file privatekey.pem --private-key-password 1234 --public-key-file publiccert.pem
Certificate 'certclient' successfully added.

certificate delete

接続されているデバイスの証明書ストアから証明書を削除します。

必須のパラメーター

パラメーター	型	説明
-c、--certificate または --cert-id [廃止]	String	削除する証明書の識別子を指定します。 --cert-id引数は廃止され、今後のリリースで削除される予定です。 詳細については、「 Azure Sphere CLI での変更のインポート (廃止機能)を参照してください。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 certificate delete --certificate certclient

certificate list

デバイスの証明書ストアで使用できる証明書を一覧表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 certificate list
 -----------
 Identifiers
 ===========
 rootCert
 -----------

certificate show

デバイスの証明書ストア内の個々の証明書の詳細を表示します。

必須のパラメーター

パラメーター	型	説明
-c、--certificate または --cert-id [廃止]	String	詳細を表示する証明書の識別子を指定します。 --cert-id引数は廃止され、今後のリリースで削除される予定です。 詳細については、「 Azure Sphere CLI での変更のインポート (廃止機能)を参照してください。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 certificate show --certificate certclient
---------- ------------------- ------------------- ----------------------------------- -----------------------------------
 Id         StartDate           EndDate             SubjectName                         IssuerName
 ==========================================================================================================================
 certclient 06/08/2019 19:15:48 06/08/2069 19:25:44 /DC=local/DC=azsphere/CN=azsphereca /DC=local/DC=azsphere/CN=azsphereca
 ---------- ------------------- ------------------- ----------------------------------- -----------------------------------

certificate show-quota

接続されているデバイスの証明書ストアで使用可能な空き領域を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 certificate show-quota
--------------
Available space (bytes)
==============
24514
--------------

claim

現在の Azure Sphere テナントに対してまだ要求されていないデバイスを要求します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-t、--tenant	GUID または名前	この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。
--force	Boolean	現在のユーザーが選択した Azure Sphere テナントでデバイスを強制的に要求します。

グローバル パラメーター

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 claim
warn: You are claiming a device to the following tenant:
warn: a323c263-2aa3-2559-aabb-a3fc32631900 (Tenant1)
warn: Do you want to claim the device ID 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968 to this tenant?
warn: You cannot change the Azure Sphere tenant this device is claimed to once this action has completed.
Enter 'yes' to continue. Enter anything else to exit.
> yes
Claiming device.
Successfully claimed device ID '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968' into tenant 'Tenant1' with ID 'a323c263-2aa3-2559-aabb-a3fc32631900'.

enable-cloud-test

アプリケーション開発を無効にする、既存のアプリケーションを削除する、クラウドで読み込まれるアプリケーションの更新を有効にすることで、接続されているデバイスをクラウドでの読み込みテストのために準備をします。

これは、デバイスを PC に接続する必要があります。また、接続されているデバイス上でのみ動作します。

具体的には、enable-cloud-test は以下を行います。

• 接続されているデバイスの appDevelopment 機能を削除します。
• クラウドで読み込まれたアプリケーションの更新を有効にするデバイス グループにデバイスを割り当てます。
• デバイスを再起動します。

enable-cloud-test が実行する具体的なタスクは、製品とデバイス グループが既にこのデバイス用に割り当てられているかどうかによって変わります。

azsphere device enable-cloud-test がパラメーターなしで実行された場合、デバイスはデバイスの現在の製品のフィールド テスト デバイス グループに配置されます。 これは、各製品に対して自動的に作成される既定のデバイス グループの 1 つで、これによってアプリケーションの更新が可能になります。 デバイスに製品がない場合、またはフィールド テスト デバイス グループが存在しない場合は、エラーが返されます。

製品が指定されている場合、デバイスはその製品のフィールド テスト デバイス グループに配置されます。 このデバイス グループが存在しない場合は、エラーが返されます。

デバイス グループが指定されている場合は、その中にデバイスが配置されます。 ターゲット デバイス グループでアプリケーションの更新が有効になっていない場合は、エラーが返されます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-p、--product	GUID または名前	ターゲット製品を指定します。 これを指定すると、 --device-group も指定されていない限り、デバイスはこの製品の既定のフィールド テスト デバイス グループに移動されます。 Azure Sphere 製品の ID または名前を指定できます。
-t、--tenant	GUID または名前	この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。
-g、--device-group	GUID または名前	デバイスの移動先となるデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。 既定では、これは製品のフィールド テスト デバイス グループです。

グローバル パラメーター

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 を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。

例

例 1. デバイスを ID で既存のデバイス グループに割り当てる

この例では、接続されているデバイスを既存の製品とデバイス グループに割り当てます。

azsphere device enable-cloud-test --device-group '3548b179-m16f-4f64-6dme-d3c643662e76'
Your internal capabilities will be retained, including the Enable App development capability. Sideloaded images may be removed by over-the-air application updates.
Getting device group by ID '3548b179-m16f-4f64-6dme-d3c643662e76'.
Leaving any existing applications on the device.
Setting device group to 'Field Test' with ID '3548b179-m16f-4f64-6dme-d3c643662e76')
Successfully updated device's device group.
Successfully set up device for application updates.
(Device ID: 'ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD')

例 2. 別のデバイス グループにデバイスを割り当てる

この例は前の例と似ていますが、デバイスの既存の製品は保持されます。 この例の enable-cloud-test 操作では、デバイスが属するデバイス グループが変更され、appDevelopment 機能は削除されます。 このコマンドは、アプリケーションの更新を有効にしていない開発環境のデバイスを、更新が有効な運用環境に移行する場合に便利です。

azsphere device enable-cloud-test --device-group "Marketing/Field Test"

例 3. 製品名でデバイスを割り当てる

この例では、クラウドでの読み込みを有効にして、デバイスを名前で製品に割り当てます。

azsphere device enable-cloud-test --product DW100

enable-development

デバイスでサイドローディングとデバッグを有効にし、クラウドからのアプリケーションの更新を無効にするデバイス グループに割り当てることで、デバイスを開発できるようにします。 既定では、これはデバイスの製品の開発デバイス グループですが、他のデバイス グループを指定できます。 製造シナリオでは使用しないでください。 詳細については、「 接続されたデバイスの製造 」を参照してください。

具体的には、enable-development は以下を行います。

• 接続されているデバイスの appDevelopment 機能をダウンロードして適用します。
• クラウドで読み込まれたアプリケーションの更新を有効にしないデバイス グループにデバイスを割り当てます。
• デバイスを再起動します。

パラメーターを指定 azsphere device enable-development コマンドを実行する場合:

• デバイスに既に製品およびデバイス グループがない場合、このコマンドを実行すると、接続されているデバイスのために appDevelopment 機能がダウンロードされて適用され、デバイスが再起動されます。 既存のアプリはデバイスに残り、OS は更新されます。 デバイスを要求するインストール プロセスと、高度なアプリケーションを構築するためのクイック スタートは影響を受けません。
• デバイスに既に製品がある場合、このコマンドはデバイスを製品の Development デバイス グループに移動します。 既定では、このグループのアプリケーション更新プログラムは無効になっており、サイドロードされたアプリが上書きされないようにします。

--product パラメーターを指定して azsphere device enable-development コマンドを実行する場合:

• デバイスを製品の開発デバイス グループに配置します。 このデバイス グループが存在しない場合は、エラーが返されます。

--device-group パラメーターを指定して azsphere device enable-development コマンドを実行する場合:

• 指定したデバイス グループ内にデバイスを配置することが指定されます。 ターゲット デバイス グループは、アプリケーションの更新を有効にしないか、エラーが返される必要があります。

場合によって、azsphere device enable-development によってエラーが報告され、デバイスを要求することが提案されます。 デバイスを既に要求済みの場合は、azsphere tenant show-selected を使用して、そのデバイスを要求したテナントにログインしていることを確認してください。 そうでない場合は、azsphere login を使用して正しいテナントにログインします。 適切なテナントにログインしていることを確認したら、 azsphere device claim を使用してデバイスを要求します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-g、--device-group	GUID または名前	デバイスの移動先となるデバイス グループを指定します。 省略した場合は、デバイスを既定グループに割り当てます。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。
-r、--enable-rt-core-debugging	Boolean	リアルタイム コアで実行されているアプリケーションのデバッグに必要なドライバーをインストールします。 このオプションには、管理者のアクセス許可が必要です。
-p、--product	GUID または名前	ターゲット製品を指定します。 この値を指定すると、--device-groupも指定されていない限り、デバイスはこの製品の既定の Development デバイス グループに移動されます。 Azure Sphere 製品の 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 enable-development
Capability configuration has been successfully cleared.
PS C:\Users\v-shypr> azsphere device enable-development
Getting device group 'Development' for product 'DW100'.
The device already has the 'Enable App development' capability. No changes will be applied to its existing capabilities.
Setting device group to 'Development' with ID '7f860cc1-4949-4000-a541-9a988ba4c3cd'.
Successfully disabled application updates.
Installing debugging server to device.
Deploying 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' to the attached device.
Image package 'C:\Program Files (x86)\Microsoft Azure Sphere SDK\DebugTools\gdbserver.imagepackage' has been deployed to the attached device.
Previous device capabilities retained. Ensure that you have the correct development capabilities installed before continuing.
Successfully set up device for application development, and disabled application updates.
(Device ID: '352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968')

image

接続されているデバイスにインストールされている、またはターゲットが設定されているイメージに関する情報を返します。

操作	説明
list-installed	接続されているデバイスに現在インストールされているイメージの詳細を提供します。
list-targeted	接続されているデバイスにターゲットが設定されているイメージに関する詳細を表示します。

image list-installed

接続されているデバイスにインストールされているイメージを一覧表示します。 情報の一覧には、コンポーネント ID とイメージ ID が含まれます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-f、--full	Boolean	デバイスにインストールされているすべてのソフトウェア イメージを一覧表示します。 既定では、アプリケーション イメージ、デバッガー、およびボード構成イメージのみを一覧表示します。

グローバル パラメーター

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 image list-installed
Installed images:
 --> gdbserver
   --> Image type:   Application
   --> Component ID: 8548b129-b16f-4f84-8dbe-d2c847862e78
   --> Image ID:     dc6205bd-4478-4c9b-81ad-5e41ac23ed68
 --> CrashApplicatio
   --> Image type:   Application
   --> Component ID: 9ce57001-90eb-45e1-bd0a-4fc07b0c85c9
   --> Image ID:     cc77124e-6447-4c0f-9f99-fc0ad5ef46ef

image list-targeted

Azure Sphere Security Service にアップロードされ、デバイスの更新時にインストールされるイメージを一覧表示します。 Azure Sphere デバイスがクラウドベースのアプリケーション更新プログラムを受け入れる準備ができていることを確認する方法の詳細については、「 デバイスのクラウドベースのデプロイを有効にするを参照してください。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-t、--tenant	GUID または名前	この操作を実行するテナントを指定します。 選択した既定のテナントをオーバーライドします。 テナント ID またはテナント名を指定できます。
-f、--full	Boolean	Azure Sphere テナント内のすべてのイメージを一覧表示します。

グローバル パラメーター

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 image list-targeted
 ----------------------- ------------------------------------ ------------------------------------ ---------------- --------------------
 Name                    ComponentId                          ImageId                              ImageType       RegionalDataBoundary 
 =======================================================================================================================================
 HelloWorld_HighLevelApp 1689d8b2-c835-2e27-27ad-e894d6d15fa9 50419cb6-a33b-4cbe-8bd0-425048664b6f Applications    None   
 ----------------------- ------------------------------------ ------------------------------------ -------------------------------------   

list

テナント内のすべてのデバイスを一覧表示します。 最初の 500 台のデバイスの後に一覧が切り捨てられます。

省略可能なパラメーター

パラメーター	型	説明
-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 list
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 4f48d618-09f7-45dc-a5a4-1433cabbee91 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

--query パラメーターを使用して、このコマンドに表示される出力をカスタマイズできます。 詳細については、 Query CLI コマンドの出力を参照してください。

次の例は、デバイス ID と製品 ID のみを選択する方法を示しています。

azsphere device list --query '[].{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABDFAC6466B573A0FF9ABA38BABCD40ABCD 4f48d618-09f7-45dc-a5a4-1433cabbee91
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

list-attached

ローカル PC に接続されているデバイスを一覧表示します。

グローバル パラメーター

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 list-attached
1 device attached:
--> Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
  --> Is responsive: yes
  --> IP address: 192.128.48.1
  --> Connection path: 21143

manufacturing-state

接続されているデバイスの製造状態を管理します。

操作	説明
show	接続されているデバイスの製造状態を表示します。
update	接続されているデバイスの製造状態を更新します。

manufacturing-state show

接続されているデバイスの製造状態を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 manufacturing-state show
------------------
ManufacturingState
==================
Module1Complete
------------------

manufacturing-state update

接続されているデバイスの製造状態を更新します。 詳細については、「 デバイスの製造状態を設定するを参照してください。

必須のパラメーター

パラメーター	型	説明
-s、--state	製造状態	デバイスに設定する製造状態を指定します。 使用可能な状態には、 DeviceComplete と Module1Completeが含まれます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 manufacturing-state update --state Module1Complete
Updating manufacturing state to Module1Complete.
Restarting device for changes to take effect.
The device was successfully restarted.

network

接続されているデバイス上のネットワーク インターフェイスの状態に関する情報を提供します。

操作	説明
enable	接続されているデバイスのネットワーク インターフェイスを有効にします。
disable	接続されているデバイスのネットワーク インターフェイスを無効にします。
list-firewall-rules	接続されているデバイスのファイアウォール規則を一覧表示します。
list-interfaces	接続されているデバイスのネットワーク インターフェイスを一覧表示します。
プロキシ	ネットワーク プロキシ設定を管理します。
show-diagnostics	接続されているデバイス上の 1 つまたはすべてのワイヤレス ネットワークのネットワーク診断を表示します。
show-status	接続されているデバイスのネットワーク状態を表示します。
update-interface	デバイスのネットワーク インターフェイス構成を更新します。

ネットワークの有効化

接続されているデバイスのネットワーク インターフェイスを有効にします。

必須のパラメーター

パラメーター	型	説明
--インターフェイス	string	有効にするインターフェイスを指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network enable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

ネットワークの無効化

接続されているデバイスのネットワーク インターフェイスを無効にします。

必須のパラメーター

パラメーター	型	説明
--インターフェイス	string	有効にするインターフェイスを指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network disable --interface wlan0
Network interface configuration is successfully applied to the device.
Run the command 'azsphere device network list-interfaces' to view details of the network interfaces for the attached device.

network list-firewall-rules

接続されているデバイスのファイアウォール規則を一覧表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

次のルールが表示されます。

• ファイアウォール規則セット名: ファイアウォール規則セット ブロックの名前を表示します。
  • 値は、 PREROUTING、 POSTROUTING、 INPUT、 FORWARD、および OUTPUT です。
• [ルールセットは有効です: ルールセットの状態を表示します。 値は True または False です。
• ファイアウォール規則セットの規則: 次の規則の値を表示します。
  • 送信元 IP: 送信元マシンの IP アドレスを表示します。
  • ソース マスク: 送信側マシンのネットワーク マスクを表示します。
  • 宛先 IP: 宛先マシンの IP アドレスを表示します。
  • 宛先マスク: デストメーション マシンのネットワーク マスクを表示します。
  • UID: ルールに適用されたユーザー ID を表示します。 4294967295 (0xFFFFFFFF) は、UID が適用されていないことを意味するため、すべてのユーザーに適用されます。
  • アクション: 実行するアクションを表示します。 値には、 accept または drop を指定できます。
  • インターフェイス IN 名: 入力インターフェイス名を表示します。 たとえば、 wlan0。
  • インターフェイス OUT 名: 出力インターフェイス名を表示します。 たとえば、 wlan0。
  • 状態: 接続状態を表示します。 値は none、 established、または 関連。
  • TCP マスク: TCP マスクの配列を表示します。 値は、 fin、 syn、 rst、 psh、 ack、および urg です。
  • TCP Cmp: TCP フラグの配列を表示します。 値は、 urg、 ack、 psh、 rst、 syb、および fin です。
  • TCP Inv: ブール値は、TCP フラグの意味を反転する必要があることを示します。 値は True または False です。
  • プロトコル: ファイアウォール規則のプロトコルを表示します。 値は、 icmp、 igmp、 tcp、 udpです。
  • 送信元ポート範囲: トラフィックを送信する送信元からのポート範囲を表示します。 値は 0 から 65535 の間で指定できます。
  • 宛先ポート範囲: トラフィックを受信する宛先のポート範囲を表示します。 値は 0 から 65535 の間で指定できます。
  • パケット: パケットの数を表示します。
  • Bytes: バイト数を表示します。

フラグの簡単な概要を次に示します。

• URG: 緊急ポインター フィールドの有効
• ACK: 受信確認フィールドが有効
• PSH: プッシュ関数
• RST: 接続をリセットする
• SYN: シーケンス番号を同期する
• FIN: 送信者からのデータはこれ以上ありません

グローバル パラメーター

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 network list-firewall-rules
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 Ruleset     IsValid SourceIp     SourceMask      DestinationIp   DestinationMask UID        Action InterfaceInName TcpInv Protocol SourcePortRange DestinationPortRange Packets Bytes  TcpMask TcpCmp
 =====================================================================================================================================================================================================
 PREROUTING  False   None         None            None            None            None       None   None            None   None     None            None                 None    None   None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  any      0-65535         0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 True   tcp      0-65535         0-65535              823     394754 syn,ack syn
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    192.168.35.1 <value>         <value>         <value>         <value>     accept azspheresvc     False  any      0-65535         0-65535              15      780    None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------
 INPUT       True    <value>      <value>         <value>         <value>         <value>     accept                 False  udp      53-53           0-65535              0       0      None    None
 ----------- ------- ------------ --------------- --------------- --------------- ---------- ------ --------------- ------ -------- --------------- -------------------- ------- ------ ------- ------

network list-interfaces

接続されているデバイスのネットワーク インターフェイスを一覧表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network list-interfaces
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 InterfaceName InterfaceUp ConnectedToNetwork IpAcquired IpAddresses   ConnectedToInternet IpAssignment HardwareAddress
 ========================================================================================================================
 azspheresvc   True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 eth0          True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 lo            True        False              False      <value>       False               None         None
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------
 wlan0         True        True               True       <value>       True                dynamic      <value>
 ------------- ----------- ------------------ ---------- ------------- ------------------- ------------ -----------------

ネットワーク プロキシ

ネットワーク接続のプロキシ アドレスの使用を管理します。 プロキシ サーバー経由でインターネットに接続するように Azure Sphere デバイスを構成する方法の詳細については、「 プロキシ サーバー経由での接続を参照してください。

操作	説明
proxy apply	接続されているデバイスでネットワーク プロキシを構成します。
proxy delete	接続されているデバイスのプロキシ接続を削除します。
proxy show	接続されているデバイス上のプロキシ接続を表示します。

proxy apply

接続されているデバイスでネットワーク プロキシを構成します。

必須のパラメーター

パラメーター	型	説明
-a、--address	String	使用するプロキシのネットワーク アドレスを指定します。
-t、--authentication	String	使用する認証の種類を指定します。 指定できる値は anonymous または basic です。 プロキシでユーザー名とパスワードが必要な場合は、これを basic に設定し、それ以外の場合は anonymous を使用します。
-r、--port	Integer	使用するネットワーク アドレスのポートを指定します。 値は 65535 以下である必要があります。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
--エネーブル	String	プロキシを有効にするかどうかを指定します。 --enableまたは--disableを設定する必要があります。
--無効にする	String	プロキシを無効にするかどうかを指定します。 --enableまたは--disableを設定する必要があります。
-n、--no-proxy-addresses	String	プロキシ接続でデバイスが回避する必要がある、スペースで区切られたネットワーク アドレスの配列を指定します。
-p、--password	String	基本認証にのみ使用されるプロキシ認証のパスワードを指定します。 最大長: 64 文字。
-u、--username	String	プロキシ認証のユーザー名を指定します。 基本認証にのみ使用されます。 最大長: 64 文字。

グローバル パラメーター

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 network proxy apply --address contoso.com --authentication anonymous --port 8080 --enable
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

proxy delete

接続されているデバイスのプロキシ接続を削除します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network proxy delete

proxy show

接続されているデバイス上のプロキシ接続を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network proxy show
 ----------- ------- ----- ------------------ ----------------
 Address     Enabled Port  AuthenticationType NoProxyAddresses
 =============================================================
 contoso.com True   8080  anonymous
 ----------- ------- ----- ------------------ ----------------

network show-diagnostics

接続されているデバイス上の 1 つまたはすべての Wi-Fi ネットワークの診断を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-n、--network	Integer	診断を表示する Wi-Fi ネットワークの 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 network show-diagnostics
 ------------------------- --------- ----- ------------- --------------- --------
 Timestamp                 NetworkId Ssid  ConfigState   ConnectionState Error
 ================================================================================
 2021-06-16T20:51:29+00:00 0         <value> temp-disabled disconnected    WrongKey
 ------------------------- --------- ----- ------------- --------------- --------

network show-status

接続されているデバイスのネットワーク状態を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network show-status
 --------------------------- --------------- -----
 DeviceAuthenticationIsReady NetworkTimeSync Proxy
 =================================================
 True                        complete        ready
 --------------------------- --------------- -----

network update-interface

デバイスのイーサネット ネットワーク インターフェイスを更新します。 デバイスの MAC アドレスの設定の詳細については、「 イーサネットのデバイスを構成するを参照してください。

必須のパラメーター

パラメーター	型	説明
--hardware-address	String	デバイスに設定するハードウェア アドレスを、 AA:BB:33:DD:EE:FF または aa:bb:33:dd:ee:ffのいずれかの形式で指定します。
--インターフェイス または --interface-name [廃止]	String	構成するインターフェイスの名前を指定します。 azsphere device network list-interfaces を実行して、接続されているデバイスのネットワーク インターフェイスの詳細を表示します。 --interface-name引数は廃止され、今後のリリースで削除される予定です。 詳細については、「 Azure Sphere CLI での変更のインポート (廃止機能)を参照してください。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 network update-interface --interface eth0 --hardware-address ba:98:76:54:32:10

recover

デバイス上のシステム ソフトウェアを置き換えます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 現在接続されているデバイスは、既定で使用されます。 デバイスの ID、IP アドレス、またはローカル接続 ID を指定します。
-c、--capability	String	回復中にデバイスに適用するデバイス機能イメージを指定します。
-i、--images	String	デバイスに書き込むイメージ パッケージを含むフォルダーへのパスを指定します。 このフラグを使用して代替パスを指定しない限り、復旧では SDK 内のイメージが既定で使用されます。

グローバル パラメーター

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 を使用している場合は、使用可能なオプションの詳細については、 グローバル パラメーター を参照してください。

例

例 1:

azsphere device recover
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 17 images. (5443272 bytes to send)
Sent 1 of 17 images. (5440896 of 5443272 bytes remaining)
Sent 2 of 17 images. (5414844 of 5443272 bytes remaining)
Sent 3 of 17 images. (5311892 of 5443272 bytes remaining)
Sent 4 of 17 images. (5311500 of 5443272 bytes remaining)
Sent 5 of 17 images. (5041520 of 5443272 bytes remaining)
Sent 6 of 17 images. (5024908 of 5443272 bytes remaining)
Sent 7 of 17 images. (4994856 of 5443272 bytes remaining)
Sent 8 of 17 images. (2397456 of 5443272 bytes remaining)
Sent 9 of 17 images. (885796 of 5443272 bytes remaining)
Sent 10 of 17 images. (861220 of 5443272 bytes remaining)
Sent 11 of 17 images. (758608 of 5443272 bytes remaining)
Sent 12 of 17 images. (135796 of 5443272 bytes remaining)
Sent 13 of 17 images. (70048 of 5443272 bytes remaining)
Sent 14 of 17 images. (41164 of 5443272 bytes remaining)
Sent 15 of 17 images. (32768 of 5443272 bytes remaining)
Sent 16 of 17 images. (16384 of 5443272 bytes remaining)
Sent 17 of 17 images. (0 of 5443272 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

例 2:

azsphere device recover --capability "C:\Users\capability file\capability_352FE1F_5.bin"
Downloading recovery images...
Download complete.
Starting device recovery. Please note that this may take up to 10 minutes.
Board found. Sending recovery bootloader.
Erasing flash.
Sending 16 images. (5474668 bytes to send)
Sent 1 of 16 images. (5447384 of 5474668 bytes remaining)
Sent 2 of 16 images. (5343788 of 5474668 bytes remaining)
Sent 3 of 16 images. (5343396 of 5474668 bytes remaining)
Sent 4 of 16 images. (5073416 of 5474668 bytes remaining)
Sent 5 of 16 images. (5056612 of 5474668 bytes remaining)
Sent 6 of 16 images. (5026240 of 5474668 bytes remaining)
Sent 7 of 16 images. (2479376 of 5474668 bytes remaining)
Sent 8 of 16 images. (889892 of 5474668 bytes remaining)
Sent 9 of 16 images. (865316 of 5474668 bytes remaining)
Sent 10 of 16 images. (754512 of 5474668 bytes remaining)
Sent 11 of 16 images. (135796 of 5474668 bytes remaining)
Sent 12 of 16 images. (70048 of 5474668 bytes remaining)
Sent 13 of 16 images. (41164 of 5474668 bytes remaining)
Sent 14 of 16 images. (32768 of 5474668 bytes remaining)
Sent 15 of 16 images. (16384 of 5474668 bytes remaining)
Sent 16 of 16 images. (0 of 5474668 bytes remaining)
Finished writing images; rebooting board.
Device ID: 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968
Device recovered successfully.

rescan-attached

すべての FTDI ポートの電源を入れ替えることで、接続されているデバイスを再スキャンし、接続されているデバイスの合計数を表示します。 Windows でデバイス接続の問題 トラブルシューティングを行う場合は このコマンドを使用します。 このコマンドは Windows でのみ実行されます。

グローバル パラメーター

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 rescan-attached
 -----------
 Count
 ===========
 2
 -----------

やり直し

接続されたデバイスを再起動します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 restart
Restarting device.
Device restarted successfully.

show

Azure Sphere テナントに接続されているデバイスの詳細を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-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 show
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                                                         TenantId                             ChipSku  ProductId                            DeviceGroupId
 ========================================================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------ -------- ------------------------------------ ------------------------------------

--query パラメーターを使用して、このコマンドに表示される出力をカスタマイズできます。 詳細については、 Query CLI コマンドの出力を参照してください。

次の例は、デバイス ID と製品 ID のみを選択する方法を示しています。

azsphere device show --device 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

show-attached

接続されているデバイスから取得したそのデバイスに関する情報を表示します。 これらの詳細は、Azure Sphere Security Service がデバイス用に保存しているものとは異なります。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 show-attached
Device ID: 352fe1f59e40ef8a9266415e81af32b5b07d8f2bbd6b5650cef4a70b86c7fcbc70b129a41fbc6d02f8bb4aaabc52cd5740c85427d205e46a166b7e41135eb968
IP address: 192.128.48.1
Connection path: 21143

show-deployment-status

デバイスのアプリケーションおよびオペレーティング システムの更新プログラムのデプロイ状態が表示されます。

このコマンドを使用して、デバイスが動作している Azure Sphere OS のバージョン、または現在のデプロイの更新が完了しているかどうかを調べます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-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 show-deployment-status
Your device is running Azure Sphere OS version <version-number>.
The Azure Sphere Security Service is targeting this device with Azure Sphere OS version <version-number>.
Your device has the expected version of the Azure Sphere OS: <version-number>.

この例では、 <バージョン番号> は現在のオペレーティング システムのバージョンを表します。

show-count

現在のテナント内のデバイスの数を表示します。

省略可能なパラメーター

パラメーター	型	説明
-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 show-count
 ------
 Result
 ======
 2
 ------

show-os-version

接続されているデバイスの現在のオペレーティング システムのバージョンが表示されます。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 show-os-version
Your device is running Azure Sphere OS version <version-number>

この例では、 <バージョン番号> は現在のオペレーティング システムのバージョンを表します。

sideload

デバイス上のアプリケーションを管理します。

一部のサイドロード オプションでは、デバイスが製造状態 DeviceCompleteになると、追加の機能が必要になります。 fieldServicing 機能を使用すると、一時的な運用署名付きイメージをデプロイおよび削除したり、永続的な運用署名付きイメージをデプロイしたりできます。 appDevelopment機能を使用すると、実稼働署名イメージと SDK 署名付きイメージの両方をデプロイおよび削除できます。

操作	説明
delete	デバイスから現在のアプリケーションを削除します。
deploy	アプリケーションをデバイスに読み込みます。
set-deployment-timeout	デプロイのタイムアウト期間を秒単位で設定します。
show-deployment-timeout	デプロイのタイムアウト期間を秒単位で表示します。

start、stop、show-status、およびshow-quotaのパラメーターは、azsphere device app コマンドに移動されていることに注意してください。

sideload delete

デバイスからアプリケーションを削除します。

このコマンドは、 appDevelopment デバイス機能が構成されている場合にのみ使用できます。

省略可能なパラメーター

パラメーター	型	説明
-i、--component-id	GUID	デバイスから削除するアプリケーションの ID を指定します。 省略した場合、すべてのアプリケーションを削除します。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 sideload delete
Component '54acba7c-7719-461a-89db-49c807e0fa4d' deleted.

sideload deploy

接続されているデバイスにアプリケーションを読み込み、アプリケーションを開始します。

既にデバイス上にあるアプリケーションによって使用されているリソースをアプリケーション マニフェストが要求している場合、このコマンドは失敗します。 この場合は、azsphere device sideload delete を使用して既存のアプリケーションを削除し、サイドローディングを再試行します。 azsphere device sideload delete コマンドは、高度なアプリケーションとリアルタイム アプリケーションの両方を削除します。 1 つのアプリケーションを削除し、もう一方のアプリケーションのままにするには、削除するアプリケーションのコンポーネント ID を指定します。

高度なアプリケーションとリアルタイム対応アプリケーションの両方をデプロイするために同じコマンドが使用されます。

必須のパラメーター

パラメーター	型	説明
-p、--image-package	String	デバイスに読み込むイメージ パッケージのパスとファイル名を指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-m、--manual-start	Boolean	読み込み後にアプリケーションを自動的に起動しないように指定します。
--force	Boolean	サポートされなくなった可能性があるベータ API を使用しているイメージのデプロイを強制します。

グローバル パラメーター

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 sideload deploy --image-package C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage
Deploying 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' to the attached device.
Image package 'C:\Users\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\HelloWorld_HighLevelApp.imagepackage' has been deployed to the attached device.

sideload set-deployment-timeout

デバイス上のイメージをサイドローディングする場合の展開タイムアウト値を秒単位で設定します。

必須のパラメーター

パラメーター	型	説明
-v、--value	Integer	サイドロード コマンドがタイムアウトするまでの時間を秒単位で指定します。値は正の整数である必要があります。

グローバル パラメーター

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 sideload set-deployment-timeout --value 60
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

sideload show-deployment-timeout

デバイス上のイメージをサイドローディングするための現在の展開タイムアウト値を秒単位で表示します。

グローバル パラメーター

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 sideload show-deployment-timeout
 ------------------
 Deployment timeout
 ==================
 60
 ------------------

update

Azure Sphere テナント内の別のデバイス グループにデバイスを移動します。

製品内に作成するデバイス グループに加えて、製品の作成時に、次の 5 つの既定のデバイス グループが追加されます。

• 開発: システム ソフトウェア更新プログラムのみを受け入れます。 アプリケーションの更新プログラムは受け入れません。
• フィールド テスト: Azure Sphere Security Service からのすべての更新を受け入れます。
• 運用: Azure Sphere Security Service からのすべての更新プログラムを受け入れます。
• 運用 OS 評価: Azure Sphere セキュリティ サービスからのすべての更新プログラムを受け入れます。
• フィールド テスト OS の評価: Azure Sphere セキュリティ サービスからのすべての更新プログラムを受け入れます。

デプロイに関連する基本的な要素の詳細については、「デプロイの基本を参照してください。

省略可能なパラメーター

パラメーター	型	説明
-g、--device-group	GUID または名前	デバイスを移動するデバイス グループを指定します。 デバイス グループ ID またはデバイス グループ名を指定できます。 デバイス グループ名を使用するには、製品名とデバイス グループ名の両方を <product-name/device-group-name> 形式で指定する必要があります。
-d、--device	String	コマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合、またはデバイスが接続されていない場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されていないデバイスのデバイス ID を指定することも、接続されているデバイスの IP アドレスまたはローカル接続 ID を指定することもできます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
-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 update --device-group AW100/Marketing
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------
 DeviceId                                                                                               TenantId                             ChipSku  ProductId                            DeviceGroupId
 ==============================================================================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85 a323c263-2aa3-2559-aabb-a3fc32631900 MT3620AN 6f52bead-700d-4289-bdc2-2f11f774270e 7f860cc1-4949-4000-a541-9a988ba4c3cd
 427D205E46A166B7E41135EB968
 ------------------------------------------------------------------------------------------------------ ------------------------------------ -------- ------------------------------------ ------------------------------------

--query パラメーターを使用して、このコマンドに表示される出力をカスタマイズできます。 詳細については、 Query CLI コマンドの出力を参照してください。

次の例は、デバイス ID と製品 ID のみを選択する方法を示しています。

azsphere device update --device-group AW100/Marketing  --query '{DeviceId:deviceId, ProductId:productId}'
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------
 DeviceId                                                                                                                         ProductId
 =====================================================================================================================================================================
 352FE1F59E40EF8A9266415E81AF32B5B07D8F2BBD6B5650CEF4A70B86C7FCBC70B129A41FBC6D02F8BB4AAABC52CD5740C85427D205E46A166B7E41135EB968 6f52bead-700d-4289-bdc2-2f11f774270e
 -------------------------------------------------------------------------------------------------------------------------------- ------------------------------------

wifi

接続されているデバイスの Wi-Fi 構成を管理します。

Wi-Fi ネットワークでデバイスを使用するには、ネットワークに関する情報を追加し、デバイスでネットワークを有効にする必要があります。 SSID には ASCII 以外の文字を入力できますが、azsphere は正しく表示されません。

アプリケーションで Wi-Fi 構成 API を使用する場合は、WifiConfig 機能もアプリケーションの app_manifest.json ファイルに含める必要があります。

操作	説明
add	ワイヤレス ネットワークの詳細をデバイスに追加します。
disable	デバイスのワイヤレス ネットワークを無効にします。
enable	デバイスのワイヤレス ネットワークを有効にします。
forget	ワイヤレス ネットワークの詳細をデバイスから削除します。
list	デバイスの現在の Wi-Fi 構成を一覧表示します。
reload-config	デバイスの Wi-Fi 構成を再度読み込みます。
scan	使用できるネットワークをスキャンします。
show	Wi-Fi 構成の詳細を表示します。
show-status	ワイヤレス インターフェイスの状態を表示します。

wifi add

接続されているデバイスに Wi-Fi ネットワークの詳細を追加します。

デバイスは複数の Wi-Fi 接続を持つことができます。 SSID には ASCII 以外の文字を入力できますが、azsphere は正しく表示されません。 --targeted-scan パラメーターを含め、非表示の SSD に接続できます。 詳細については、「 Azure Sphere を Wi-Fi に接続する」を参照してください。

必須のパラメーター

パラメーター	型	説明
-s、--ssid	String	ネットワークの SSID を指定します。 ネットワーク SSID では大文字と小文字が区別されます。

省略可能なパラメーター

パラメーター	型	説明
--client-cert-id	String	[EAP-TLS]クライアント証明書 (公開キーと秘密キーの両方を含む) を識別する識別子 (最大 16 文字) を指定します。 EAP-TLS ネットワークの設定に必須です。
--client-id <user@domain>	String	[EAP-TLS]ネットワークの RADIUS サーバーによって認証用に認識される ID を指定します。 一部の EAP-TLS ネットワークでは必須となります。
--config-name	String	ネットワーク構成の名前を指定する文字列 (最大 16 文字) を指定します。
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。
--root-ca-cert-id	String	[EAP-tLS]デバイスがサーバーを認証する EAP-TLS ネットワークのサーバーのルート CA 証明書を識別する識別子 (最大 16 文字) を指定します。
--targeted-scan	Boolean	ネットワークがブロードキャストしていないか、ネットワークの輻輳によって非表示になっている場合でも、ネットワークへの接続を試みます。
-p、--psk	String	新しいネットワークの WPA/WPA2 キーを指定します。 省略すると、この SSID をオープン ネットワークとして追加します。 キーにアンパサンド (&) を含める場合は、引用符でキーを囲みます。

グローバル パラメーター

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 wifi add --ssid MyNetwork --psk MyPassword
Successfully added network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 1     MyNetwork enabled            unknown         psk           False
 ----- -------- ------------------ --------------- ------------- ------------

ネットワーク SSID またはキーにスペースまたはアンパサンドが埋め込まれている場合は、SSID またはキーを一重引用符で囲みます。 SSID またはキーに引用符を含める場合は、バックスラッシュを使用して引用符をエスケープします。 円記号が値の一部である場合、円記号をエスケープする必要はありません。 詳細については、「引用符とエスケープ文字を参照してください。 次に例を示します。

azsphere device wifi add --ssid "New SSID" --psk "key \'value\' with quotes"

wifi disable

接続されているデバイスの Wi-Fi ネットワークを無効にします。

必須のパラメーター

パラメーター	型	説明
-i、--id	Integer	無効にするネットワークの ID を指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi disable --id 0
Successfully disabled network:
----- -------- ------------------ --------------- ------------- ------------
ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
============================================================================
0     MyNetwork disabled           disconnected    psk           False
----- -------- ------------------ --------------- ------------- ------------

wifi enable

接続されているデバイスで Wi-Fi ネットワークを有効にします。

あるネットワークから別のネットワークに変更する場合で、両方のネットワークが範囲内にある場合は、新しいネットワークを有効にする前に現在接続されているネットワークを無効にします。

必須のパラメーター

パラメーター	型	説明
-i、--id	Integer	有効にするネットワークの ID を指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi enable --id 0
Successfully enabled network:
 ----- -------- ------------------ --------------- ------------- ------------
 ID    SSID     ConfigurationState ConnectionState SecurityState TargetedScan
 ============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- -------- ------------------ --------------- ------------- ------------

wifi forget

接続されているデバイスから Wi-Fi ネットワークの詳細を削除します。

必須のパラメーター

パラメーター	型	説明
-i、--id	Integer	削除するネットワークの ID を指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi forget --id 0
Successfully forgotten network.

wifi list

接続されているデバイスの現在の Wi-Fi 構成を一覧表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi list
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork1 enabled            connected       psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 1     MyNetwork2 enabled            disconnected    psk           False
 ----- ---------  ------------------ --------------- ------------- ------------
 2     MyNetwork3 enabled            disconnected    eaptls        False
 ----- ---------  ------------------ --------------- ------------- ------------

wifi reload-config

接続されているデバイスの Wi-Fi ネットワーク構成を再読み込みします。 証明書 (azsphere デバイス証明書) を追加または削除した後、このコマンドを使用して、EAP-TLS ネットワークで証明書ストアの最新の内容が使用されるようにします。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi reload-config
Wi-Fi configuration was successfully reloaded.

wifi scan

接続されているデバイスに表示される使用可能な Wi-Fi ネットワークをスキャンします。 このコマンドは最大 64 個の Wi-Fi ネットワークを返しますが、表示される Wi-Fi ネットワークの数は、範囲内のアクセス ポイントの密度などの環境要因によって制限される場合があります。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi scan
----------------- ------------- ----------------- ----------- ---------
SSID              SecurityState BSSID             SignalLevel Frequency
=======================================================================
MyNetwork0        psk           <value>           -66         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork1        psk           <value>           -75         2442
----------------- ------------- ----------------- ----------- ---------
MyNetwork2        psk           <value>           -86         2412
----------------- ------------- ----------------- ----------- ---------

wifi show

接続されているデバイス上の Wi-Fi ネットワークの詳細を表示します。

必須のパラメーター

パラメーター	型	説明
-i、--id	Integer	表示するネットワーク構成の ID を指定します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi show --id 0
 ----- --------- ------------------ --------------- ------------- ------------
 ID    SSID      ConfigurationState ConnectionState SecurityState TargetedScan
 =============================================================================
 0     MyNetwork enabled            disconnected    psk           False
 ----- --------- ------------------ --------------- ------------- ------------

wifi show-status

接続されているデバイスの Wi-Fi インターフェイスの状態を表示します。

省略可能なパラメーター

パラメーター	型	説明
-d、--device	String	複数のデバイスが接続されているときにコマンドを実行するデバイスを指定します。 このパラメーターは、複数のデバイスが接続されている場合に必要です。 現在接続されているデバイスは、既定で使用されます。 接続されているデバイスのデバイス ID、IP アドレス、またはローカル接続 ID を指定できます。 Azure Sphere CLI では、Windows 上の複数の MT3620 デバイスがサポートされていますが、Linux では一度に 1 つのデバイスしか接続できません。 このため、このパラメーターは Windows ではサポートされていますが、Linux ではサポートされていません。 Linux 上のコマンドでこのパラメーターを使用すると、エラーが返されます。

グローバル パラメーター

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 wifi show-status
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------
 SSID  ConfigurationState ConnectionState SecurityState Frequency Mode    KeyManagement WpaState  IpAddress     MacAddress
 ================================================================================================================================
<value> enabled            connected       psk           2412      station WPA2-PSK      COMPLETED <value>      <value>
 ----- ------------------ --------------- ------------- --------- ------- ------------- --------- ------------- -----------------