Bicep adalah bahasa komputer deklaratif, yang berarti elemen dapat muncul dalam urutan mana pun. Tidak seperti bahasa komputer imperatif, urutan elemennya tidak memengaruhi cara penyebaran diproses.
Contoh berikut menunjukkan implementasi elemen-elemen ini.
metadata description = 'Creates a storage account and a web app'
@description('The prefix to use for the storage account name.')
@minLength(3)
@maxLength(11)
param storagePrefix string
param storageSKU string = 'Standard_LRS'
param location string = resourceGroup().location
var uniqueStorageName = '${storagePrefix}${uniqueString(resourceGroup().id)}'
resource stg 'Microsoft.Storage/storageAccounts@2023-04-01' = {
name: uniqueStorageName
location: location
sku: {
name: storageSKU
}
kind: 'StorageV2'
properties: {
supportsHttpsTrafficOnly: true
}
}
module webModule './webApp.bicep' = {
name: 'webDeploy'
params: {
skuName: 'S1'
location: location
}
}
Metadata
Metadata di Bicep adalah nilai yang tidak dititip yang dapat disertakan dalam file Bicep. Ini memungkinkan Anda untuk memberikan informasi tambahan tentang file Bicep Anda, termasuk detail seperti nama, deskripsi, penulis, tanggal pembuatan, dan banyak lagi.
Cakupan target
Secara default, cakupan target diatur ke resourceGroup. Jika Anda melakukan penyebaran di tingkat grup sumber daya, Anda tidak perlu mengatur cakupan target dalam file Bicep Anda.
Dalam sebuah modul, Anda dapat menentukan cakupan yang berbeda dari cakupan untuk file Bicep lainnya. Untuk informasi selengkapnya, lihat Mengonfigurasi cakupan modul
Dekorator
Anda dapat menambahkan satu atau beberapa dekorator untuk setiap elemen berikut:
Gunakan dekorator ini untuk memastikan pengguna memberikan nilai yang benar. Dekorator ini hanya diizinkan pada param pernyataan. Untuk menyatakan bahwa properti harus merupakan salah satu dari sekumpulan nilai yang telah ditentukan sebelumnya dalam pernyataan type atau output , gunakan sintaks jenis union. Sintaks jenis union juga dapat digunakan dalam param pernyataan.
Gunakan dekorator ini untuk memastikan subkelas yang benar diidentifikasi dan dikelola. Untuk informasi selengkapnya, lihat Jenis data serikat yang ditandai kustom.
Tingkatkan BCP089 dari peringatan ke kesalahan ketika nama properti dari jenis data yang ditentukan penggunaan kemungkinan salah ketik. Untuk informasi selengkapnya, lihat Meningkatkan tingkat kesalahan.
Menandai parameter sebagai aman. Nilai parameter aman tidak disimpan ke riwayat penyebaran dan tidak dicatat ke dalam log. Untuk informasi lebih lanjut, lihat Untai (karakter) dan objek yang aman.
Parameter
Gunakan parameter untuk nilai yang perlu bervariasi untuk penyebaran yang berbeda. Anda dapat menentukan nilai default untuk parameter yang digunakan jika tidak ada nilai yang disediakan selama proses penyebaran.
Misalnya, Anda dapat menambahkan parameter SKU untuk menentukan ukuran yang berbeda untuk sumber daya. Anda mungkin lulus dengan nilai yang berbeda tergantung pada apakah Anda menggunakannya untuk menguji atau produksi.
param storageSKU string = 'Standard_LRS'
Parameter tersedia untuk digunakan dalam file Bicep Anda.
sku: {
name: storageSKU
}
Anda dapat menambahkan satu atau beberapa dekorator untuk setiap parameter. Untuk informasi selengkapnya, lihat Menggunakan dekorator.
Anda dapat membuat file Bicep Anda lebih mudah dibaca dengan merangkum ekspresi kompleks dalam variabel. Misalnya, Anda dapat menambahkan variabel untuk nama sumber daya yang dibangun dengan menggabungkan beberapa nilai bersamaan.
var uniqueStorageName = '${storagePrefix}${uniqueString(resourceGroup().id)}'
Terapkan variabel ini di mana pun Anda membutuhkan ekspresi yang kompleks.
Anda dapat menambahkan satu atau beberapa dekorator untuk setiap jenis data yang ditentukan pengguna. Untuk informasi selengkapnya, lihat Menggunakan dekorator.
Untuk informasi selengkapnya, lihat Jenis data yang ditentukan pengguna.
Fungsi
Dalam file Bicep, Anda dapat membuat fungsi Anda sendiri selain menggunakan fungsi Bicep standar yang secara otomatis tersedia dalam file Bicep Anda. Buat fungsi Anda sendiri saat Anda memiliki ekspresi rumit yang digunakan berulang kali dalam file Bicep Anda.
Untuk informasi selengkapnya, lihat Fungsi yang ditentukan pengguna.
Sumber
Gunakan kata kunci resource untuk menentukan sumber daya untuk disebarkan. Deklarasi sumber daya Anda menyertakan nama simbolis untuk sumber daya. Anda menggunakan nama simbolis ini di bagian lain file Bicep untuk mendapatkan nilai dari sumber daya.
Deklarasi sumber daya juga mencakup jenis sumber daya dan versi API. Dalam isi deklarasi sumber daya, sertakan properti yang khusus untuk jenis sumber dayanya.
Beberapa sumber daya memiliki hubungan induk/anak. Anda bisa menetapkan sumber daya anak baik di dalam sumber daya induk maupun di luar sumber daya induk.
Contoh berikut memperlihatkan cara menetapkan sumber daya anak di dalam sumber daya induk. Ini berisi akun penyimpanan dengan sumber daya anak (layanan file) yang ditetapkan di dalam akun penyimpanan. Layanan file juga memiliki sumber daya anak (berbagi) yang ditetapkan di dalamnya.
Contoh berikutnya memperlihatkan cara menetapkan sumber daya anak di luar sumber daya induk. Anda menggunakan properti induk untuk mengidentifikasi hubungan induk/anak. Tiga sumber daya yang sama ditetapkan.
Modul memungkinkan Anda untuk menggunakan kembali kode dari file Bicep dalam file Bicep lainnya. Dalam deklarasi modul, Anda menautkan ke file untuk digunakan kembali. Saat Anda menerapkan file Bicep, sumber daya dalam modul juga digunakan.
Dengan nama simbolis, Anda dapat mereferensikan modul dari tempat lain dalam file. Misalnya, Anda bisa mendapatkan nilai output dari modul dengan menggunakan nama simbolis dan nama nilai output.
Anda dapat menambahkan satu atau beberapa dekorator untuk setiap modul. Untuk informasi selengkapnya, lihat Menggunakan dekorator.
Gunakan output untuk mengembalikan nilai dari penyebaran. Biasanya, Anda mengembalikan nilai dari sumber daya yang disebarkan saat Anda perlu menggunakan kembali nilai tersebut untuk operasi lain.
Anda dapat menambahkan sumber daya atau modul ke file Bicep Anda yang disebarkan secara kondisional. Selama penyebaran, kondisi dievaluasi dan hasilnya menentukan apakah sumber daya atau modul disebarkan. Gunakan ekspresi if untuk menentukan penyebaran kondisional.
/*
This Bicep file assumes the key vault already exists and
is in same subscription and resource group as the deployment.
*/
param existingKeyVaultName string
String multibaris
Anda dapat memecah string menjadi beberapa baris. Gunakan tiga karakter kutipan tunggal ''' untuk memulai dan mengakhiri string multibaris.
Karakter dalam string multibaris ditangani apa adanya. Karakter escape tidak diperlukan. Anda tidak dapat menyertakan ''' di string multibaris. Interpolasi string saat ini tidak didukung.
Anda dapat memulai string tepat setelah membuka ''' atau menyertakan baris baru. Dalam kedua kasus, string yang dihasilkan tidak menyertakan baris baru. Bergantung pada akhir baris dalam file Bicep Anda, baris baru diinterpretasikan sebagai \r\n atau \n.
Contoh berikut memperlihatkan string multibaris.
var stringVar = '''
this is multi-line
string with formatting
preserved.
'''
Contoh sebelumnya setara dengan JSON berikut.
"variables": {
"stringVar": "this is multi-line\r\n string with formatting\r\n preserved.\r\n"
}
Dalam contoh berikut, definisi resourceGroup() dipecah menjadi beberapa baris.
var foo = resourceGroup(
mySubscription,
myRgName)
Lihat Array dan Objects untuk sampel deklarasi beberapa baris.
Pembatasan yang diketahui
Tidak ada dukungan untuk konsep apiProfile yang digunakan untuk memetakan apiProfile tunggal ke set apiVersion untuk setiap jenis sumber daya.
Fungsi yang ditentukan pengguna saat ini tidak didukung. Namun, fitur eksperimental saat ini dapat diakses. Untuk informasi selengkapnya, lihat Fungsi yang ditentukan pengguna di Bicep.
Beberapa fitur Bicep memerlukan perubahan terkait pada bahasa perantara (templat JSON Azure Resource Manager). Kami menetapkan fitur ini menjadi tersedia ketika semua pembaruan yang diperlukan telah disebarkan ke Azure global. Jika Anda menggunakan lingkungan lain, seperti Azure Stack, dapat terjadi penundaan dalam ketersediaan fitur. Fitur Bicep hanya tersedia ketika bahasa perantara juga telah diperbarui di lingkungan tersebut.
Langkah berikutnya
Sebagai pengantar ke Bicep, lihat Apa itu Bicep?. Untuk mengetahui jenis data Bicep, lihat Jenis data.
Bangun solusi end-to-end di Microsoft Azure untuk membuat Azure Functions, menerapkan dan mengelola aplikasi web, mengembangkan solusi yang menggunakan penyimpanan Azure, dan banyak lagi.