Azure CLI のエイリアス拡張機能を使用する方法

[アーティクル]
09/15/2023

エイリアス拡張機能を使用すると、既存のコマンドを使用して、Azure CLI のカスタムコマンドを定義することができます。エイリアスではショートカットが使用できるので、ワークフローをシンプルに保つことができます。 Jinja2 テンプレートエンジンは、Azure CLI エイリアスを強化し、高度な引数処理を提供します。

Note

エイリアス拡張機能はパブリックプレビュー段階にあります。機能と構成ファイルの形式は変更される可能性があります。

エイリアス拡張機能のインストール

エイリアス拡張機能を使用するために最低限必要な Azure CLI バージョンは 2.0.28 です。 CLI のバージョンを確認するには、az --version を実行してください。インストールを更新する必要がある場合は、「Azure CLI のインストール」を参照してください。

az extension add コマンドを使用してエイリアス拡張機能をインストールします。

az extension add --name alias

az extension list を使用して拡張機能のインストールを確認します。エイリアス拡張機能が正しくインストールされていれば、コマンドの出力に表示されます。

az extension list --output table --query '[].{Name:name}'

Name
------
alias

エイリアス拡張機能を最新の状態に保つ

エイリアス拡張機能は活発に開発が行われており、新しいバージョンが定期的にリリースされます。 CLI を更新しても、新しいバージョンがインストールされるわけではありません。 az extension update を使用して拡張機能の更新プログラムをインストールします。

az extension update --name alias

Azure CLI のエイリアスを管理する

エイリアス拡張機能を使用すると、他の CLI コマンドのエイリアスを作成して管理できます。使用可能なすべてのコマンドおよびパラメーターの詳細を表示するには、--help でエイリアスコマンドを実行します。

az alias --help

単純なエイリアスコマンドを作成する

エイリアスの用途の 1 つは、既存のコマンドグループやコマンド名の短縮です。たとえば、group コマンドグループを rg に、list コマンドを ls に短縮できます。

az alias create --name rg --command group
az alias create --name ls --command list

新しく定義したこれらのエイリアスは、定義が存在する任意の場所で使用できるようになります。

az rg list
az rg ls
az vm ls

エイリアスコマンドの一部として az を含めないでください。

エイリアスは、完全なコマンドのショートカットにすることもできます。次の例では、使用可能なリソースグループとその位置がテーブル出力で表示されています。

az alias create --name ls-groups --command "group list --query '[].{Name:name, Location:location}' --output table"

これで ls-groups を他の CLI コマンドのように実行できます。

az ls-groups

引数付きのエイリアスコマンドを作成する

エイリアス名に {{ arg_name }} として含めることで、位置引数をエイリアスコマンドに追加することもできます。中かっこ内には空白が必要です。

az alias create --name "alias_name {{ arg1 }} {{ arg2 }} ..." --command "invoke_including_args"

次の例のエイリアスは、位置引数を使用して VM のパブリック IP アドレスを取得する方法を示しています。

az alias create \
    --name "get-vm-ip {{ resourceGroup }} {{ vmName }}" \
    --command "vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }}
        --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress"

このコマンドを実行するときに、位置引数に値を指定します。

az get-vm-ip MyResourceGroup MyVM

エイリアス化されたコマンドで環境変数を使用することもできます。この環境変数は実行時に評価されます。次の例では、create-rg エイリアスを追加します。これにより、eastus 内にリソースグループが作成され、owner タグが追加されます。このタグには、ローカル環境変数 USER の値が割り当てられます。

az alias create \
    --name "create-rg {{ groupName }}" \
    --command "group create --name {{ groupName }} --location eastus --tags owner=\$USER"

エイリアスのコマンド内に環境変数を登録するには、ドル記号 $ をエスケープする必要があります。

Jinja2 テンプレートを使用した引数の処理

Jinja2 は、エイリアス拡張機能で引数の置換を実行します。 Jinja2 テンプレートでは、引数を操作することができます。

Jinja2 テンプレートを使用すると、基になるコマンドとは異なる型の引数を受け入れるエイリアスを作成できます。たとえば、ストレージ URL を受け入れるエイリアスを作成できます。この URL が解析され、アカウント名とコンテナー名がストレージコマンドに渡されます。

az alias create \
    --name 'storage-ls {{ url }}' \
    --command "storage blob list
        --account-name {{ url.replace('https://', '').split('.')[0] }}
        --container-name {{ url.replace('https://', '').split('/')[1] }}"

Jinja2 テンプレートエンジンについては、Jinja2 のドキュメントを参照してください。

エイリアス構成ファイル

エイリアス構成ファイルを変更することで、エイリアスを作成および変更することもできます。エイリアスコマンド定義は、$AZURE_CONFIG_DIR/alias にある構成ファイルに書き込まれます。 AZURE_CONFIG_DIR の既定値は、macOS と Linux の場合は $HOME/.azure、Windows の場合は %USERPROFILE%\.azure です。エイリアス構成ファイルは、INI 構成ファイル形式で記述されます。エイリアスコマンドの形式は次のとおりです。

[alias_name]
command = invoked_commands

位置引数を含むエイリアスの場合、エイリアスコマンドの形式は次のとおりです。

[alias_name {{ arg1 }} {{ arg2 }} ...]
command = invoked_commands_including_args

エイリアス構成ファイルで引数付きのエイリアスコマンドを作成する

次の例では、引数が指定されたコマンドのエイリアスを示します。このコマンドにより、VM のパブリック IP アドレスが取得されます。エイリアス化されたコマンドは、1 行で全体を指定する必要があります。また、エイリアス名にはすべての引数を含める必要があります。

[get-vm-ip {{ resourceGroup }} {{ vmName }}]
command = vm list-ip-addresses --resource-group {{ resourceGroup }} --name {{ vmName }} --query [0].virtualMachine.network.publicIpAddresses[0].ipAddress

エイリアス拡張機能のアンインストール

拡張機能をアンインストールするには、az extension remove コマンドを使用します。

az extension remove --name alias

拡張機能に関するバグなどの問題が原因でアンインストールした場合は、Microsoft が修正プログラムを提供できるように、GitHub に問題を提出してください。