Membuat file Bicep dengan Visual Studio Code

Artikel
01/11/2025

Artikel ini menunjukkan cara menggunakan Visual Studio Code untuk membuat file Bicep.

Pasang Visual Studio Code.

Untuk menyiapkan lingkungan untuk pengembangan Bicep, lihat Pasang alat Bicep. Setelah menyelesaikan langkah-langkah tersebut, Anda memiliki Visual Studio Code dan ekstensi Bicep yang terinstal. Anda juga memiliki salah satu dari Azure CLI terbaru atau modul Microsoft Azure PowerShell terbaru.

Perintah Bicep

Visual Studio Code dilengkapi dengan beberapa perintah Bicep.

Buka atau buat file Bicep di Visual Studio Code, dan pilih menu Tampilan lalu Palet Perintah. Anda juga dapat menekan tombol F1 atau Ctrl+Shift+P untuk memunculkan palet perintah. Masukkan Bicep untuk mencantumkan perintah Bicep.

Cuplikan layar perintah Bicep Visual Studio Code di palet perintah.

Perintah ini meliputi:

Membuat templat Azure Resource Manager (ARM)
File Parameter Build
Buat File Konfigurasi Bicep
Dekompilasi ke Bicep
Sebarkan File Bicep
Membuat File Parameter
Impor Manifes Azure Kubernetes (EKSPERIMENTAL)
Sisipkan Sumber Daya
Buka Visualizer Bicep
Buka Visualizer Bicep ke Samping
Tempelkan JSON sebagai Bicep
Memulihkan Modul Bicep (Paksa)
Perlihatkan Panel Penyebaran
Perlihatkan Panel Penyebaran ke Samping

Perintah ini juga ditampilkan di menu konteks saat Anda mengeklik kanan file Bicep:

Dan saat Anda mengklik kanan file JSON:

Untuk mempelajari selengkapnya tentang perintah dalam artikel ini, lihat perintah Bicep CLI.

Perintah Bangun Templat ARM

Perintah mengonversi build file Bicep menjadi templat JSON ARM. Templat baru disimpan di folder yang sama dengan nama file yang sama. Jika ada file dengan nama file yang sama, file tersebut akan menimpa file yang lama. Lihat build untuk contoh dan informasi selengkapnya.

Perintah File Parameter Build

Perintah ini build-params juga mengonversi file parameter Bicep ke file parameter JSON. File parameter baru disimpan di folder yang sama dengan nama file yang sama. Jika ada file dengan nama file yang sama, file tersebut akan menimpa file yang lama. Lihat build-params untuk contoh.

Perintah Buat File Konfigurasi Bicep

File bicepconfig.json adalah file konfigurasi Bicep yang dapat menyesuaikan pengalaman pengembangan Bicep Anda. Anda dapat menambahkan bicepconfig.json ke beberapa direktori; file konfigurasi yang paling dekat dengan file Bicep dalam hierarki direktori digunakan. Saat Anda memilih Buat File Konfigurasi Bicep di Visual Studio Code, ekstensi akan membuka dialog bagi Anda untuk memilih folder. Folder default adalah tempat Anda menyimpan file Bicep. Jika file bicepconfig.json sudah ada di folder, Anda dapat menimpa file yang ada.

Untuk membuat file konfigurasi Bicep:

Buka Visual Studio Code.
Dari menu Tampilan, pilih Palet Perintah (atau tekan Ctrl/Cmd+Shift+P) lalu Bicep: Buat File Konfigurasi Bicep.
Pilih direktori file tempat Anda ingin menempatkan file.
Simpan file konfigurasi saat Anda selesai.

Dekompilasi ke dalam perintah Bicep

Perintah mendekompilasi decompile templat JSON ARM ke dalam file Bicep dan menempatkannya di direktori yang sama dengan templat JSON ARM asli. File baru memiliki nama file yang sama dengan .bicep ekstensi. Jika file Bicep dengan nama file yang sama sudah ada di folder yang sama, Visual Studio Code meminta Anda untuk menimpa file yang ada atau membuat salinan. Lihat dekombinasi untuk contoh.

Perintah Sebarkan File Bicep

Anda dapat menyebarkan file Bicep langsung dari Visual Studio Code. Pilih Sebarkan File Bicep dari palet perintah atau dari menu konteks. Ekstensi meminta Anda untuk masuk ke portal Azure, memilih langganan Anda, membuat atau memilih grup sumber daya, dan memasukkan nilai untuk parameter.

