Bagikan melalui

Tutorial: Menambahkan parameter ke templat ARM Anda

Dalam tutorial sebelumnya, Anda mempelajari cara menambahkan akun penyimpanan Azure ke templat dan menyebarkannya. Dalam tutorial ini, Anda mempelajari cara meningkatkan templat Azure Resource Manager (templat ARM) dengan menambahkan parameter. Instruksi ini membutuhkan waktu 14 menit untuk diselesaikan.

Prasyarat

Kami menyarankan agar Anda menyelesaikan tutorial tentang sumber daya, tetapi tidak diperlukan.

Anda harus memiliki Visual Studio Code, dan Azure PowerShell atau Azure CLI. Untuk informasi selengkapnya, lihat alat templat.

Meninjau templat

Di akhir tutorial sebelumnya, templat Anda memiliki file JSON berikut:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2025-06-01",
      "name": "{provide-unique-name}",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

Anda mungkin melihat bahwa ada masalah dengan templat ini. Nama akun penyimpanan dikodekan secara permanen. Anda hanya dapat menggunakan templat ini untuk menyebarkan akun penyimpanan yang sama setiap kali. Untuk menyebarkan akun penyimpanan dengan nama yang berbeda, Anda perlu membuat templat baru, yang jelas bukan cara praktis untuk mengotomatiskan penyebaran Anda.

Membuat templat dapat digunakan kembali

Untuk membuat templat Anda dapat digunakan kembali, mari kita tambahkan parameter yang dapat Anda gunakan untuk meneruskan nama akun penyimpanan. File JSON dalam contoh berikut menunjukkan perubahan dalam templat Anda. Parameter storageName diidentifikasi sebagai string. Nama akun penyimpanan semuanya huruf kecil atau angka dan memiliki batas 24 karakter.

