Konfigurasi CLI Azure

  • Artikel

Azure CLI memungkinkan konfigurasi pengguna untuk pengaturan seperti pengelogan, pengumpulan data, dan nilai argumen default. Azure CLI menawarkan perintah yang aman untuk mengelola sejumlah default, az config, dan opsi interaktif melalui az init. Nilai lain dapat diatur dalam file konfigurasi atau dengan variabel lingkungan. Artikel ini berisi informasi lebih lanjut tentang pengaturan konfigurasi pengguna ini dan cara mengonfigurasi Azure CLI.

Nilai konfigurasi yang digunakan oleh CLI dievaluasi dengan prioritas berikut, di mana item yang lebih tinggi diprioritaskan dalam daftar.

  1. Parameter baris perintah
  2. Variabel lingkungan
  3. Nilai dalam file konfigurasi yang ditetapkan dengan az config atau az init

Mengonfigurasi pengaturan dengan az init

Cara termudah untuk mengatur konfigurasi Azure CLI adalah dengan menggunakan perintah interaktif az init. Pilih konfigurasi umum seperti "interaksi" atau "otomatisasi," atau pilih untuk menelusuri konfigurasi individual. Hal yang berguna dari pendekatan ini adalah bahwa az init menyediakan alasan mengapa Anda harus memilih salah satu opsi konfigurasi.

az init

Mengonfigurasi pengaturan dengan konfigurasi az

Anda dapat mengatur default untuk Azure CLI dengan perintah az config set. Perintah ini menggunakan daftar yang dipisahkan spasi dari pasangan key=value sebagai argumen. Nilai yang disediakan akan digunakan oleh CLI sebagai pengganti argumen yang diperlukan.

Tabel berikut berisi daftar kunci konfigurasi yang tersedia.

Nama Deskripsi
defaults.group Grup sumber daya default yang akan digunakan untuk semua perintah.
defaults.location Lokasi default yang akan digunakan untuk semua perintah.
defaults.web Nama aplikasi default yang akan digunakan untuk perintah az webapp.
defaults.vm Nama VM default yang akan digunakan untuk perintah az vm.
defaults.vmss Nama set skala mesin virtual (VMSS) default yang akan digunakan untuk perintah az vmss.
defaults.acr Nama registri kontainer default yang akan digunakan untuk perintah az acr.

Misalnya, berikut cara menetapkan grup sumber daya default dan lokasi untuk semua perintah.

az config set defaults.location=westus2 defaults.group=MyResourceGroup

Perintah berikut menonaktifkan link survei saat menjalankan perintah Azure CLI:

az config set output.show_survey_link=no

File konfigurasi CLI

File konfigurasi CLI berisi pengaturan lain yang digunakan untuk mengelola perilaku CLI. File konfigurasinya terletak di $AZURE_CONFIG_DIR/config. Nilai default AZURE_CONFIG_DIR adalah $HOME/.azure di Linux dan macOS, dan %USERPROFILE%\.azure di Windows.

File konfigurasi ditulis dalam format file INI. Header bagian menentukan format file, diikuti dengan daftar entri nilai kunci.

  • Header bagian ditulis sebagai [section-name]. Nama bagian peka huruf besar/kecil.
  • Entri ditulis sebagai key=value. Nama kunci tidak peka huruf besar/kecil.
  • Komentar adalah setiap baris yang dimulai dengan # atau ;. Komentar sebaris tidak diizinkan.

Boolean tidak peka huruf besar/kecil. Nilai berikut mewakili boolean:

  • True: 1, yes, true, on
  • False: 0, no, false, off

Berikut contoh file konfigurasi CLI yang menonaktifkan semua permintaan konfirmasi dan menyiapkan pengelogan ke direktori /var/log/azure.

[core]
disable_confirm_prompt=Yes

[logging]
enable_log_file=yes
log_dir=/var/log/azure

Lihat bagian berikutnya untuk detail tentang semua nilai konfigurasi yang tersedia beserta artinya. Untuk detail lengkap tentang format file INI, lihat Dokumentasi Python tentang INI.

Nilai konfigurasi CLI dan variabel lingkungan

Tabel berikut berisi semua bagian dan nama opsi yang dapat ditempatkan dalam file konfigurasi. Variabel lingkungan yang sesuai ditetapkan sebagai AZURE_{section}_{name}, di semua batas. Misalnya, default output untuk core diatur dalam variabel AZURE_CORE_OUTPUT, default storage_account untuk batchai diatur dalam variabel AZURE_BATCHAI_STORAGE_ACCOUNT, dan default location diatur dalam variabel AZURE_DEFAULTS_LOCATION.

Saat Anda memasukkan nilai default, argumen tersebut tidak diperlukan lagi oleh perintah apa pun. Sebagai gantinya, nilai default akan digunakan.

