Menggunakan dan mengelola ekstensi dengan Azure CLI

Azure CLI menawarkan kemampuan untuk memuat ekstensi. Ekstensi untuk Azure CLI dicirikan sebagai roda Python yang tidak dikirim sebagai bagian dari CLI tetapi dijalankan sebagai perintah CLI. Dengan ekstensi, Anda mendapatkan akses ke perintah eksperimental dan pra-rilis bersamaan dengan kemampuan untuk menulis antarmuka CLI Anda sendiri. Artikel ini membahas cara mengelola ekstensi dan menjawab pertanyaan umum tentang penggunaannya.

Cara menemukan ekstensi

Untuk melihat ekstensi Azure CLI yang disediakan dan dikelola oleh Microsoft, gunakan perintah az extension list-available.

az extension list-available --output table

Kami juga meng-host daftar ekstensi di situs dokumentasi.

Cara menginstal ekstensi

Menginstal ekstensi secara manual

Setelah Anda menemukan ekstensi untuk diinstal, gunakan az extension add untuk mendapatkannya. Jika ekstensi dicantumkan di az extension list-available, Anda dapat menginstal ekstensi berdasarkan nama.

az extension add --name <extension-name>

Jika ekstensi berasal dari sumber daya eksternal atau Anda memiliki tautan langsung ke ekstensi tersebut, masukkan URL sumber atau jalur lokal. Ekstensi harus berupa file roda Python yang dikompilasi.

az extension add --source <URL-or-path>

Anda juga dapat membuat indeks ekstensi privat mengikuti format dalam index.json, lalu menetapkan URL indeks ekstensi yang digunakan oleh Azure CLI agar dimulai dari versi 2.20.0. Setelah itu, Anda dapat menginstal ekstensi berdasarkan nama dari indeks ekstensi privat.

az config set extension.index_url=<URL>
az extension add --name <extension-name>

Setelah diinstal, ekstensi dapat ditemukan dengan nilai variabel shell $AZURE_EXTENSION_DIR. Jika variabel ini tidak diatur, secara default, nialinya menjadi $HOME/.azure/cliextensions di Linux dan macOS, dan %USERPROFILE%\.azure\cliextensions di Windows.

Menginstal ekstensi secara otomatis

Saat Anda menjalankan perintah ekstensi yang tidak diinstal, Azure CLI dapat mengenali perintah yang dijalankan, dan otomatis menginstal ekstensi untuk Anda mulai dari versi 2.10.0. Fitur ini, yang disebut sebagai penginstalan dinamis, diaktifkan secara default sejak 2.12.0. Anda juga dapat mengaktifkannya melalui konfigurasi untuk versi yang didukung sebelumnya.

az config set extension.use_dynamic_install=yes_prompt

Gunakan perintah konfigurasi berikut untuk mengaktifkan penginstalan dinamis tanpa permintaan.

az config set extension.use_dynamic_install=yes_without_prompt

Gunakan perintah konfigurasi berikut untuk menonaktifkan fitur penginstalan dinamis untuk kembali ke perilaku default. Perintah ekstensi akan menampilkan kesalahan perintah tidak ditemukan jika ekstensi tidak diinstal.

az config set extension.use_dynamic_install=no

Secara default, perintah ekstensi yang meminta penginstalan dinamis akan terus berjalan setelah ekstensi diinstal. Anda dapat mengubah perilaku default dan membuat perintah keluar tanpa eksekusi ulang dengan mengatur properti run_after_dynamic_install ke no.

az config set extension.run_after_dynamic_install=no

Cara memperbarui ekstensi

Jika ekstensi diinstal berdasarkan nama, perbarui menggunakan az extension update.

az extension update --name <extension-name>

Jika tidak, ekstensi dapat diperbarui dari sumber dengan mengikuti petunjuk Menginstal ekstensi.

Jika nama ekstensi tidak dapat ditangani oleh CLI, hapus instalan dan coba instal ulang. Ekstensi juga bisa menjadi bagian dari CLI dasar. Coba perbarui CLI seperti yang dijelaskan di Menginstal Azure CLI dan lihat apakah perintah ekstensi ditambahkan.

Cara menghapus instalan ekstensi

Jika Anda tidak membutuhkan ekstensi lagi, hapus dengan az extension remove.

az extension remove --name <extension-name>

Anda juga dapat menghapus ekstensi secara manual dengan menghapusnya dari lokasi tempat ekstensi diinstal. Variabel shell $AZURE_EXTENSION_DIR menentukan tempat modul diinstal. Jika variabel ini tidak diatur, secara default, nialinya menjadi $HOME/.azure/cliextensions di Linux dan macOS, dan %USERPROFILE%\.azure\cliextensions di Windows.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

FAQ

Berikut beberapa jawaban atas pertanyaan umum lainnya tentang ekstensi CLI.

Format file apa yang boleh diinstal?

Saat ini, hanya roda Python yang dikompilasi yang dapat diinstal sebagai ekstensi.

Dapatkah ekstensi menggantikan perintah yang sudah ada?

Ya. Ekstensi dapat menggantikan perintah yang ada, tetapi sebelum menjalankan perintah yang telah diganti, CLI akan mengeluarkan peringatan.

Bagaimana cara mengetahui keberadaan ekstensi di pra-rilis?

Dokumentasi dan penerapan versi ekstensi akan muncul jika ada di pra-rilis. Microsoft sering kali merilis perintah pratinjau sebagai ekstensi CLI, dengan opsi untuk memindahkannya ke produk CLI utama di lain waktu. Saat perintah dipindahkan dari ekstensi, ekstensi lama akan dihapus.

Dapatkah ekstensi saling bergantung satu sama lain?

Nomor. Karena CLI tidak menjamin urutan pemuatan, dependensi mungkin tidak terpenuhi. Menghapus ekstensi tidak akan memengaruhi lainnya.

Apakah ekstensi diperbarui bersama dengan CLI?

Nomor. Ekstensi harus diperbarui secara terpisah, seperti yang dijelaskan dalam Memperbarui ekstensi.

Bagaimana cara mengembangkan ekstensi kita sendiri?

Lihat repositori resmi untuk mendapatkan bantuan lainnya. Azure/azure-cli-extensions