Mengelola Ekstensi Azure CLI: Menginstal, Memperbarui, dan Menghapus

Azure CLI menawarkan kemampuan untuk memuat ekstensi. Ekstensi untuk Azure CLI ditandai sebagai roda Python yang tidak dikirim sebagai bagian dari CLI tetapi dijalankan sebagai perintah CLI. Dengan ekstensi, Anda mendapatkan akses ke perintah eksperimental dan prarilis bersama 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 menghosting daftar ekstensi di situs dokumentasi.

Cara menginstal ekstensi

Menginstal ekstensi secara manual

Setelah Anda menemukan ekstensi untuk diinstal, gunakan az extension add untuk menginstalnya. Jika ekstensi muncul dalam output az extension list-available, Anda dapat menginstalnya 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 membangun indeks ekstensi privat dengan mengikuti format di index.json, lalu mengatur URL indeks ekstensi yang digunakan oleh Azure CLI ke dalamnya mulai 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 Anda menginstal ekstensi, ekstensi muncul di bawah nilai $AZURE_EXTENSION_DIR variabel shell. Jika variabel ini tidak diatur, lokasi default ada $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 Anda jalankan, dan secara otomatis menginstal ekstensi untuk Anda mulai dari versi 2.10.0. Fitur ini, yang dikenal sebagai penginstalan dinamis, diaktifkan secara default dimulai dengan versi 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 perintah.

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 mengembalikan kesalahan "perintah tidak ditemukan" jika ekstensi tidak diinstal.

az config set extension.use_dynamic_install=no

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

az config set extension.run_after_dynamic_install=no

Cara memperbarui ekstensi

Jika Anda menginstal ekstensi berdasarkan nama, perbarui menggunakan az extension update.

az extension update --name <extension-name>

Jika tidak, ekstensi dapat diperbarui dari sumber dengan mengikuti instruksi Instal ekstensi .

Jika Anda tidak dapat menggunakan CLI untuk mengatasi nama ekstensi, hapus instalan ekstensi dan coba instal ulang. Ekstensi mungkin juga menjadi bagian dari CLI dasar. Perbarui CLI seperti yang dijelaskan di Instal Azure CLI dan periksa apakah perintah ekstensi tersedia.

Cara menghapus ekstensi

Jika Anda tidak lagi memerlukan ekstensi, 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 $AZURE_EXTENSION_DIR shell 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 adalah beberapa jawaban atas pertanyaan umum lainnya tentang ekstensi CLI.

Format file apa yang diizinkan untuk penginstalan?

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

Dapatkah ekstensi menggantikan perintah yang ada?

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

Bagaimana cara mengetahui apakah ekstensi dalam prarilis?

Dokumentasi dan pengontrolan versi ekstensi menunjukkan apakah itu sedang dalam prarilis. Microsoft sering merilis perintah pratinjau sebagai ekstensi CLI, dengan opsi untuk memindahkannya ke produk CLI utama nanti. Ketika perintah dipindahkan dari ekstensi, ekstensi lama harus dihapus instalannya.

Dapatkah ekstensi saling bergantung satu sama lain?

Tidak. Karena CLI tidak menjamin urutan beban, dependensi mungkin tidak terpenuhi. Menghapus ekstensi tidak memengaruhi ekstensi lain.

Apakah ekstensi diperbarui bersama dengan CLI?

Tidak. Ekstensi harus diperbarui secara terpisah, seperti yang dijelaskan dalam Ekstensi pembaruan.

Bagaimana cara mengembangkan ekstensi kita sendiri?

Lihat repositori resmi untuk bantuan lebih lanjut. Azure/azure-cli-extensions