Bagian Nama Tipe Deskripsi
inti output string Format output default. Nilai yang diizinkan: json (default), jsonc, , yamlyamlc, table, tsv, none. Untuk informasi selengkapnya, lihat Format output untuk perintah Azure CLI.
disable_confirm_prompt Boolean Mengaktifkan/menonaktifkan permintaan konfirmasi.
display_region_identified Boolean Pelanggan Azure dapat memilih untuk menyebarkan sumber daya di berbagai wilayah. Dalam beberapa kasus, pelanggan mungkin dapat mengurangi biaya dengan memilih wilayah terdekat yang menawarkan layanan yang sama. Jika wilayah terdekat diidentifikasi, pesan akan menampilkan wilayah yang akan dipilih untuk penyebaran di masa mendatang. Pengaturan ini mengontrol apakah pesan ditampilkan.
collect_telemetry Boolean Mengizinkan Microsoft mengumpulkan data anonim tentang penggunaan CLI. Untuk informasi privasi, lihat lisensi Azure CLI MIT.
only_show_errors Boolean Hanya tampilkan kesalahan selama pemanggilan perintah. Dengan kata lain, hanya kesalahan yang ditulis ke stderr. Ini menekan peringatan dari perintah pratinjau, yang tidak digunakan lagi dan percobaan. Ini juga tersedia untuk perintah individual dengan --only-show-errors parameter .
no_color Boolean Nonaktifkan warna. Pesan berwarna asli diawali dengan DEBUG, , INFOWARNING dan ERROR. Boolean ini melewati masalah pustaka pihak ketiga di mana warna terminal tidak dapat kembali setelah stdout pengalihan.
Klien show_secrets_warning Boolean Aktifkan/nonaktifkan peringatan untuk output informasi sensitif.
pengelogan enable_log_file Boolean Aktifkan/nonaktifkan pengelogan.
log_dir string Direktori tempat tujuan log ditulis. Secara default nilai ini adalah ${AZURE_CONFIG_DIR}/logs*.
default grup string Grup sumber daya default yang akan digunakan untuk semua perintah.
lokasi string Lokasi default yang akan digunakan untuk semua perintah.
web string Nama aplikasi default yang akan digunakan untuk perintah az webapp.
vm string Nama VM default yang akan digunakan untuk perintah az vm.
vmss string Nama set skala mesin virtual (VMSS) default yang akan digunakan untuk perintah az vmss.
acr string Nama registri kontainer default yang akan digunakan untuk perintah az acr.
Penyimpanan akun string Nama akun penyimpanan default (misalnya, mystorageaccount in https://mystorageaccount.blob.core.windows.net) untuk digunakan untuk az storage perintah data-plane (misalnya, az storage container list).
kunci string Kunci akses default yang akan digunakan untuk perintah data-plane az storage.
sas_token string Token SAS default yang akan digunakan untuk perintah data-plane az storage.
String_koneksi string String koneksi default yang akan digunakan untuk perintah data-plane az storage.
batchai storage_account string Akun penyimpanan default yang akan digunakan untuk perintah az batchai.
storage_key string Kunci penyimpanan default yang akan digunakan untuk perintah az batchai.
batch akun string Nama akun Azure Batch yang akan digunakan untuk perintah az batch.
access_key string Kunci akses default yang akan digunakan untuk perintah az batch. Hanya digunakan dengan otorisasi aad.
titik akhir string Titik akhir default untuk terhubung untuk perintah az batch.
auth_mode string Mode otorisasi yang akan digunakan untuk perintah az batch. Nilai yang diizinkan: shared_key, aad.
cloud nama string Cloud default untuk semua perintah az. Nilai yang diizinkan: AzureCloud (default), AzureChinaCloud, AzureUSGovernment. Untuk mengubah cloud, Anda dapat menggunakan perintah az cloud set –name. Misalnya, lihat Mengelola Cloud dengan Azure CLI.
ekstensi use_dynamic_install string Instal ekstensi jika belum ditambahkan saat menjalankan perintah darinya. Nilai yang diizinkan: no (default), yes_prompt, yes_without_prompt.
run_after_dynamic_install Boolean Terus jalankan perintah saat ekstensi diinstal secara dinamis untuknya. Defaultnya adalah False.
index_url string URL file indeks ekstensi privat mengikuti format di index.json. Setelah ditentukan, eksekusi az extension add --name <extension-name> menggunakan file tersebut untuk menemukan ekstensi yang akan ditambahkan.

Catatan

Anda mungkin melihat nilai lain dalam file konfigurasi, tetapi ini dikelola langsung melalui perintah CLI, termasuk az config. Nilai yang tercantum dalam tabel sebelumnya adalah satu-satunya nilai yang harus Anda ubah sendiri.