Azure Developer CLI の各種コマンドについて
今回はAzure Developer CLI でどのようなコマンドがあるか、各コマンドがどのようなことに利用されるかについて説明していきます。本記事はAzure Developer CLI がGA となる前の記事のため、最新の情報と異なる可能性があるため注意をお願いします。
5 February, 2023
実施環境
Azure Developer CLI | 0.5.0-beta.3 |
|---|
Azure Developer CLI のインストール方法
Azure Developer CLI のインストール方法は、以下の記事ページを参照してください。
Azure Developer CLI の基本的な使い方、コマンド一覧
Azure Developer CLI は「azd」の後に行いたい内容のコマンド、オプションを入力します。
# 基本的な使い方
azd [command]Azure Developer CLI で使用できるコマンドは以下の通りです。
config | Azure Developer CLI のユーザー設定を行う。 |
|---|---|
deploy | Azure にアプリケーションのコードをデプロイする。 |
down | Azure リソースを削除する。 |
env | Azure Developer CLI の環境を管理する。 |
help | ヘルプを表示する。 |
infra | Azure リソースを管理する。 |
init | 新規アプリケーションの初期化をする (azd テンプレートから構成を設定する) |
login | Azure にログインする。 |
logout | Azure からログアウトする。 |
monitor | デプロイしたアプリケーションを監視する。 |
pipeline | GitHub Actions またはAzure Pipeline の管理をする。 |
provision | Azure リソースをプロビジョニングする。 |
restore | 依存関係を復元する。 |
template | テンプレートを管理する。 |
up | azd init、azd provision、azd deploy を順に実行する。 |
version | Azure Developer CLI のバージョンを確認する。 |
ヘルプコマンド、バージョン確認
Azure Developer CLI で各種コマンドを確認するヘルプコマンド、バージョン確認コマンドは以下の通りです。
# Azure Developer CLIのヘルプを表示する
azd -h
azd --help
# Azure Developer CLIのバージョンを確認する
azd versionまた、azd の各種コマンドの後に「-h」または「--help」をつけることで、コマンドの使用方法を確認することもできます。
ログイン・ログアウト
Azure Developer CLI で初期設定、Azure リソースのプロビジョニング、アプリケーションのデプロイを行うにはAzure アカウントにログインする必要があります。Azure Developer CLI でAzure アカウントにログインするには「azd login」コマンド、ログアウトするには「azd logout」を実行します。オプションを指定しない場合はブラウザを使用し対話型の認証を実施します。
# Azureアカウントにログインする
azd login
# Azureアカウントにログインしているかを確認する
# azdコマンドでログインしているかどうかを確認するため、Azure CLIのみでログインした場合はログインしていないと表示される
azd login --check-status
# サービスプリンシパルを使用しログインする(クライアントシークレットを使用する場合)
azd login --client-id <クライアントID> --tenant-id <テナントID> --client-secret <シークレット文字列>
# サービスプリンシパルを使用しログインする(クライアント証明書を使用する場合)
azd login --client-id <クライアントID> --tenant-id <テナントID> --client-certificate <証明書のパス>
# サービスプリンシパルとしてログインする(プロバイダーを使用する場合)
azd login --client-id <クライアントID> --tenant-id <テナントID> --client-credential-provider <プロバイダー>
# サービスプリンシパルのフェデレーショントークンを指定してログインする
azd login --client-id <クライアントID> --tenant-id <テナントID> --federated-credential <トークン文字列>
# フェデレーショントークンを取得するプロバイダーを指定する
azd login --client-id <クライアントID> --tenant-id <テナントID> --federated-credential-provider <プロバイダー文字列>
# リダイレクトURIで使用するポートを指定する
azd login --redirect-port <ポート番号>
# テナントIDを指定してログインする
azd login --tenant-id <Tenant ID>
# デバイスコードを使用してログインする
azd login --use-device-code
# Azureアカウントからログアウトする
azd logoutazd login コマンドでもログインは可能ですが、config でAzure CLI の認証情報を使用する設定を行っている場合は「az login」でログインすることができます。
テンプレート関連、初期設定
Azure Developer CLI で使用できるテンプレートの確認を行うには「azd template」コマンドを使用します。また、azd テンプレートを使用した初期設定を行うためには「azd init」コマンドを使用します。
# 使用可能なazdテンプレートを確認する
azd template list
# テンプレートの詳細を確認する
azd template show --template <テンプレート名>Azure リソースのプロビジョニング、アプリケーションのデプロイ、リソースの削除
Azure Developer CLI でAzure リソースのプロビジョニングを行うには「azd provision」コマンド、API、アプリケーションのデプロイを行うには「azd deploy」コマンド、リソースの削除を行うには「azd down」コマンドを使用します。また、「azd init」「azd provision」「azd deploy」の一連のコマンドをまとめて実行するには「azd up」コマンドを使用します。
# 「azd init」「azd provision」「azd deploy」をまとめて実行する
# オプションを何も指定しないと対話型となる
azd up
# アプリケーションのAzureリソースをプロビジョニングする
azd provision
# Azureリソースにアプリケーションをデプロイする
azd deploy
# Azureリソースを削除する
azd downアプリケーションのモニタリング
azd コマンドからAzure Portal の各種ダッシュボードやメトリクスを確認するには「azd monitor」コマンドを実行します。
# ブラウザで共有ダッシュボードを開く
azd monitor --overview
# ブラウザでApplication Insightのライブメトリックを開く
azd monitor --live
# ブラウザでApplication Insightのログを開く
azd monitor --logsアプリケーションのモニタリングはAzure 上にアプリケーションをデプロイしている時のみ使用可能となります。Azure 上にアプリケーションをデプロイしていない状態でコマンドを実行するとエラーとなります。
Azure Developer CLI 環境の操作
Azure Developer CLI の環境の操作を行うには「azd env」コマンドを使用します。
# 環境名の値を取得する
azd env get-values <環境名>
# 環境一覧を表示する
azd env list
# 新しい環境を作成する
azd env new
# 以前のプロビジョニング情報から環境設定を更新する
azd env refresh
# デフォルトの環境をセットする
azd env select
# 環境に値を設定する
azd env set <key> <value>各種設定の編集・管理
Azure Developer CLI のユーザー構成設定を行う見は「azd config」コマンドを使用します。環境のパイプラインを管理するには「azd pipeline」コマン、Azure リソースを管理するには「azd infra」コマンドを使用します。
# 環境名の設定を取得する
azd config get <環境名>
# ユーザー設定の一覧を表示する
azd config list
# 設定をリセットする
azd config reset
# Azure Developer CLIでAzure CLIの認証情報を使用するよう設定する
azd config set auth.useAzCliAuth true
# デフォルトのロケーションを解除する
azd config unset defaults.location
# CI/CDパイプラインのプロバイダーをAzure Pipelineに指定する
azd pipeline config --provider azdo
# Azureリソースを作成する
azd infra create
# Azureリソースを削除する
azd infra delete依存関係の復元
アプリケーションのライブラリなどをダウンロード、インストールし、ローカル環境でビルド、実行、デバッグを行えるようにするには「azd restore」を使用します。例えば、Node.js のアプリケーションで「azd restore」コマンドを実行すると、アプリケーションやAPI にNode.js モジュールをインストールしてくれます。
# アプリケーションの依存関係を復元する
azd restore
# 環境名・testappの依存関係を復元する
azd restore -e testapp「azd restore」コマンドを実行する際には、ローカルPC 上にアプリケーションで指定されたバージョン以上のランタイムが必要となります。ローカルPC でランタイムを満たしていない場合、コマンドはエラーとなります。