az alias

Note

このリファレンスは、Azure CLI (バージョン 2.0.31.dev0 以降) のエイリアス拡張機能の一部です。 拡張機能は、az alias コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure CLI エイリアスを管理します。

コマンド

名前	説明	型	Status
az alias create	エイリアスを作成します。	拡張	GA
az alias export	登録されているすべてのエイリアスを INI 構成ファイルとして特定のパスにエクスポートします。 エクスポート パスが指定されていない場合、エイリアス構成ファイルは現在の作業ディレクトリにエクスポートされます。	拡張	GA
az alias import	INI 構成ファイルまたは URL からエイリアスをインポートします。	拡張	GA
az alias list	登録済みのエイリアスを一覧表示します。	拡張	GA
az alias remove	1 つ以上のエイリアスを削除します。 削除するエイリアスはスペースで区切られます。	拡張	GA
az alias remove-all	登録されているすべてのエイリアスを削除します。	拡張	GA

az alias create

エイリアスを作成します。

az alias create --command
                --name

例

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

az alias create --name rg --command group

az alias create --name ls --command list

複雑なエイリアスを作成します。

az alias create --name list-vm --command 'vm list --resource-group myResourceGroup'

引数を含むエイリアス コマンドを作成します。

az alias create --name 'list-vm {{ resource_group }}' \
  --command 'vm list --resource-group {{ resource_group }}'

Jinja2 テンプレートを使用して引数を処理します。

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] }}'

必須のパラメーター

--command -c

エイリアスが指すコマンド。

--name -n

エイリアスの名前。

グローバル パラメーター

--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 を使います。

az alias export

登録されているすべてのエイリアスを INI 構成ファイルとして特定のパスにエクスポートします。 エクスポート パスが指定されていない場合、エイリアス構成ファイルは現在の作業ディレクトリにエクスポートされます。

az alias export [--exclude]
                [--path]

省略可能のパラメーター

--exclude -e

エクスポートから除外されるスペース区切りのエイリアス。

--path -p

エクスポートするエイリアス構成ファイルのパス。

グローバル パラメーター

--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 を使います。

az alias import

INI 構成ファイルまたは URL からエイリアスをインポートします。

az alias import --source

必須のパラメーター

--source -s

インポート元のエイリアスのソース。

グローバル パラメーター

--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 を使います。

az alias list

登録済みのエイリアスを一覧表示します。

az alias list

グローバル パラメーター

--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 を使います。

az alias remove

1 つ以上のエイリアスを削除します。 削除するエイリアスはスペースで区切られます。

az alias remove --name

必須のパラメーター

--name -n

スペース区切りのエイリアス。

グローバル パラメーター

--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 を使います。

az alias remove-all

登録されているすべてのエイリアスを削除します。

az alias remove-all [--yes]

省略可能のパラメーター

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--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 を使います。