Panduan Cepat: Membuat file Bicep dengan Visual Studio Code

Panduan cepat ini memandu Anda dalam menggunakan Visual Studio Code untuk membuat file Bicep. Anda membuat akun penyimpanan dan jaringan virtual. Anda juga mempelajari bagaimana ekstensi Bicep menyediakan keamanan jenis, validasi sintaksis, dan pelengkapan otomatis untuk menyederhanakan pengembangan.

Visual Studio mendukung pengalaman penulisan serupa. Lihat Panduan Cepat: Buat file Bicep dengan Visual Studio untuk informasi selengkapnya.

Prasyarat

Jika Anda tidak memiliki langganan Azure, buat akun gratis sebelum Anda mulai.

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 versi Azure CLI terbaru atau modul Azure PowerShell.

Menambahkan cuplikan sumber daya

Visual Studio Code dengan ekstensi Bicep menyediakan cuplikan yang telah ditentukan sebelumnya untuk menyederhanakan pengembangan. Dalam panduan singkat ini, Anda menambahkan cuplikan yang membuat jaringan virtual.

Luncurkan Visual Studio Code, dan buat file baru bernama main.bicep. Di main.bicep, ketik vnet, pilih res-vnet dari daftar, lalu tekan TAB atau ENTER.

Kiat

Jika Anda tidak melihat opsi IntelliSense tersebut di Visual Studio Code, pastikan Anda telah menginstal ekstensi Bicep seperti yang ditentukan dalam Prasyarat. Jika Anda telah menginstal ekstensi, beri layanan bahasa Bicep sedikit waktu untuk memulai setelah Anda membuka file Bicep. Biasanya dimulai dengan cepat, dan Anda tidak akan memiliki opsi IntelliSense sampai prosesnya dimulai. Pemberitahuan di sudut kanan bawah menunjukkan bahwa layanan dimulai. Ketika pemberitahuan itu menghilang, layanan sedang berjalan.

File Bicep Anda kini berisi kode berikut:

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2025-01-01' = {
  name: 'name'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

Dalam cuplikan ini, Anda menemukan semua nilai yang diperlukan untuk menentukan jaringan virtual. Anda mungkin melihat dua garis bawah bergelombang. Yang kuning menunjukkan peringatan yang terkait dengan versi API yang kedaluwarsa, sementara garis bawah keriting merah menandakan kesalahan yang disebabkan oleh definisi parameter yang hilang. Linter Bicep memeriksa file Bicep untuk kesalahan tata bahasa dan pelanggaran atas praktik terbaik. Arahkan kursor Anda ke atas @2019-11-01, dan panel popup memperlihatkan Gunakan versi API yang lebih baru untuk 'Microsoft.Network/virtualNetworks'. Pilih Perbaikan cepat dari panel popup, lalu pilih Ganti dengan 2024-05-01 untuk memperbarui versi API.

Atau, hapus @2019-11-01, dan ganti dengan @. Pilih versi API terbaru.

Anda akan memperbaiki kesalahan definisi parameter yang hilang di bagian berikutnya.

Anda juga dapat memodifikasi kode ini untuk memenuhi kebutuhan Anda. Misalnya, karena name bukan nama yang jelas untuk jaringan virtual, Anda dapat mengubah properti menjadi nameexampleVnet:

name: 'exampleVNet'

Tambah parameter

Cuplikan kode yang Anda tambahkan di bagian terakhir melewatkan definisi parameter, location, seperti yang ditunjukkan oleh garis bawah keriting merah. Di bagian atas file, tambahkan:

param location

Saat Anda menambahkan spasi setelah lokasi, perhatikan bahwa IntelliSense menawarkan jenis data yang tersedia untuk parameter . Pilih string.

Beri parameter nilai default:

param location string = resourceGroup().location

Baris sebelumnya menetapkan lokasi grup sumber daya ke sumber daya jaringan virtual. Untuk informasi selengkapnya tentang fungsi yang digunakan dalam nilai default, lihat resourceGroup().

Di bagian atas file, tambahkan parameter lain untuk nama akun penyimpanan (yang Anda buat nanti di mulai cepat) dengan nilai default:

param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

Untuk informasi selengkapnya, lihat Interpolasi dan uniqueString().

Parameter ini berfungsi dengan baik, tetapi akun penyimpanan memiliki batasan pada panjang nama. Nama harus memiliki setidaknya 3 dan tidak lebih dari 24 karakter. Anda dapat menentukan persyaratan ini dengan menambahkan dekorator ke parameter .

Tambahkan baris di atas parameter, dan ketik @. Anda akan melihat dekorator yang tersedia. Perhatikan bahwa ada dekorator untuk minLength dan maxLength.

Tambahkan kedua dekorator, dan tentukan batas karakter (misalnya, 3 dan 24 di bawah):

@minLength(3)
@maxLength(24)
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

Anda juga dapat menambahkan deskripsi untuk parameter. Sertakan informasi yang membantu orang menyebarkan file Bicep untuk memahami nilai mana yang akan disediakan:

