Azure Sphere CLI の概要
Azure Sphere CLI は、Azure Sphere リソースを管理するために使用される一連のコマンドです。
次のコマンドを使用できます。
- ca-certificate
- デバイス
- device-group
- フィードバック
- get-support-data
- hardware-definition
- イメージ
- image-package
- interactive (コマンドはプレビュー段階)
- ログイン
- ログアウト
- 製品
- register-user
- 役割
- show-user
- show-version
- 設定
- テナント
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 コマンドは d と省略されます。
ほとんどの パラメーター には、長い名前と省略形の両方があります。 コマンド ラインで、ハイフンが 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 コマンドを使用する場合は、シェルで引用符を使用して文字をエスケープする方法に注意してください。 異なるシェルで使用されるスクリプトをサポートする場合は、その違いを理解する必要があります。
例えば：
- Bash: クォート
- PowerShell: クォートルールについて
- Windows コマンド プロンプト: 方法: Windows コマンド ラインで文字、区切り記号、引用符をエスケープする
クラウド依存コマンド
次の azsphere コマンドでは、クラウド接続と Azure Sphere Security Service へのログインが必要です。
- ca-certificate
- device-group
- get-support-data
- イメージ
- ログイン
- ログアウト
- 製品
- register-user
- 役割
- show-user
- テナント
さらに、次の azsphere デバイス コマンドにはクラウド接続も必要です。
| azsphere device コマンド | コメント |
|---|---|
| 機能 | デバイス機能のダウンロードに Azure Sphere Security Service が必要 |
| 主張 | |
| enable-cloud-test | |
| enable-development | |
| イメージ | |
| リスト | |
| 回復 | インターネット接続が必要ですが、Azure Sphere Security Service へのログインは必要ありません |
| 表示 | |
| show-count | |
| show-deployment-status | |
| show-os-version | インターネット接続が必要ですが、Azure Sphere Security Service へのログインは必要ありません |
| 更新 |
デバイス機能に依存するコマンド
次の azsphere デバイス コマンドでは、DeviceComplete の製造状態のデバイスにデバイス機能を使用する必要があります。
| 操作 | 説明 |
|---|---|
| アプリ | 接続されているデバイス上のアプリケーションを管理します。 |
| 機能 | デバイス機能の構成を管理します。 機能の 更新に必要です。 |
| 証明 書 | デバイス証明書ストアを管理します。 |
| イメージ | デバイス イメージを管理します。 |
| 製造状態 | 接続されているデバイスの製造状態を管理します。 製造状態の更新に必要です。 |
| 再起動 | 接続されているデバイスを再起動します。 |
| show-deployment-status | 接続されているデバイス上のオペレーティング システムとアプリケーションの展開状態を表示します。 |
| show-os-version | 接続されているデバイスにオペレーティング システムのバージョンを表示します。 |
| sideload | 接続されているデバイスにアプリケーションをデプロイして管理します。 サイドロードデプロイとサイドロード削除に必要です。 |
| Wifi | 接続されているデバイスの Wi-Fi 構成を管理します。 |
これらのコマンドを機能なしで実行しようとすると、デバイスの機能ファイルをダウンロードして選択するためにを実行 azsphere device enable-development するか使用 azsphere device capability するかを示すエラー メッセージが表示されます。