Catatan

Perintah penyebaran Bicep di Visual Studio Code menggunakan API autentikasi bawaan baru untuk mengelola autentikasi. Ini tidak menggunakan profil cloud dari bicepconfig.json. Untuk masuk ke cloud kustom, pilih Kelola>Ekstensi Pengaturan>Akun>>Microsoft Microsoft Sovereign Cloud. Saat ini, beberapa akun yang masuk tidak didukung.

Perintah Buat File Parameter

Perintah generate-params membuat file parameter di folder yang sama dengan file Bicep. Anda dapat memilih untuk membuat file parameter Bicep atau file parameter JSON. Nama file parameter Bicep baru adalah <bicep-file-name>.bicepparam, sementara nama file parameter JSON baru adalah <bicep-file-name>.parameters.json. Lihat generate-params untuk contoh dan informasi selengkapnya.

Perintah Impor Manifes AKS (Pratinjau)

Perintah ini mengimpor file manifes AKS dan membuat modul Bicep. Untuk informasi selengkapnya, lihat ekstensi Bicep Kubernetes (pratinjau) dan Mulai Cepat: Menyebarkan kluster Azure Kubernetes Service (AKS) menggunakan ekstensi Bicep Kubernetes (pratinjau).

Perintah Sisipkan Sumber Daya

Perintah ini mendeklarasikan sumber daya dalam file Bicep dengan memberikan ID sumber daya dari sumber daya yang ada. Pilih Sisipkan Sumber Daya di Visual Studio Code, dan masukkan ID sumber daya di palet perintah. Perlu waktu beberapa saat untuk menyisipkan sumber daya.

Anda dapat menggunakan salah satu metode ini untuk menemukan ID sumber daya:

Gunakan ekstensi Sumber Daya Azure untuk Visual Studio Code.
Periksa portal Azure.
Gunakan Azure CLI atau Azure PowerShell:
- Azure CLI
- Azure PowerShell
```
az resource list
```
```
Get-AzResource
```

Mirip dengan proses mengekspor templat, proses ini mencoba membuat sumber daya yang dapat digunakan. Namun, sebagian besar sumber daya yang disisipkan perlu diubah dalam beberapa cara sebelum dapat digunakan untuk menyebarkan sumber daya Azure. Untuk informasi selengkapnya, lihat Mendekompilasi JSON templat ARM ke Bicep.

Buka perintah Visualizer Bicep

Visualizer Bicep menunjukkan sumber daya yang ditentukan dalam file Bicep dan dependensi di antaranya. Diagram berikut adalah representasi visual file Bicep untuk Komputer Virtual Linux.

Anda dapat membuka Bicep Visualizer berdampingan dengan file Bicep.

Tempelkan JSON sebagai perintah Bicep

Anda dapat menempelkan cuplikan JSON dari templat ARM ke file Bicep. Visual Studio Code secara otomatis mendekompilasi JSON ke Bicep. Fitur ini hanya tersedia dengan ekstensi Bicep versi 0.14.0 atau yang lebih baru, dan diaktifkan secara default. Untuk menonaktifkan fitur ini, lihat Visual Studio Code dan ekstensi Bicep.

Fitur ini memungkinkan Anda untuk menempelkan:

Templat ARM JSON lengkap.
Sumber daya tunggal atau beberapa.
Nilai JSON seperti objek, array, atau string. String dengan tanda kutip ganda dikonversi menjadi satu dengan tanda kutip tunggal.

Misalnya, Anda dapat memulai dengan file Bicep berikut:

@description('Storage Account type')
@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
param storageAccountsku string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

var storageAccountName = '${uniqueString(resourceGroup().id)}storage'

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountsku
  }
  kind: 'StorageV2'
  tags: {
    ObjectName: storageAccountName
  }
  properties: {}
}

output storageAccountName string = storageAccountName

Dan tempelkan JSON berikut:

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2024-02-01",
  "name": "[parameters('batchAccountName')]",
  "location": "[parameters('location')]",
  "tags": {
    "ObjectName": "[parameters('batchAccountName')]"
  },
  "properties": {
    "autoStorage": {
      "storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
    }
  }
}

Visual Studio Code secara otomatis mengonversi JSON ke Bicep. Perhatikan bahwa Anda juga perlu menambahkan batchAccountName parameter.

