Cara menggunakan ekstensi alias Azure CLI

Ekstensi alias memungkinkan pengguna menentukan perintah kustom untuk Azure CLI dengan menggunakan perintah yang sudah ada. Alias membantu menyederhanakan alur kerja dengan mengizinkan pintasan. Mesin templat Jinja2 mendukung alias Azure CLI dan menawarkan pemrosesan argumen tingkat lanjut.

Menginstal ekstensi alias

Versi Azure CLI minimum yang diperlukan untuk menggunakan ekstensi alias adalah 2.0.28. Untuk memeriksa versi CLI Anda, jalankan az --version. Jika Anda harus memperbarui penginstalan, ikuti petunjuknya di Menginstal Azure CLI.

Instal ekstensi alias dengan perintah az extension add.

az extension add --name alias

Verifikasi penginstalan ekstensi dengan az extension list. Jika sudah diinstal dengan benar, ekstensi alias tersebut akan dicantumkan dalam output perintah.

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

Name
------
alias

Terus memperbarui ekstensi alias

Ekstensi alias sedang dalam pengembangan aktif dan versi barunya dirilis secara teratur. Versi baru tidak diinstal saat Anda memperbarui CLI. Instal pembaruan untuk ekstensi menggunakan az extension update.

az extension update --name alias

Mengelola alias untuk Azure CLI

Ekstensi alias memungkinkan Anda membuat dan mengelola alias untuk perintah CLI lainnya. Untuk melihat semua perintah dan detail parameter yang tersedia, jalankan perintah alias dengan --help.

az alias --help

Membuat perintah alias sederhana

Salah satu penggunaan alias adalah untuk mempersingkat grup perintah atau nama perintah yang ada. Misalnya, Anda dapat mempersingkat grup perintah group menjadi rg dan perintah listmenjadi ls.

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

Alias yang baru ditentukan ini sekarang dapat digunakan di mana sesuai penentuannya.

az rg list
az rg ls
az vm ls

Jangan sertakan az sebagai bagian dari perintah alias.

Alias juga bisa berupa pintasan untuk perintah lengkap. Contoh berikutnya mencantumkan grup sumber daya yang tersedia beserta lokasinya dalam output tabel:

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

Sekarang ls-groups dapat dijalankan seperti perintah CLI lainnya.

az ls-groups

Membuat perintah alias dengan argumen

Anda juga dapat menambahkan argumen posisional ke perintah alias dengan memasukkannya sebagai {{ arg_name }} dalam nama alias. Diperlukan spasi kosong di dalam tanda kurung kurawal.

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

Contoh alias berikutnya menunjukkan cara menggunakan argumen posisional untuk mendapatkan alamat IP publik untuk VM.

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"

Saat menjalankan perintah ini, Anda memberikan nilai ke argumen posisional.

az get-vm-ip MyResourceGroup MyVM

Anda juga dapat menggunakan variabel lingkungan dalam perintah alias, yang dievaluasi saat runtime. Contoh berikutnya menambahkan alias create-rg, yang membuat grup sumber daya dalam eastus dan menambahkan tag owner. Tag ini diberi nilai variabel lingkungan lokal USER.

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

Untuk mendaftarkan variabel lingkungan di dalam perintah alias, tanda mata uang dolar $ harus dikeluarkan dari program.

Memproses argumen menggunakan template Jinja2

Jinja2 melakukan penggantian argumen dalam ekstensi alias. Template Jinja2 memungkinkan manipulasi argumen.

Dengan template Jinja2, Anda dapat menulis alias yang menggunakan berbagai jenis argumen daripada perintah yang mendasarinya. Misalnya, Anda dapat membuat alias yang menggunakan URL penyimpanan. Kemudian, URL ini diurai untuk meneruskan nama akun dan kontainer ke perintah penyimpanan.

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

Untuk mempelajari mesin template Jinja2, lihat dokumentasi Jinja2.

File konfigurasi alias

Cara lain untuk membuat dan memodifikasi alias adalah mengubah file konfigurasi alias. Definisi perintah alias ditulis ke dalam file konfigurasi, yang berada di $AZURE_CONFIG_DIR/alias. Nilai default AZURE_CONFIG_DIR adalah $HOME/.azure di macOS dan Linux, dan %USERPROFILE%\.azure di Windows. File konfigurasi alias ditulis dalam format file konfigurasi INI. Format untuk perintah alias adalah:

[alias_name]
command = invoked_commands

Untuk alias yang memiliki argumen posisional, format untuk perintah aliasnya adalah:

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

Membuat perintah alias dengan argumen melalui file konfigurasi alias

Contoh berikutnya menunjukkan alias untuk perintah dengan argumen. Perintah ini mendapatkan alamat IP publik untuk VM. Semua perintah alias harus berada di satu baris, dan menggunakan semua argumen dalam nama alias.

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

Menghapus ekstensi alias

Untuk menghapus instalan ekstensi, gunakan perintah az extension remove.

az extension remove --name alias

Jika Anda menghapus instalan dikarenakan terdapat bug atau masalah lain dengan ekstensi, ajukan masalah GitHub agar kami dapat memperbaikinya.