次の方法で共有

Azure Sphere CLI の概要

  • [アーティクル]

重要

これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に 再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。

Azure Sphere CLI は、Azure Sphere リソースを管理するために使用される一連のコマンドです。

次のコマンドを使用できます。

Note

register-user コマンドは非推奨になりました。

Azure Sphere CLI と Azure Sphere クラシック CLI

Azure Sphere CLI は、Windows と Linux の両方に既存の CLI と共にインストールされるため、どちらのインターフェイスにもアクセスできます。 Azure Sphere クラシック CLI は、常に機能し続けます。

Azure Sphere CLI を使用するには:

  • Windows では、PowerShell または標準の Windows コマンド プロンプトを使用します。
  • Linux では、任意のコマンド シェルを使用します。 SDK のインストール時に Azure Sphere CLI を既定値として設定する場合は azsphere コマンドを指定し、Azure Sphere クラシック CLI を既定値に設定した場合は azsphere_v2 コマンドを指定します。

Azure Sphere CLI でサポートされる機能とコマンドの詳細については、「 Azure Sphere CLI を参照してください。

重要

  • Windows では、廃止される Azure Sphere クラシック開発者コマンド プロンプト ショートカットは、Azure Sphere クラシック CLI でのみ使用できます。

コマンドラインの形式

azsphere コマンド ラインの形式は次のとおりです。

azsphere [command] [subcommand] operation [parameters]

一般的に、コマンドとサブコマンドは名詞であり、操作は動詞なので、これらを組み合わせることでアクションとアクションの目的語の両方が識別されます。 ほとんどのコマンドと操作には、フル ネームと省略形の両方があります。 たとえば、device コマンドは省略。

ほとんどのパラメーターには、長い名前と短い名前の両方があります。 コマンド ラインでは、長い名前に 2 つのハイフンを、省略形には 1 つのハイフンを指定します。 たとえば、次の 2 つのコマンドは同じものです。

azsphere device wifi add --ssid MyNetwork --psk mynetworkkey

azsphere device wifi add -s MyNetwork -p mynetworkkey

一部のコマンドでは、1 つのパラメーターに複数の値を使用できます。 Azure Sphere CLI では、1 つのパラメーターの後にスペースで区切られた値の一覧を指定できます。Azure Sphere クラシック CLI では、値の一覧はコンマで区切られます。 次に例を示します。

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

引用符とエスケープ文字

Azure Sphere CLI コマンドを使用する場合は、シェルで引用符を使用して文字をエスケープする方法に注意してください。 別のシェルで使用されるスクリプトをサポートする場合は、それらの違いを理解しておく必要があります。

次に例を示します。

クラウド依存のコマンド

以下の azsphere コマンドは、クラウド接続と、Azure Sphere Security Service へのログインを必要とします。

  • ca-certificate
  • device-group
  • get-support-data
  • image
  • ログイン (login)
  • logout
  • product
  • role
  • show-user
  • テナント

さらに、以下の azsphere device コマンドにもクラウド接続が必要です。

azsphere device コマンド Comments
capability デバイス機能のダウンロードには Azure Sphere Security Service が必要です
claim
enable-cloud-test
enable-development
image
list
recover インターネット接続が必要ですが、Azure Sphere Security Service へのログインは不要です
show
show-count
show-deployment-status
show-os-version インターネット接続が必要ですが、Azure Sphere Security Service へのログインは不要です
update

デバイス機能に依存するコマンド

次の azsphere device コマンドでは、 device 機能が必要です 製造状態のデバイス DeviceComplete。

操作 説明
app 接続されているデバイスでアプリケーションを管理します。
機能 デバイス機能の構成を管理します。 キャビリティ更新に必要です。
certificate デバイスの証明書ストアを管理します。
image デバイスのイメージを管理します。
manufacturing-state 接続されているデバイスの製造状態を管理します。 製造状態の更新に必要です。
やり直し 接続されたデバイスを再起動します。
show-deployment-status 接続されたデバイスでオペレーティング システムとアプリケーションの展開状態を表示します。
show-os-version 接続されているデバイスのオペレーティング システムのバージョンを表示します。
sideload 接続されたデバイスでアプリケーションを展開および管理します。 デプロイサイドロードと削除のサイドロードに必要です。
wifi 接続されたデバイス用の Wi-Fi 構成を管理します。

これらのコマンドを機能なしで実行しようとすると、 azsphere device enable-development を実行するか、 azsphere device capability を使用してデバイスの機能ファイルをダウンロードして選択するかを示すエラー メッセージが表示されます。