Anda dapat mengurungkan dekompilasi dengan menekan Ctrl+Z. JSON asli muncul dalam file.

Perintah Pulihkan Modul Bicep

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. Lihat pemulihan untuk informasi selengkapnya dan contohnya.

Perlihatkan perintah Panel Penyebaran

Panel Penyebaran adalah fitur eksperimental di Visual Studio Code. Lihat Menggunakan Panel Penyebaran (Eksperimental!) untuk mempelajari selengkapnya.

Anda dapat membuka Panel Penyebaran berdampingan dengan file Bicep.

Gunakan saran perbaikan cepat

Bola lampu dalam Visual Studio Code mewakili saran perbaikan cepat. Ini muncul ketika editor mendeteksi masalah atau peluang peningkatan dalam kode Anda. Mengklik bola lampu menampilkan menu tindakan yang dapat mengatasi masalah atau meningkatkan kode.

Cuplikan layar saran perbaikan cepat Visual Studio Code.

Untuk perintah ekstrak, lihat Mengekstrak parameter, variabel, dan jenis. Di Tindakan Lainnya, disarankan untuk menambahkan dekorator.

Mengekstrak parameter, variabel, dan jenis

Mengekstrak variabel, parameter, dan jenis data yang ditentukan pengguna melibatkan isolasi dan menentukan komponen-komponen ini dari kode yang ada untuk meningkatkan struktur kode, pemeliharaan, dan kejelasan.

Cuplikan layar berikut menunjukkan definisi sumber daya kluster AKS. Anda dapat mengekstrak parameter atau variabel, atau jenis data yang ditentukan pengguna berdasarkan properti, seperti identity. identity Pilih baris dari kode, lalu pilih ikon bola lampu kuning. Jendela konteks menunjukkan opsi ekstrak yang tersedia.

Cuplikan layar variabel, parameter, ekstraksi jenis.

Ekstrak variabel: Buat variabel baru, ditambah opsi untuk memperbarui nama variabel:
Ekstrak parameter jenis data sederhana: Buat parameter baru dengan jenis data sederhana seperti string, int, dll., ditambah opsi untuk memperbarui nama parameter:
Ekstrak parameter jenis data yang ditentukan pengguna: Buat parameter baru dengan jenis data yang ditentukan pengguna, ditambah opsi untuk memperbarui nama parameter:

Ini memerlukan beberapa penyesuaian setelah ekstraksi.
Membuat jenis yang ditentukan pengguna: Buat jenis baru yang ditentukan pengguna, ditambah opsi untuk memperbarui nama jenis.

Tidak seperti opsi lain, ini tidak mengganti kode yang dipilih dengan referensi ke jenis baru. Dalam contoh sebelumnya, nilai identity tetap apa adanya. Untuk menggunakan jenis baru, Anda harus memasukkannya ke dalam kode Anda.

Tampilkan opsi Dokumentasi

Dari Visual Studio Code, Anda dapat membuka referensi templat untuk jenis sumber daya tempat Anda bekerja. Untuk melakukannya, arahkan kursor Anda ke atas nama simbolis sumber daya, dan pilih Tampilkan Dokumentasi.

Cuplikan layar opsi Tampilkan Dokumentasi di Visual Studio Code.

Buka file

Saat menentukan modul dan terlepas dari jenis file yang sedang direferensikan - file lokal, file registri modul, atau spesifikasi templat - Anda dapat membuka file dengan memilih atau menyoroti jalur modul dan menekan [F12]. Jika file yang direferensikan adalah Modul Terverifikasi Azure, AVM, maka Anda dapat beralih antara file JSON atau Bicep yang dikompilasi. Untuk membuka file Bicep modul registri privat, pastikan modul diterbitkan ke registri dengan WithSource pengalihan diaktifkan. Untuk informasi selengkapnya, lihat Menerbitkan file ke registri. Ekstensi Visual Studio Code Bicep versi 0.27.1 atau yang lebih baru diperlukan untuk membuka file Bicep dari registri modul privat.

Pecahkan masalah

Panel Problems meringkas kesalahan dan peringatan dalam file Bicep Anda:

Cuplikan layar panel Masalah di Visual Studio Code.

Diagnostik inti Bicep menyediakan daftar kode kesalahan dan peringatan.

Langkah berikutnya

Lanjutkan ke Mulai Cepat: Buat file Bicep dengan Visual Studio Code untuk tutorial cara menerapkan informasi dalam artikel ini.

Bagikan melalui