Azure CLI の概要

Azure コマンド ライン インターフェイス (CLI) にようこそ。 この記事では、CLI について説明し、一般的なタスクの実行に役立つ情報を示します。

Azure Cloud Shell でのインストールまたは実行

Azure CLI の使用方法を学習する最も簡単な方法は、ブラウザーを使用して Azure Cloud Shell で Bash 環境を実行することです。 Cloud Shell については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。

Azure CLI をインストールする準備ができたら、Windows、Linux、macOS、Docker コンテナーの インストール手順 を参照してください。 Azure クラシック デプロイ モデルを使用している場合は、Azure クラシック CLI をインストールしてください。

az --versionを実行してバージョンを確認します。 Azure Cloud Shell には常に最新バージョンの Azure CLI がプレインストールされています。

az version

Azure CLI にサインインする

ローカル インストールで Azure CLI コマンドを使用する前に、az login を使ってサインインする必要があります。

1. az login コマンドを実行します。

   az login
   

   Azure CLI が既定のブラウザーを開くことができる場合、認可コード フローを開始し、既定のブラウザーを開いて Azure サインイン ページを読み込みます。

   それ以外の場合は、デバイス コード フローを開始し、ユーザーにブラウザーのページで https://aka.ms/devicelogin を開くように指示します。 次に、ご利用のターミナル内に表示されたコードを入力します。

   Web ブラウザーが使用できないか、Web ブラウザーを開けない場合は、az login --use-device-code を使用してデバイス コード フローを強制できします。

2. ブラウザーでアカウントの資格情報を使用してサインインします。

ログインすると、Azure アカウントに関連付けられているサブスクリプションの一覧が表示されます。 isDefault: true が示されているサブスクリプション情報が、ログイン後に、現在アクティブになっているサブスクリプションです。 別のサブスクリプションを選択するには、 az アカウント セット コマンドを目的のアカウントのサブスクリプション ID と共に使用します。 サブスクリプションの選択の詳細については、「 Azure サブスクリプションの管理」を参照してください。

対話型以外のサインイン方法も用意されています。詳細については、「Azure CLI を使用してサインインする」を参照してください。

コマンドを見つける

Azure CLI コマンドは、コマンド グループとして編成されます。 各グループは、Azure サービスの領域を表します。 コマンド グループを検索するには、次の 2 つのオプションがあります。

• az find コマンドを使用します。 たとえば、vm を含むコマンド名を検索するには、次のコマンドを使用します。

  az find vm
  

