Menyebarkan file Bicep dengan Azure CLI

Artikel
01/14/2025

Artikel ini menjelaskan cara menggunakan Azure CLI dengan file Bicep untuk menyebarkan sumber daya Anda ke Azure. Jika Anda tidak terbiasa menyebarkan dan mengelola solusi Azure Anda, lihat Apa itu Bicep?.

Prasyarat

Anda memerlukan file Bicep untuk disebarkan, dan file harus lokal. Anda juga memerlukan Azure CLI dan tersambung ke Azure:

Instal perintah Azure CLI di komputer lokal Anda. Untuk menyebarkan file Bicep, Anda memerlukan Azure CLI versi 2.20.0 atau yang lebih baru.
Gunakan az login untuk menyambungkan ke Azure. Jika Anda memiliki beberapa langganan Azure, Anda mungkin juga perlu menjalankan az account set.

Sampel untuk Azure CLI ditulis untuk bash shell. Untuk menjalankan sampel ini di Windows PowerShell atau Command Prompt (cmd), Anda mungkin perlu mengubah elemen skrip.

Jika Anda tidak menginstal Azure CLI, Anda dapat menggunakan Azure Cloud Shell. Untuk informasi selengkapnya, lihat Menyebarkan file Bicep dengan Azure Cloud Shell.

Izin yang diperlukan