Salin seluruh file, dan ganti templat Anda dengan kontennya:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageName": {
      "type": "string",
      "minLength": 3,
      "maxLength": 24
    }
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2025-06-01",
      "name": "[parameters('storageName')]",
      "location": "eastus",
      "sku": {
        "name": "Standard_LRS"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

Menyebarkan templat

Mari kita terapkan template. Contoh berikut menyebarkan templat dengan Azure CLI atau Azure PowerShell. Perhatikan bahwa Anda memberikan nama akun penyimpanan sebagai salah satu nilai dalam perintah penyebaran. Untuk nama akun penyimpanan, berikan nama yang sama dengan yang Anda gunakan di tutorial sebelumnya.

Jika Anda belum membuat grup sumber daya, lihat Membuat grup sumber daya. Contoh mengasumsikan Anda mengatur templateFile variabel ke jalur file templat, seperti yang ditunjukkan dalam tutorial pertama.

New-AzResourceGroupDeployment `
  -Name addnameparameter `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile `
  -storageName "{your-unique-name}"

Memahami pembaruan sumber daya

Setelah Anda menyebarkan akun penyimpanan dengan nama yang sama dengan yang Anda gunakan sebelumnya, Anda mungkin bertanya-tanya bagaimana penyebaran ulang memengaruhi sumber daya.

Jika sumber daya sudah ada, dan tidak ada perubahan pada properti, tidak perlu tindakan lebih lanjut. Jika sumber daya ada dan properti berubah, sumber daya akan diperbarui. Jika sumber daya tidak ada, sumber daya akan dibuat.

Cara menangani pembaruan ini berarti templat Anda dapat menyertakan semua sumber daya yang Anda butuhkan untuk solusi Azure. Anda dapat menyebarkan ulang templat dengan aman dan mengetahui bahwa sumber daya berubah atau dibuat hanya jika diperlukan. Jika Anda menambahkan file ke akun penyimpanan, misalnya, Anda dapat menyebarkan ulang akun penyimpanan tanpa kehilangan file.

Sesuaikan menurut lingkungan

Parameter memungkinkan Anda menyesuaikan penyebaran dengan menyediakan nilai yang disesuaikan untuk lingkungan tertentu. Anda dapat meneruskan nilai yang berbeda, misalnya, berdasarkan apakah Anda menyebarkan ke lingkungan pengembangan, pengujian, atau produksi.

Templat sebelumnya selalu menyebarkan akun Standard_LRS penyimpanan redundan lokal standar (LRS). Anda mungkin ingin fleksibilitas untuk menyebarkan unit penyimpanan stok (SKU) yang berbeda tergantung pada lingkungan. Contoh berikut menunjukkan perubahan untuk menambahkan parameter untuk SKU. Salin seluruh file, dan tempelkan ke templat Anda:

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "storageName": {
      "type": "string",
      "minLength": 3,
      "maxLength": 24
    },
    "storageSKU": {
      "type": "string",
      "defaultValue": "Standard_LRS",
      "allowedValues": [
        "Standard_LRS",
        "Standard_GRS",
        "Standard_RAGRS",
        "Standard_ZRS",
        "Premium_LRS",
        "Premium_ZRS",
        "Standard_GZRS",
        "Standard_RAGZRS"
      ]
    }
  },
  "resources": [
    {
      "type": "Microsoft.Storage/storageAccounts",
      "apiVersion": "2025-06-01",
      "name": "[parameters('storageName')]",
      "location": "eastus",
      "sku": {
        "name": "[parameters('storageSKU')]"
      },
      "kind": "StorageV2",
      "properties": {
        "supportsHttpsTrafficOnly": true
      }
    }
  ]
}

Parameter storageSKU memiliki nilai default. Gunakan nilai ini jika penerapan tidak menentukannya. Ini juga memiliki daftar nilai yang diizinkan. Nilai-nilai ini cocok dengan nilai yang diperlukan untuk membuat akun penyimpanan. Anda ingin pengguna templat Anda meneruskan SKU yang berfungsi.

Menyebarkan ulang templat

Anda siap untuk mengimplementasikan lagi. Karena SKU default diatur ke Standard_LRS, Anda telah memberikan nilai parameter.

New-AzResourceGroupDeployment `
  -Name addskuparameter `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile `
  -storageName "{your-unique-name}"

Nota

Jika penyebaran gagal, gunakan sakelar verbose untuk mendapatkan informasi tentang sumber daya yang dibuat. Gunakan saklar debug untuk mendapatkan informasi selengkapnya untuk pemecahan masalah.

Untuk melihat fleksibilitas templat Anda, terapkan lagi. Kali ini atur parameter SKU ke penyimpanan geo-redundan standar (GRS) Standard_GRS. Anda dapat meneruskan nama baru untuk membuat akun penyimpanan yang berbeda atau menggunakan nama yang sama untuk memperbarui akun penyimpanan yang ada. Kedua opsi berfungsi.

New-AzResourceGroupDeployment `
  -Name usenondefaultsku `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile `
  -storageName "{your-unique-name}" `
  -storageSKU Standard_GRS

Sekarang, kita jalankan pengujian sekali lagi dan lihat apa yang terjadi ketika Anda memasukkan SKU yang bukan nilai yang terdaftar. Dalam hal ini, kami menguji skenario di mana pengguna templat Anda berpikir dasar adalah salah satu SKU.

New-AzResourceGroupDeployment `
  -Name testskuparameter `
  -ResourceGroupName myResourceGroup `
  -TemplateFile $templateFile `
  -storageName "{your-unique-name}" `
  -storageSKU basic

Perintah gagal langsung dengan pesan kesalahan yang menunjukkan nilai-nilai yang diizinkan. Prosesor ARM menemukan kesalahan sebelum penyebaran dimulai.

Membersihkan sumber daya

Jika Anda melanjutkan ke tutorial berikutnya, Anda tidak perlu menghapus grup sumber daya.

Jika berhenti sekarang, Anda mungkin ingin membersihkan sumber daya yang disebarkan dengan menghapus grup sumber daya.

  1. Dari portal Microsoft Azure, pilih Grup sumber daya dari menu sebelah kiri.
  2. Ketik nama grup sumber daya di bidang teks Filter untuk bidang mana pun ....
  3. Centang kotak di samping myResourceGroup dan pilih myResourceGroup atau nama grup sumber daya Anda.
  4. Pilih Hapus grup sumber daya dari menu atas.

Langkah selanjutnya

Anda meningkatkan templat yang Anda buat di tutorial pertama dengan menambahkan parameter. Dalam tutorial berikutnya, Anda mempelajari tentang fungsi templat.

Menambahkan fungsi templat

  • Last updated on