• --help引数を使用して、参照グループ内のサブグループの完全な一覧を取得します。 この例では、仮想マシンのすべてのサブグループが返されます。

  az vm --help
  

  簡潔にするために行を省略した出力例を次に示します。

  Subgroups:
    application            : Manage applications for VM.
    availability-set       : Group resources into availability sets.
    boot-diagnostics       : Troubleshoot the startup of an Azure Virtual Machine.
    ...
  

  仮想マシンを可用性セット ( subgroup az vm にグループ化するための Azure CLI コマンドを検索する別の例を次に示します。

  az vm availability-set --help
  

  また、 --help を使用して、リファレンス commandのパラメーター リストとコマンドの例を取得します。

  az vm create --help
  

  簡潔にするために行を省略した出力例を次に示します。

  Arguments
      --name  [Required] : Name of the virtual machine.
      ...
  Authentication Arguments
      --admin-password   : Password for the VM if authentication type is 'Password'.
      --admin-username   : Username for the VM...
      ...
  Managed Service Identity Arguments
      ...
  Examples
      Create a VM from a custom managed image.
        az vm create -g MyResourceGroup -n MyVm --image MyImage
      ...
  

• すべてのコマンド グループをアルファベット順に一覧表示する A から Z への参照インデックス を使用します。

公開されているサンプルと記事を見つける

テスト済みの公開例を見て Azure CLI 構文を学習する場合は、記事コンテンツの 2 つのインデックスがあります。

• インデックス A から Z をサンプルします。サンプル インデックスには、 subject area、 reference group、および GitHub リポジトリで並べ替えられた Azure CLI サンプルの一覧が表示されます。

• アーティクルのインデックス A から Z。キーボード find ショートカット キー ( Ctrl + F など) を使用して、目的の参照コマンド グループにすばやくドロップします。 たとえば、記事のインデックスは、 az vmでは次のようになります。

  参照サブグループ	参照の使用を示す Azure CLI の記事
  az vm	Azure CLI コマンドの出力形式
  	Azure CLI のコマンドで変数を使用する方法
  	クエリを使用して VM 情報を取得する
  	{ここに記載されているその他の記事。}
  az vm aem	SAP ソリューション用 Azure VM 拡張機能の新しいバージョン
  	SAP ソリューション用 Azure VM 拡張機能の標準バージョン
  az vm application	{...}

タブ補完を使用する

CLI には、Bash 環境のコマンドの完全なタブ補完機能があります。 PowerShell 環境でタブ補完を有効にするには、「PowerShell でタブ補完を有効にするを参照してください。

グローバルに使用可能な引数に注意する

ほとんどのコマンドで使用できる引数がいくつかあります。

• --help は、コマンドとその引数に関する CLI 参照情報を出力し、利用可能なサブグループとコマンドの一覧を表示します。

• --output は出力形式を変更します。 使用可能な出力形式は json、jsonc (色付けされた JSON)、tsv (タブ区切り値)、および table (人間が判読できる ASCII テーブル)、および yaml です。 既定では、CLI は json を出力します。 使用可能な出力形式の詳細については、Azure CLI の出力形式に関するページをご覧ください。

• --query は、JMESPath クエリ言語を使用して、Azure サービスから返された出力をフィルター処理します。 クエリの詳細については、Azure CLI でのコマンド結果に対するクエリの実行に関するページ、および「JMESPath tutorial (JMESPath チュートリアル)」を参照してください。

• --verbose は、操作中に Azure で作成されたリソースに関する情報と、その他の有用な情報を出力します。

• --debug は、デバッグの目的で使用する、CLI 操作に関する詳細情報を出力します。 バグを見つけた場合は、バグ レポートを送信するときに、--debug フラグをオンにして生成した出力を提供してください。 たとえば、コマンドが下で呼び出している REST API と、サービスから受信した応答を識別するために使用できます。

• --subscription はサブスクリプションの名前または ID です。 既定のサブスクリプションの設定の詳細については、「 Azure CLI を使用した Azure サブスクリプションの管理を参照してください。

• --only-show-errors は、コマンド出力の警告を抑制し、エラーのみを表示します。

対話型モードを使用する

CLI には対話モードが用意されています。このモードでは、ヘルプ情報が自動的に表示され、サブコマンドが選択しやすくなっています。 対話モードには az interactive コマンドで切り替えます。

az interactive

対話型モードの詳細については、「 対話型モードで Azure CLI を実行する」を参照してください。

また、オートコンプリート、マウス オーバー ドキュメントなど、対話型エクスペリエンスを提供する Visual Studio Code プラグインも用意されています。

クイック スタートとチュートリアルを使用して Azure CLI の基本を学習する

Azure CLI を使用する方法については、 オンボード のチュートリアルを試してください。このチュートリアルでは Azure Storage の操作中に次のスキルについて説明します。

• 既定のサブスクリプションを見つけて変更します。
• 名前にランダムな ID を含む Azure リソースを作成します。
• 環境変数を設定します。
• Bash、PowerShell、Cmd の構文の違いについて説明します。
• Azure CLI リファレンス コマンドをデバッグします。
• ローカル JSON ファイルからプロパティを取得します。。 この例では、開発、ステージ、運用の構成値を取得する方法を示します。
• スクリプトを使用して複数のリソースを削除します。

フィードバックを送る

機能強化とバグ解決に活かすために、CLI に関する皆様のご意見をお待ちしております。 GitHub で問題を報告するか、CLI の組み込み機能を使用して、az feedback コマンドで一般的なフィードバックをお寄せください。

az feedback

関連項目

• オンボーディング チート シート
• Azure CLI チュートリアルを使用する方法について説明します
• Bash 環境で Azure CLI を使用する
• PowerShell 環境での Azure CLI の使用に関する考慮事項