Bagikan melalui

Perintah Bicep CLI

  • Artikel

Artikel ini menjelaskan perintah yang dapat digunakan di Bicep CLI. Anda memiliki dua opsi untuk menjalankan perintah ini: baik dengan menggunakan Azure CLI atau dengan langsung memanggil perintah Bicep CLI. Setiap metode memerlukan proses penginstalan yang berbeda. Untuk informasi selengkapnya, lihat Menginstal Azure CLI dan Menginstal Azure PowerShell.

Artikel ini memperlihatkan cara menjalankan perintah di Azure CLI. Saat menjalankan Azure CLI, Anda dapat memulai perintah dengan az. Jika Anda tidak menggunakan Azure CLI, jalankan perintah tanpa az di awal perintah. Misalnya, az bicep build menjadi bicep build, dan az bicep version menjadi bicep --version.

build

Perintah build mengonversi file Bicep ke templat Azure Resource Manager (templat ARM). Biasanya, Anda tidak perlu menjalankan perintah ini karena dijalankan secara otomatis saat Anda menyebarkan file Bicep. Jalankan secara manual jika Anda ingin melihat JSON templat ARM yang dibuat dari file Bicep Anda.

Menggunakan salah satu fitur Bicep berikut secara otomatis mengaktifkan pembuatan kode bahasa versi 2.0:

Contoh berikut mengonversi file Bicep bernama main.bicep ke templat ARM bernama main.json. File baru dibuat di direktori yang sama dengan file Bicep.

az bicep build --file main.bicep

Contoh berikutnya akan menyimpan main.json ke direktori yang berbeda.

az bicep build --file main.bicep --outdir c:\jsontemplates

Contoh berikutnya akan menentukan nama dan lokasi file yang akan dibuat.

az bicep build --file main.bicep --outfile c:\jsontemplates\azuredeploy.json

Untuk mencetak file ke stdout, gunakan:

az bicep build --file main.bicep --stdout

Jika file Bisep Anda menyertakan modul yang mereferensikan registri eksternal, perintah build secara otomatis memanggil pemulihan. Perintah pemulihan mendapatkan file dari registri dan menyimpannya di cache lokal.

Catatan

Perintah pemulihan tidak merefresh cache. Untuk mengetahui informasi selengkapnya, lihat memulihkan.

Agar tidak memanggil pemulihan secara otomatis, gunakan sakelar --no-restore:

az bicep build --no-restore <bicep-file>

Proses build dengan sakelar --no-restore gagal jika salah satu modul eksternal belum di-cache:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

Ketika Anda mendapatkan kesalahan ini, jalankan perintah build tanpa sakelar --no-restore atau jalankan bicep restore terlebih dahulu.

Untuk menggunakan sakelar --no-restore , Anda harus memiliki Bicep CLI versi 0.4.X atau yang lebih tinggi.

build-params

Perintah build-params membangun file .bicepparam ke dalam file parameter JSON.

az bicep build-params --file params.bicepparam

Perintah ini mengonversi file parameter params.bicepparam menjadi file parameter JSON params.json .

dekompilasi

Perintah decompile mengonversi JSON templat ARM ke file Bicep.

az bicep decompile --file main.json

Perintah membuat file bernama main.bicep di direktori yang sama dengan main.json. Jika main.bicep ada di direktori yang sama, gunakan tombol --force untuk menimpa file Bicep yang ada.

Untuk informasi selengkapnya tentang cara menggunakan perintah ini, lihat Mendekompilasi JSON templat ARM ke Bicep.

decompile-params

Perintah decompile-params mendekompilasi file parameter JSON ke file parameter .bicepparam .

az bicep decompile-params --file azuredeploy.parameters.json --bicep-file ./dir/main.bicep

Perintah ini mendekompilasi file parameter azuredeploy.parameters.json ke dalam file azuredeploy.parameters.bicepparam . --bicep-file menentukan jalur ke file Bicep (relatif terhadap file .bicepparam) yang direferensikan dalam using deklarasi.

format

Perintah format memformat file Bicep. Ini memiliki fungsi yang sama dengan SHIFT+ALT+F pintasan di Visual Studio Code.

az bicep format --file main.bicep

generate-params

Perintah generate-params membangun file parameter dari file Bicep yang diberikan, memperbarui jika ada file parameter yang ada.

az bicep generate-params --file main.bicep --output-format bicepparam --include-params all

Perintah membuat file parameter Bicep bernama main.bicepparam. File parameter berisi semua parameter dalam file Bicep, baik dikonfigurasi dengan nilai default atau tidak.

az bicep generate-params --file main.bicep --outfile main.parameters.json

Perintah membuat file parameter bernama main.parameters.json. File parameter hanya berisi parameter tanpa nilai default yang dikonfigurasi dalam file Bicep.

Instal

Perintah install menambahkan Bicep CLI ke lingkungan lokal Anda. Untuk informasi selengkapnya, lihat Instal Alat Bicep. Perintah ini hanya tersedia melalui Azure CLI.

Untuk menginstal versi terkini, gunakan:

az bicep install

Untuk memasang versi tertentu:

az bicep install --version v0.3.255

lint

Perintah lint mengembalikan kesalahan dan pelanggaran aturan linter file Bicep.

az bicep lint --file main.bicep

Jika file Bicep Anda menyertakan modul yang mereferensikan registri eksternal, perintah lint secara otomatis memanggil pemulihan. Perintah pemulihan mendapatkan file dari registri dan menyimpannya di cache lokal.

Catatan

Perintah pemulihan tidak merefresh cache. Untuk mengetahui informasi selengkapnya, lihat memulihkan.

Agar tidak memanggil pemulihan secara otomatis, gunakan sakelar --no-restore:

