Azure CLI 用 Azure Sphere 拡張機能の概要

  • [アーティクル]

Azure Sphere に接続されたデバイスとクラウドのデプロイを管理するためのコマンド ライン ツールは、Azure CLI 拡張機能として配布されます。

Azure CLI と Azure Sphere 拡張機能をインストールする

Azure CLI 用の Azure Sphere 拡張機能を取得するには:

  1. まだインストールしていない場合は Azure CLI をインストールします。

  2. Azure Sphere 拡張機能を追加するには、次のコマンドを実行します。

    az extension add --name azure-sphere

Azure CLI でサインイン Azure Sphere デバイスの管理に使用する Azure サブスクリプションにログインする必要があります。

拡張機能がインストールされると、その場所は $AZURE_EXTENSION_DIR シェル変数の値の下にあります。 この変数が設定されていない場合、既定では、この値は $HOME/.azure/cliextensions (Linux と macOS の場合) または %USERPROFILE%\.azure\cliextensions (Windows の場合) になります。

ヒント

ログインすると、Azure アカウントに関連付けられているサブスクリプションの一覧が表示されます。 Azure Sphere 拡張機能が正常に機能するには、 az account set コマンドを使用して、必要なアクセス許可を持つサブスクリプションを選択してください。 サブスクリプションの選択の詳細については、「複数の Azure サブスクリプションの使用」を参照してください。

Azure Sphere 拡張機能の管理

インストールされているバージョンの Azure CLI 拡張機能を表示するには、次のコマンドを使用します。

az version

Azure Sphere 拡張機能を最新バージョンに更新するには、次を使用します。

az extension update --name azure-sphere

Azure Sphere 拡張機能をアンインストールするには、次を使用します。

az extension remove --name azure-sphere

Azure Sphere CLI の一般的なコマンド

Azure Sphere コマンドを使用するには、Windows コマンド プロンプトまたは PowerShell から「 az sphere 」と入力します。 Linux では、任意のコマンド ライン インターフェイス (CLI) を使用できます。 CLI では Bash シェルにコマンドの完全タブ補完が用意されています。

次の表に、一般的な Azure Sphere コマンドとそのリファレンス ドキュメントへのリンクを示します。

command 説明
az sphere catalog カタログを管理します。
az sphere ca-certificate カタログ内の証明書を管理します。
az sphere deployment カタログ内のデプロイを管理します。
az sphere device Azure Sphere デバイスを管理します。
az sphere device-group カタログ内のデバイス グループを管理します。
az sphere image カタログ内のイメージを管理します。
az sphere product カタログ内の製品を管理します。
az sphere get-support-data システム、クラウド、デバイスの構成に関する診断データを収集します。

Azure CLI を使用すると、構成オプションを設定できます--resource-group、--subscription、--catalogなどのパラメーターの既定値を指定することで、Azure Sphere CLI コマンドの使用を簡略化できます。

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

このコマンドは、ローカルに接続された Azure Sphere デバイスで動作します。 デバイスが接続されていないのにコマンドを実行しようとすると、エラーが発生します。 デバイス コマンドの詳細については、「 az sphere device」を参照してください。

  • az sphere device claim
  • az sphere device recover
  • az sphere device restart
  • az sphere device show-attached
  • az sphere device show-os-version
  • az sphere device app show-memory-status
  • az sphere device app show-quota
  • az sphere device app show-status
  • az sphere device app start
  • az sphere device app stop
  • az sphere device capability show-attached
  • az sphere device capability update
  • az sphere device certificate add
  • az sphere device certificate delete
  • az sphere device certificate list
  • az sphere device certificate show
  • az sphere device certificate show-quota
  • az sphere device image list-installed
  • az sphere image-package show
  • az sphere device manufacturing-state show
  • az sphere device manufacturing-state update
  • az sphere device network proxy apply
  • az sphere device network proxy delete
  • az sphere device network proxy show
  • az sphere device network disable
  • az sphere device network enable
  • az sphere device network list-firewall-rules
  • az sphere device network list-interfaces
  • az sphere device network show-diagnostics
  • az sphere device network show-status
  • az sphere device network update-interface
  • az sphere device sideload delete
  • az sphere device sideload deploy
  • az sphere device wifi add
  • az sphere device wifi disable
  • az sphere device wifi enable
  • az sphere device wifi forget
  • az sphere device wifi list
  • az sphere device wifi reload-config
  • az sphere device wifi scan
  • az sphere device wifi show
  • az sphere device wifi show-status

グローバルに使用できる引数

Azure Sphere 拡張機能では、次のグローバル パラメーターを使用できます。

パラメーター 説明
--debug すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
--help -h ヘルプ メッセージを表示します。
--only-show-errors エラーのみを表示し、警告を抑制します。
--output -o 出力形式。 使用できる値: json、 jsonc、 none、 table、 tsv、 yaml、 yamlc。 既定値:json。
--query JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
--subscription : サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。
--verbose ログの詳細レベルを上げます。 完全なデバッグ ログを表示するには --debug を使用します。