Untuk menyebarkan file Bicep atau templat ARM, Anda memerlukan akses tulis pada sumber daya yang Anda sebarkan dan mengakses ke semua operasi di Microsoft.Resources/deployments resource type. Misalnya, untuk menyebarkan mesin virtual, Anda memerlukan izin Microsoft.Compute/virtualMachines/write dan Microsoft.Resources/deployments/*. Operasi bagaimana-jika memiliki persyaratan izin yang sama.

Untuk daftar peran dan izin, lihat Peran bawaan Azure.

Cakupan penyebaran

Anda dapat menargetkan penyebaran Anda ke grup sumber daya, langganan, grup manajemen, atau penyewa. Bergantung pada cakupan penyebaran, Anda menggunakan perintah yang berbeda, dan pengguna yang menyebarkan file Bicep harus memiliki izin yang diperlukan untuk membuat sumber daya untuk setiap cakupan.

Untuk menyebarkan ke grup sumber daya, gunakan az deployment group create:

az deployment group create --resource-group <resource-group-name> --template-file <path-to-bicep>

Untuk menyebarkan ke langganan, gunakan az deployment sub create:
```
az deployment sub create --location <location> --template-file <path-to-bicep>
```
Untuk informasi selengkapnya tentang penyebaran tingkat langganan, lihat Menggunakan Bicep untuk menyebarkan sumber daya ke langganan.
Untuk menyebarkan ke grup manajemen, gunakan az deployment mg create:
```
az deployment mg create --location <location> --template-file <path-to-bicep>
```
Untuk informasi selengkapnya tentang penyebaran tingkat grup manajemen, lihat Menggunakan Bicep untuk menyebarkan sumber daya ke grup manajemen.
Untuk menyebarkan ke penyewa, gunakan az deployment tenant create:
```
az deployment tenant create --location <location> --template-file <path-to-bicep>
```
Untuk informasi selengkapnya tentang penyebaran tingkat penyewa, lihat Menggunakan Bicep untuk menyebarkan sumber daya ke penyewa.

Menyebarkan file Bicep lokal

Anda dapat menyebarkan file Bicep dari komputer lokal atau file eksternal Anda. Bagian ini menjelaskan cara menyebarkan file Bicep lokal.

Jika Anda menyebarkan ke grup sumber daya yang tidak ada, buatlah grup sumber daya. Nama grup sumber daya hanya dapat mencakup karakter alfanumerik, titik, garis bawah, tanda hubung, dan tanda kurung. Ini bisa hingga 90 karakter dan tidak dapat berakhir dalam satu titik.

az group create --name ExampleGroup --location "Central US"

Untuk menyebarkan file Bicep lokal, gunakan sakelar --template-file dalam perintah penyebaran. Contoh berikut juga menunjukkan cara mengatur nilai parameter:

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file <path-to-bicep> \
  --parameters storageAccountType=Standard_GRS

Diperlukan beberapa menit untuk menyelesaikan penyebaran. Setelah selesai, Anda akan melihat pesan yang menyertakan hasil berikut:

"provisioningState": "Succeeded",

Sebarkan file Bicep jarak jauh

Azure CLI saat ini tidak mendukung penyebaran file Bicep jarak jauh. Anda dapat menggunakan Bicep CLI untuk membangun file Bicep ke templat JSON lalu memuat file JSON ke lokasi jarak jauh. Untuk informasi selengkapnya, lihat Menyebarkan templat jarak jauh.

Parameter

Untuk meneruskan nilai parameter, Anda dapat menggunakan parameter sebaris atau file parameter. File parameter dapat berupa file parameter Bicep atau file parameter JSON.

Parameter sebaris

Untuk meneruskan parameter sebaris, berikan nilai dalam parameters. Misalnya, untuk meneruskan string dan array ke file Bicep dalam shell Bash, gunakan:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString='inline string' exampleArray='["value1", "value2"]'

Jika Anda menggunakan Azure CLI dengan cmd atau PowerShell, teruskan array dalam format: exampleArray="['value1','value2']".

Anda juga bisa mendapatkan konten file untuk menyediakan konten tersebut sebagai parameter sebaris. Awali nama file dengan @:

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters exampleString=@stringContent.txt exampleArray=@arrayContent.json

Mendapatkan nilai parameter dari file sangat berguna ketika Anda perlu memberikan nilai konfigurasi. Misalnya, Anda dapat memberikan nilai cloud-init untuk mesin virtual Linux.

Format arrayContent.jspada adalah:

[
  "value1",
  "value2"
]

Untuk meneruskan objek, gunakan JSON (saat mengatur tag, misalnya). File Bicep Anda mungkin menyertakan parameter seperti ini:

"resourceTags": {
  "type": "object",
  "defaultValue": {
    "Cost Center": "IT Department"
  }
}

Seperti yang ditunjukkan dalam skrip Bash berikut, Anda juga dapat meneruskan string JSON untuk mengatur parameter. Gunakan tanda kutip ganda di sekitar JSON yang ingin Anda teruskan ke objek:

tags='{"Owner":"Contoso","Cost Center":"2345-324"}'
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags="$tags"

Jika Anda menggunakan Azure CLI dengan cmd atau PowerShell, teruskan objek dalam format berikut:

$tags="{'Owner':'Contoso','Cost Center':'2345-324'}"
az deployment group create --name addstorage  --resource-group myResourceGroup \
--template-file $bicepFile \
--parameters resourceName=abcdef4556 resourceTags=$tags

Anda dapat menggunakan variabel untuk berisi nilai parameter. Atur variabel ke semua nilai parameter dalam skrip Bash Anda, dan tambahkan ke perintah penyebaran:

params="prefix=start suffix=end"

az deployment group create \
  --resource-group testgroup \
  --template-file <path-to-bicep> \
  --parameters $params

Namun, jika Anda menggunakan Azure CLI dengan cmd atau PowerShell, atur variabel ke string JSON. Hindari tanda kutip: $params = '{ \"prefix\": {\"value\":\"start\"}, \"suffix\": {\"value\":\"end\"} }'.

Evaluasi parameter mengikuti urutan berurutan, yang berarti bahwa jika nilai ditetapkan beberapa kali, maka hanya nilai terakhir yang ditetapkan yang digunakan. Untuk menetapkan parameter dengan benar, disarankan agar Anda memberikan file parameter anda pada awalnya dan kemudian menggunakan sintaks KEY=VALUE untuk secara selektif mengambil alih parameter tertentu. Jika Anda menyediakan .bicepparam file parameter, Anda hanya dapat menggunakan argumen ini sekali.

File parameter Bicep

Daripada meneruskan parameter sebagai nilai sebaris dalam skrip Anda, Anda mungkin merasa lebih mudah untuk menggunakan file parameter Bicep atau file parameter JSON yang berisi nilai parameter. File parameter harus berupa file lokal karena Azure CLI tidak mendukung file parameter eksternal. Untuk informasi selengkapnya tentang file parameter, lihat Membuat file parameter untuk penyebaran Bicep.

Anda dapat menggunakan file parameter Bicep untuk menyebarkan file Bicep dengan Azure CLI versi 2.53.0 atau yang lebih baru dan Bicep CLI versi 0.22.X atau yang lebih baru. using Dengan pernyataan dalam file parameter Bicep, tidak perlu memberikan --template-file sakelar saat menentukan file parameter Bicep untuk --parameters sakelar. Termasuk sakelar --template-file akan meminta, "Hanya templat .bicep yang diizinkan dengan file .bicepparam," kesalahan.

Contoh berikut menunjukkan file parameter bernama storage.bicepparam. File berada di direktori yang sama tempat perintah berjalan:

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --parameters storage.bicepparam

File parameter JSON

Contoh berikut menunjukkan file parameter bernama storage.parameters.json. File berada di direktori yang sama tempat perintah berjalan:

az deployment group create \
  --name ExampleDeployment \
  --resource-group ExampleGroup \
  --template-file storage.bicep \
  --parameters '@storage.parameters.json'

Anda dapat menggunakan parameter sebaris dan file parameter lokasi dalam operasi penyebaran yang sama. Untuk informasi selengkapnya, lihat Prioritas parameter.

Pratinjau perubahan

Sebelum menyebarkan file Bicep Anda, Anda dapat melakukan pratinjau pada perubahan yang akan dilakukan file Bicep ke lingkungan Anda. Gunakan operasi bagaimana-jika untuk memverifikasi bahwa file Bicep membuat perubahan yang Anda harapkan. Bagaimana-jika juga memvalidasi file Bicep untuk kesalahan.

Menyebarkan spesifikasi templat

Saat ini, Azure CLI tidak menyediakan file Bicep untuk membantu membuat spesifikasi templat. Namun, Anda dapat membuat file Bicep dengan sumber daya Microsoft.Resources/templateSpecs untuk menyebarkan spesifikasi templat. Sampel Buat spesifikasi templat memperlihatkan cara membuat spesifikasi templat dalam file Bicep. Anda juga dapat membangun file Bicep Anda ke JSON dengan menggunakan Bicep CLI dan kemudian templat JSON untuk membuat spesifikasi templat.

Nama penyebaran

Saat menyebarkan file Bicep, Anda dapat memberi nama penyebaran. Nama ini dapat membantu Anda mengambil penyebaran dari riwayat penyebaran. Jika Anda tidak memberikan nama untuk penyebaran, namanya menjadi nama file Bicep. Misalnya, jika Anda menyebarkan file Bicep bernama main.bicep dan tidak menentukan nama penyebaran, penyebaran diberi nama main.

Setiap kali Anda menjalankan penyebaran, entri ditambahkan ke riwayat penyebaran grup sumber daya dengan nama penyebaran. Jika Anda menjalankan penyebaran lain dan memberinya nama yang sama, entri sebelumnya diganti dengan penyebaran saat ini. Jika Anda ingin mempertahankan entri unik dalam riwayat penyebaran, berikan nama yang unik pada setiap penyebaran.

Untuk membuat nama unik, Anda dapat menetapkan angka acak:

deploymentName='ExampleDeployment'$RANDOM

Atau, tambahkan nilai tanggal:

deploymentName='ExampleDeployment'$(date +"%d-%b-%Y")

Jika Anda menjalankan penyebaran bersamaan ke grup sumber daya yang sama dengan nama penyebaran yang sama, hanya penyebaran terakhir yang diselesaikan. Setiap penyebaran dengan nama yang sama yang belum selesai akan digantikan oleh penyebaran terakhir. Misalnya, jika Anda menjalankan penyebaran bernama newStorage yang menyebarkan akun penyimpanan bernama storage1 dan menjalankan penyebaran lain bernama newStorage yang menyebarkan akun penyimpanan bernama storage2 secara bersamaan, Anda hanya menyebarkan satu akun penyimpanan. Akun penyimpanan yang dihasilkan diberi nama storage2.

Namun, jika Anda menjalankan penyebaran bernama newStorage yang menyebarkan akun penyimpanan bernama storage1 dan segera menjalankan penyebaran lain bernama newStorage yang menyebarkan akun penyimpanan bernama storage2 setelah penyebaran pertama selesai, maka Anda memiliki dua akun penyimpanan. Satu bernama storage1, dan yang lain bernama storage2. Tetapi, Anda hanya memiliki satu entri dalam riwayat penyebaran.

Saat menentukan nama unik untuk setiap penyebaran, Anda dapat menjalankannya secara bersamaan tanpa konflik. Jika Anda menjalankan penyebaran bernama newStorage1 yang menyebarkan akun penyimpanan bernama storage1 dan menjalankan penyebaran lain bernama newStorage2 yang menyebarkan akun penyimpanan bernama storage2 pada saat yang sama, maka Anda memiliki dua akun penyimpanan dan dua entri dalam riwayat penyebaran.

Untuk menghindari konflik dengan penyebaran bersamaan dan untuk memastikan entri unik dalam riwayat penyebaran, berikan nama unik pada setiap penyebaran nama.

Langkah berikutnya

Untuk memahami cara menentukan parameter dalam file Anda, lihat Memahami struktur dan sintaksis file Bicep.

Bagikan melalui