az bicep lint --no-restore <bicep-file>

Proses lint dengan --no-restore sakelar gagal jika salah satu modul eksternal belum di-cache:

The module with reference "br:exampleregistry.azurecr.io/bicep/modules/storage:v1" has not been restored.

Ketika Anda mendapatkan kesalahan ini, jalankan perintah lint tanpa sakelar --no-restore atau jalankan bicep restore terlebih dahulu.

versi daftar

Perintah list-versions mengembalikan semua versi Bicep CLI yang tersedia. Gunakan perintah ini untuk melihat apakah Anda ingin meningkatkan atau menginstal versi baru. Perintah ini hanya tersedia melalui Azure CLI.

az bicep list-versions

Perintah tersebut mengembalikan array versi yang tersedia.

[
  "v0.28.1",
  "v0.27.1",
  "v0.26.170",
  "v0.26.54",
  "v0.25.53",
  "v0.25.3",
  "v0.24.24",
  "v0.23.1",
  "v0.22.6",
  "v0.21.1",
  "v0.20.4",
  "v0.19.5",
  "v0.18.4",
  "v0.17.1",
  "v0.16.2",
  "v0.16.1",
  "v0.15.31",
  "v0.14.85",
  "v0.14.46",
  "v0.14.6",
  "v0.13.1",
  "v0.12.40",
  "v0.12.1",
  "v0.11.1",
  "v0.10.61",
  "v0.10.13",
  "v0.9.1",
  "v0.8.9",
  "v0.8.2",
  "v0.7.4"
]

terbitkan

Perintah publish menambahkan modul ke registri. Registri kontainer Azure harus ada dan penerbitan akun ke registri harus memiliki izin yang benar. Untuk informasi selengkapnya tentang menyiapkan registri modul, lihat Menggunakan registri privat untuk modul Bicep. Untuk menerbitkan modul, akun harus memiliki profil dan izin yang benar untuk mengakses registri. Anda dapat mengonfigurasi profil dan prioritas kredensial untuk mengautentikasi ke registri dalam file konfigurasi Bicep.

Setelah menerbitkan file ke registri, Anda dapat mereferensikannya dalam modul.

Untuk menggunakan perintah terbitkan, Anda harus memiliki Bicep CLI versi 0.14.X atau yang lebih tinggi. Untuk menggunakan --documentationUri/-d parameter , Anda harus memiliki Bicep CLI versi 0.14.X atau yang lebih tinggi.

Untuk menerbitkan modul ke registri, gunakan:

az bicep publish --file <bicep-file> --target br:<registry-name>.azurecr.io/<module-path>:<tag> --documentationUri <documentation-uri>

Contohnya:

az bicep publish --file storage.bicep --target br:exampleregistry.azurecr.io/bicep/modules/storage:v1 --documentationUri https://www.contoso.com/exampleregistry.html

Perintah publish tidak mengenali alias yang ditentukan dalam file bicepconfig.json . Berikan jalur modul lengkap.

Peringatan

Penerbitan ke target yang sama menimpa modul lama. Kami menyarankan Anda meningkatkan versi saat memperbarui.

pulihkan

Ketika file Bicep Anda menggunakan modul yang dipublikasikan ke registri, perintah restore mendapatkan salinan dari semua modul yang diperlukan dari registri. Ia menyimpan salinan tersebut dalam cache lokal. File Bisep hanya dapat dibangun ketika file eksternal tersedia di cache lokal. Biasanya, menjalankan pemulihan tidak diperlukan karena secara otomatis dipicu oleh proses build.

Untuk memulihkan modul eksternal ke cache lokal, akun harus memiliki profil dan izin yang benar untuk mengakses registri. Anda dapat mengonfigurasi profil dan prioritas kredensial untuk mengautentikasi ke registri dalam file konfigurasi Bicep.

Untuk menggunakan perintah pemulihan, Anda harus memiliki Bicep CLI versi 0.4.X atau yang lebih tinggi. Perintah ini sekarang hanya tersedia saat memanggil Bicep CLI secara langsung. Perintah ini sekarang tidak tersedia melalui perintah Azure CLI.

Untuk memulihkan modul eksternal secara manual untuk file, gunakan:

az bicep restore --file <bicep-file> [--force]

File Bicep yang Anda sediakan adalah file yang ingin Anda sebarkan. File harus berisi modul yang menautkan ke registri. Misalnya, Anda dapat memulihkan file berikut:

module stgModule 'br:exampleregistry.azurecr.io/bicep/modules/storage:v1' = {
  name: 'storageDeploy'
  params: {
    storagePrefix: 'examplestg1'
  }
}

Cache lokal ditemukan dalam:

  • Di Windows

    %USERPROFILE%\.bicep\br\<registry-name>.azurecr.io\<module-path\<tag>

  • Di Linux

    /home/<username>/.bicep

  • Di Mac

    ~/.bicep

Perintah restore tidak merefresh cache jika modul sudah di-cache. Untuk merefresh cache, Anda dapat menghapus jalur modul dari cache atau menggunakan tombol --force dengan perintah restore.

peningkatan

Perintah upgrade memperbarui versi terinstal Anda dengan versi terbaru. Perintah ini hanya tersedia melalui Azure CLI.

az bicep upgrade

version

Perintah version mengembalikan versi terinstal Anda.

az bicep version

Perintah memperlihatkan nomor versi.

Bicep CLI version 0.22.6 (d62b94db31)

Untuk memanggil perintah ini secara langsung melalui Bicep CLI, gunakan:

bicep --version

Jika Bicep CLI belum diinstal, Anda akan menemukan pesan kesalahan yang menyatakan bahwa Bicep CLI tidak ditemukan.

Langkah berikutnya

Untuk mempelajari penyebaran file Bicep, lihat: