Mulai Cepat: Membuat templat ARM dengan Visual Studio Code

Azure Resource Manager Tools for Visual Studio Code menyediakan dukungan bahasa, cuplikan sumber daya, dan melengkapi sumber daya secara otomatis. Alat-alat ini membantu membuat dan memvalidasi templat Azure Resource Manager (templat ARM). Dalam mulai cepat ini, Anda menggunakan ekstensi untuk membuat templat ARM dari awal. Saat melakukannya, Anda mengalami kemampuan ekstensi seperti cuplikan templat ARM, validasi, penyelesaian, dan dukungan file parameter.

Untuk menyelesaikan mulai cepat ini, Anda memerlukan Visual Studio Code dengan ekstensi alat Azure Resource Manager yang terpasang. Anda juga memerlukan Azure CLI atau modul Azure PowerShell yang dipasang dan diautentikasi.

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

Tip

Kami merekomendasikan Bicep karena menawarkan kemampuan yang sama dengan templat ARM dan sintaksnya lebih mudah digunakan. Untuk mempelajari selengkapnya, lihat Mulai Cepat: Membuat file Bicep dengan Visual Studio Code.

Membuat templat ARM

Buat dan buka file baru bernama azuredeploy.json dengan Visual Studio Code. Masukkan arm ke editor kode, yang memulai cuplikan Azure Resource Manager untuk merancah templat ARM.

Pilih arm! untuk membuat templat yang dicakup untuk penyebaran grup sumber daya Azure.

Image showing Azure Resource Manager scaffolding snippets

Cuplikan ini membuat blok penyusun dasar untuk templat ARM.

Image showing a fully scaffolded ARM template

Perhatikan bahwa mode bahasa Visual Studio Code telah berubah dari JSON ke Templat Azure Resource Manager. Ekstensi ini mencakup server bahasa khusus untuk templat ARM yang menyediakan validasi, penyelesaian, dan layanan bahasa khusus templat ARM.

Image showing Azure Resource Manager as the Visual Studio Code language mode

Menambahkan sumber daya Azure

Ekstensi ini mencakup cuplikan untuk banyak sumber daya Azure. Cuplikan ini dapat digunakan untuk dengan mudah menambahkan sumber daya ke penyebaran templat Anda.

Letakkan kursor di blok sumber daya, ketik storage, dan pilih cuplikan penyimpanan lengan.

Image showing a resource being added to the ARM template

Tindakan ini menambahkan sumber daya penyimpanan ke templat.

Image showing an Azure Storage resource in an ARM template

Tombol tab dapat digunakan untuk tab melalui properti yang dapat dikonfigurasi pada akun penyimpanan.

Image showing how the tab key can be used to navigate through resource configuration

Penyelesaian dan validasi

Salah satu kemampuan ekstensi yang paling canggih adalah integrasinya dengan skema Azure. Skema Azure memberikan ekstensi dengan kemampuan validasi dan penyelesaian yang mengetahui sumber daya. Mari kita ubah akun penyimpanan untuk melihat cara kerja validasi dan penyelesaian.

Pertama, perbarui jenis akun penyimpanan ke nilai yang tidak valid seperti megaStorage. Perhatikan bahwa tindakan ini menghasilkan peringatan yang menunjukkan bahwa megaStorage bukan nilai yang valid.

Image showing an invalid storage configuration

Untuk menggunakan kemampuan penyelesaian, hapus megaStorage, letakkan kursor di dalam tanda kutip ganda, lalu tekan ctrl + space. Tindakan ini menampilkan daftar penyelesaian nilai yang valid.

Image showing extension auto-completion

Tambahkan parameter templat

Sekarang, buat dan gunakan parameter untuk menentukan nama akun penyimpanan.

Letakkan kursor Anda di blok parameter, tambahkan pengembalian pengangkutan, ketik ", lalu pilih cuplikan new-parameter. Tindakan ini menambahkan parameter generik ke templat.

Image showing a parameter being added to the ARM template

Perbarui nama parameter ke storageAccountName dan deskripsi ke Storage Account Name.

Image showing the completed parameter in an ARM template

Nama akun penyimpanan Azure memiliki panjang minimum 3 karakter dan maksimum 24 karakter. Tambahkan minLength dan maxLength ke parameter dan berikan nilai yang sesuai.

Image showing minLength and maxLength being added to an ARM template parameter

Sekarang, pada sumber daya penyimpanan, perbarui properti nama untuk menggunakan parameter. Untuk melakukannya, hapus nama saat ini. Masukkan tanda kutip ganda dan kurung siku pembuka [, yang menghasilkan daftar fungsi templat ARM. Pilih parameter dari daftar.

Image showing auto-completion when using parameters in ARM template resources

Memasukkan satu kutipan ' di dalam braket bulat menghasilkan daftar semua parameter yang ditentukan dalam templat, dalam hal ini, storageAccountName. Pilih parameter.

Image showing completed parameter in an ARM template resource

Membuat file parameter

File parameter template ARM memungkinkan Anda untuk menyimpan nilai parameter lingkungan tertentu dan meneruskan nilai-nilai ini sebagai grup pada waktu penyebaran. Misalnya, Anda mungkin memiliki file parameter dengan nilai khusus untuk lingkungan pengujian dan lainnya untuk lingkungan produksi.

Ekstensi ini memudahkan untuk membuat file parameter dari templat yang ada. Untuk melakukannya, klik kanan pada templat di editor kode dan pilih Select/Create Parameter File.

Image showing the right-click process for creating a parameter file from an ARM template

Pilih New>All Parameters> Pilih nama dan lokasi untuk file parameter.

Image showing the name and save file dialog when creating a parameters file from an ARM template

Tindakan ini membuat file parameter baru dan memetakannya dengan template tempat ia dibuat. Anda dapat melihat dan mengubah pemetaan file templat/parameter saat ini di bilah status Visual Studio Code saat templat dipilih.

Image showing the template/parameter file mapping in the Visual Studio Code status bar.

Sekarang file parameter telah dipetakan ke templat, ekstensi memvalidasi file templat dan parameter bersama-sama. Untuk melihat validasi ini dalam praktiknya, tambahkan nilai dua karakter ke parameter storageAccountName dalam file parameter dan simpan file.

Image showing an invalidated template due to parameter file issue

Navigasi kembali ke templat ARM dan perhatikan bahwa kesalahan telah diangkat yang menunjukkan bahwa nilai tidak memenuhi kriteria parameter.

Image showing a valid ARM template

Perbarui nilai ke sesuatu yang sesuai, simpan file, dan navigasi kembali ke templat. Perhatikan bahwa kesalahan pada parameter telah diselesaikan.

Menyebarkan templat

Buka terminal Visual Studio Code terintegrasi menggunakan kombinasi tombol ctrl + ` dan gunakan modul CLI Azure atau Azure PowerShell untuk menyebarkan templat.

az group create --name arm-vscode --location eastus

az deployment group create --resource-group arm-vscode --template-file azuredeploy.json --parameters azuredeploy.parameters.json

Membersihkan sumber daya

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

az group delete --name arm-vscode

Langkah berikutnya