@minLength(3)
@maxLength(24)
@description('Provide a name for the storage account. Use only lowercase letters and numbers. The name must be unique across Azure.')
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

Parameter Anda siap digunakan.

Tambahkan sumber daya

Alih-alih menggunakan cuplikan untuk menentukan akun penyimpanan, Anda menggunakan IntelliSense untuk mengatur nilai. IntelliSense membuat langkah ini lebih mudah daripada harus mengetik nilai secara manual.

Untuk menentukan sumber daya, gunakan kata kunci resource. Di bawah jaringan virtual Anda, ketik akun penyimpanan sumber daya:

resource storageAccount

storageAccount adalah nama simbolis untuk sumber daya yang Anda sebarkan. Anda dapat menggunakan nama ini untuk mereferensikan sumber daya pada bagian lain dari file Bicep Anda.

Ketika Anda menambahkan spasi setelah nama simbolis, daftar jenis sumber daya ditampilkan. Lanjutkan mengetik storageacc hingga Anda dapat memilihnya dari opsi yang tersedia.

Setelah memilih Microsoft.Storage/storageAccounts, Anda disajikan dengan versi API yang tersedia. Pilih versi terbaru. Untuk cuplikan layar berikut, ini adalah 2023-05-01.

Setelah kutipan tunggal untuk jenis sumber daya, tambahkan = dan spasi. Anda disajikan dengan opsi untuk menambahkan properti ke sumber daya. Pilih required-properties.

Opsi ini menambahkan semua properti untuk jenis sumber daya yang diperlukan untuk penyebaran. Setelah memilih opsi ini, akun penyimpanan Anda memiliki properti berikut:

resource storageAccount 'Microsoft.Storage/storageAccounts@2025-06-01' = {
  name:
  location:
  sku: {
    name:
  }
  kind:
}

Anda hampir selesai, dan langkah selanjutnya adalah memberikan nilai untuk properti tersebut.

Sekali lagi, IntelliSense membantu Anda. Atur name ke storageAccountName yang merupakan parameter yang berisi nama akun penyimpanan. Untuk location, atur ke location, yang merupakan parameter yang Anda buat sebelumnya. Saat menambahkan sku.name dan kind, IntelliSense menyajikan opsi yang valid.

Untuk menambahkan properti opsional bersama properti yang diperlukan, tempatkan kursor di lokasi yang diinginkan, dan tekan Ctrl+. Cuplikan layar berikut menunjukkan cara IntelliSense menyarankan properti yang tersedia:

Setelah selesai, Anda memiliki:

@minLength(3)
@maxLength(24)
@description('Provide a name for the storage account. Use only lowercase letters and numbers. The name must be unique across Azure.')
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'
param location string = resourceGroup().location

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2025-01-01' = {
  name: 'exampleVNet'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2025-06-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
}

Untuk informasi selengkapnya tentang sintaks Bicep, lihat Struktur dan sintaks file Bicep.

Memvisualisasikan sumber daya

Visualizer Bicep menunjukkan representasi grafis sumber daya dalam file Anda.

Pilih tombol Visualizer Bicep di sudut kanan atas untuk membuka alat:

Visualizer ini menunjukkan sumber daya yang ditentukan dalam file Bicep dan konektor di antara dependensinya. Dua sumber daya yang ditentukan dalam panduan cepat ini tidak memiliki hubungan saling bergantung, jadi tidak ada penghubung di antara mereka.

Menerapkan file Bicep

1. Klik kanan file Bicep di dalam Visual Studio Code, lalu pilih Sebarkan file Bicep.

   

2. Dalam kotak teks Silakan masukkan nama untuk penyebaran , ketik deployStorageAndVNet, lalu tekan ENTER.

   

3. Dari kotak daftar Pilih Grup Sumber Daya di bagian atas, pilih Buat Grup Sumber Daya baru.

4. Masukkan exampleRG sebagai nama grup sumber daya, lalu tekan ENTER.

5. Pilih lokasi untuk grup sumber daya, pilih US Tengah atau lokasi pilihan Anda, lalu tekan ENTER.

6. Di Pilih file parameter, pilih Tidak Ada.

Pembuatan sumber daya memerlukan waktu beberapa menit. Untuk informasi selengkapnya, lihat Menyebarkan file Bicep dengan Visual Studio Code.

Anda juga dapat menggunakan Azure CLI atau Azure PowerShell untuk menyebarkan file Bicep:

Azure CLI

az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters storageAccountName=uniquename

Azure PowerShell

New-AzResourceGroup -Name exampleRG -Location eastus

New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep -storageAccountName "uniquename"

Setelah penyebaran selesai, Anda akan melihat pesan yang menjelaskan bahwa penyebaran berhasil.

Membersihkan sumber daya

Saat sumber daya Azure tidak lagi diperlukan, gunakan modul Azure CLI atau Azure PowerShell untuk menghapus grup sumber daya quickstart.

Azure CLI

az group delete --name exampleRG

Azure PowerShell

Remove-AzResourceGroup -Name exampleRG

Langkah berikutnya

Membuat spesifikasi templat.