クラシック CLI から Azure Sphere CLI への移行

  • [アーティクル]

重要

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

まだ Azure Sphere クラシック CLI を使用している場合は、 新しい Azure Sphere CLIに移行することをお勧めします。 現在、両方のバージョンのCLIをインストールし、並行して使用することができますが、クラシックCLIは更新やメンテナンスが終了しており、将来的にSDKから削除される予定です（2022年末までには削除されません）。 中断を避けるために、これらの違いをよく理解し、2022 年末までにプロセスとスクリプトを移行することをお勧めします。

最新の SDK に更新するには、 Azure Sphere SDK を Linux にインストールする または Azure Sphere SDK for Windows をインストールするを参照してください。

Windows で Azure Sphere CLI を使用するには、PowerShell または標準の Windows コマンド プロンプトを使用します。 Linux の場合は、任意のコマンド シェルを使用します。 詳細については、 Azure Sphere CLI の実行を参照してください。

Windowsでは、まもなくサポートが打ち切られる Azure Sphereクラシックデベロッパーコマンドプロンプト (Azure Sphereの スタート にショートカットがあります)は、Azure Sphere classic CLIでのみ使用できます。 詳細については、 Azure Sphere classic CLI の実行を参照してください。

主な相違点

  • Azure Sphere クラシック CLI では、複数のパラメーターを使用して各オブジェクトの種類を識別できます。 Azure Sphere CLI では、1 つのパラメーターを使用して各オブジェクトの種類を識別します。 つまり、名前または ID を使用してパラメーター値を指定できます。 これは、 --device、 --tenant、 --product、および --device-group パラメーターに対して実装されています。

    オブジェクトの種類 Azure Sphere CLI Azure Sphere classic CLI (サポート打ち切り)
    デバイス --device --deviceid、 --deviceip、または --devicelocation
    デバイス グループ --device-group --devicegroupid または --devicegroupname
    Product --product --productid または --productname
    テナント --tenant --tenantid

  • コマンドの短い形式は、クラシック バージョンでサポートされています。 Azure Sphere CLI では、 Tab 入力候補 または interactive 機能を使用して、使用可能なコマンドの一覧を表示することをお勧めします。 たとえば、クラシック CLI では azsphere device enable-development または azsphere dev edv コマンドを使用できますが、新しい Azure Sphere CLI ではオートコンプリートを使用して azsphere device enable-development コマンドをすばやく入力できます。

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

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

  • 新しい CLI では、テナントの作成時に既定のテナント 自動的に選択されません。 azsphere tenant select コマンドを実行して、PC 上の現在のユーザーに使用する既定のテナントを選択する必要があります。 これは、デバイスのオーバーレイのように元に戻すことができない 1 回限りの操作を実行するときに、既定のテナントが正しく使用されるようにするため。

    スクリプトを使用する場合は、 --tenant <tenant ID or tenant name> パラメーターを使用して既定のテナントを選択できます。

    次を使用して、スクリプトの開始時に既定のテナントを設定します。

    azsphere tenant select --tenant <tenant ID or tenant name>

    コマンドの実行時に、既定のテナントを上書きしたり、必要なテナントを指定したりすることもできます。 次に例を示します。

    azsphere get-support-data --destination logs.zip --tenant <tenant ID or tenant name>

  • --device-group パラメーターは、デバイス グループを識別します。 デバイス グループ ID は GUID を提供し、すべての製品のデバイス グループを一意に識別します。 または、製品名とデバイス グループ名のペアを <product-name>/<device-group-name> 形式で使用することもできます。 この名前のペアによって、特定の製品のデバイス グループが一意に識別されます。

  • 次のコマンドは、クラシック CLI の複合コマンドです。 つまり、1 つのコマンドで複数のタスクが実行されました。 新しい CLI では、2 つのコマンドを実行する必要があります。

    • クラシック CLI では、 azsphere device-group deployment create コマンドによってイメージ パッケージがアップロードされ、新しいデプロイが作成されました。

      新しい CLI では、次の手順を実行する必要があります。

      1. azuresphere image add を使用して、イメージ パッケージ Azure Sphere テナントにアップロードします。
      2. azsphere device-group deployment create を使用して、アップロードされたイメージのデバイス グループの新しいデプロイを作成します。

    • クラシック CLI では、 azsphere device capability download --select コマンドをダウンロードし、接続されているデバイスのデバイス機能構成を一時的に選択します。

      新しい CLI では、次の手順を実行する必要があります。

      1. azsphere device capability download を使用して、機能ファイルをダウンロードします。
      2. azsphere device capability select を使用して、機能を選択します。

    • クラシック CLI では、 azsphere device capability download --apply コマンドがダウンロードされ、接続されているデバイスのデバイス機能構成が適用されます。

      新しい CLI では、次の手順を実行する必要があります。

      1. azsphere device capability download を使用して、機能ファイルをダウンロードします。
      2. azsphere device capability update を使用して、機能を適用します。

  • クラシック CLI では、 -o または --output パラメーターを使用して、ファイルを保存するパスとファイル名を指定します。 新しい Azure Sphere CLI では、 --destination などのコンテキスト固有のパラメーターを使用して、 入力パスと出力パスを指定。

  • クラシック CLI では、 -d または --debug パラメーターが azsphere device app start コマンドで使用され、デバッグ モードでアプリケーションが起動されます。 新しい Azure Sphere CLI では、 --debug-mode パラメーターを使用してデバッグ モードでアプリケーションを起動し、 --debug パラメーターをグローバル パラメーターとして使用して、ログ記録の詳細度を高めてすべてのデバッグ ログを表示します。

  • クラシック CLI では、出力形式を制御する必要はありません。 Azure Sphere CLI では、 -o または --output パラメーターを使用して、CLI 出力の形式を設定する 出力形式を指定します。

  • リリース 21.02 以降では、Azure Sphere CLI の製品名から明示的なバージョン番号が削除されました。 この変更により、製品のさまざまなバージョンを参照する場合の混乱が解消されます。

    • Azure Sphere CLI v2 以降は、"Azure Sphere CLI" とのみ呼ばれるようになりました。
    • 以前の Azure Sphere CLI バージョン (CLI v1 以前) は、"Azure Sphere クラシック CLI" と呼ばれるようになりました。

  • スクリプトを使用している場合は、上記の違いにより、新しい Azure Sphere CLI と互換性がない可能性があります。 新しい CLI でスクリプトを正しく実行するために必要な更新を行います。

関連項目