Mulai cepat: Membuat dan menyebarkan spesifikasi template dengan Bicep

Artikel
06/23/2023

Mulai cepat ini menjelaskan cara membuat dan menyebarkan spesifikasi template dengan file Bicep. Spesifikasi template disebarkan ke grup sumber daya sehingga orang-orang di organisasi Anda dapat menyebarkan sumber daya di Microsoft Azure. Spesifikasi template memungkinkan Anda berbagi template penyebaran tanpa perlu memberi pengguna akses untuk mengubah file Bicep. Contoh spesifikasi template ini menggunakan file Bicep untuk menyebarkan akun penyimpanan.

Saat Anda membuat spesifikasi template, file Bicep diubah menjadi JavaScript Object Notation (JSON). Spesifikasi template menggunakan JSON untuk menyebarkan sumber daya Azure. Saat ini, Anda tidak dapat menggunakan portal Microsoft Azure untuk mengimpor file Bicep dan membuat sumber daya spesifikasi template.

Prasyarat

Akun Azure dengan langganan aktif. Buat akun secara gratis.
Azure PowerShell versi 6.3.0 atau lebih baru atau Azure CLI versi 2.27.0 atau lebih baru.
Visual Studio Code dengan ekstensi Bicep.

Membuat file Bicep

Anda membuat spesifikasi template dari file Bicep lokal. Salin contoh berikut dan simpan ke komputer Anda sebagai main.bicep. Contoh menggunakan jalur C:\templates\main.bicep. Anda dapat menggunakan jalur yang berbeda, tetapi Anda harus mengubah perintahnya.

File Bicep berikut digunakan di tab PowerShell dan CLI. Tab File Bicep menggunakan template berbeda yang menggabungkan Bicep dan JSON untuk membuat dan menyebarkan spesifikasi template.

@allowed([
  'Premium_LRS'
  'Premium_ZRS'
  'Standard_GRS'
  'Standard_GZRS'
  'Standard_LRS'
  'Standard_RAGRS'
  'Standard_RAGZRS'
  'Standard_ZRS'
])
@description('Storage account type.')
param storageAccountType string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

var storageAccountName = 'storage${uniqueString(resourceGroup().id)}'

resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Membuat spesifikasi templat

Spesifikasi template adalah jenis sumber daya bernama Microsoft.Resources/templateSpecs. Untuk membuat spesifikasi template, gunakan Azure CLI, Azure PowerShell, atau file Bicep.

Contoh ini menggunakan nama grup sumber daya templateSpecRG. Anda dapat menggunakan nama yang berbeda, tetapi Anda harus mengubah perintahnya.

Buat grup sumber daya baru untuk memuat spesifikasi templat.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

Buat spesifikasi templat dalam grup sumber daya tersebut. Beri spesifikasi template baru nama storageSpec.

New-AzTemplateSpec `
  -Name storageSpec `
  -Version "1.0" `
  -ResourceGroupName templateSpecRG `
  -Location westus2 `
  -TemplateFile "C:\templates\main.bicep"

Buat grup sumber daya baru untuk memuat spesifikasi templat.

az group create \
  --name templateSpecRG \
  --location westus2

Buat spesifikasi templat dalam grup sumber daya tersebut. Beri spesifikasi template baru nama storageSpec.

az ts create \
  --name storageSpec \
  --version "1.0" \
  --resource-group templateSpecRG \
  --location westus2 \
  --template-file "C:\templates\main.bicep"

Anda dapat membuat spesifikasi template dengan file Bicep tetapi mainTemplate harus dalam JSON. Template JSON tidak menggunakan sintaks JSON standar. Misalnya, tidak ada koma akhir baris, tanda kutip ganda diganti dengan tanda kutip tunggal, dan garis miring terbalik (\) digunakan untuk menghindari tanda kutip tunggal dalam ekspresi.

Salin template berikut dan simpan ke komputer Anda sebagai main.bicep.

param templateSpecName string = 'storageSpec'

param templateSpecVersionName string = '1.0'

@description('Location for all resources.')
param location string = resourceGroup().location

resource createTemplateSpec 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: templateSpecName
  location: location
}

resource createTemplateSpecVersion 'Microsoft.Resources/templateSpecs/versions@2022-02-01' = {
  parent: createTemplateSpec
  name: templateSpecVersionName
  location: location
  properties: {
    mainTemplate: {
      '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
      'contentVersion': '1.0.0.0'
      'metadata': {}
      'parameters': {
        'storageAccountType': {
          'type': 'string'
          'defaultValue': 'Standard_LRS'
          'metadata': {
            'description': 'Storage account type.'
          }
          'allowedValues': [
            'Premium_LRS'
            'Premium_ZRS'
            'Standard_GRS'
            'Standard_GZRS'
            'Standard_LRS'
            'Standard_RAGRS'
            'Standard_RAGZRS'
            'Standard_ZRS'
          ]
        }
        'location': {
          'type': 'string'
          'defaultValue': '[resourceGroup().location]'
          'metadata': {
            'description': 'Location for all resources.'
          }
        }
      }
      'variables': {
        'storageAccountName': '[format(\'{0}{1}\', \'storage\', uniqueString(resourceGroup().id))]'
      }
      'resources': [
        {
          'type': 'Microsoft.Storage/storageAccounts'
          'apiVersion': '2022-09-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Gunakan Azure PowerShell atau Azure CLI untuk membuat grup sumber daya baru.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

az group create \
  --name templateSpecRG \
  --location westus2

Buat spesifikasi templat dalam grup sumber daya tersebut. Nama spesifikasi template storageSpec dan nomor versi 1.0 adalah parameter dalam file Bicep.

New-AzResourceGroupDeployment `
  -ResourceGroupName templateSpecRG `
  -TemplateFile "C:\templates\main.bicep"

az deployment group create \
  --resource-group templateSpecRG \
  --template-file "C:\templates\main.bicep"

Menyebarkan spesifikasi templat

Gunakan spesifikasi template untuk menyebarkan akun penyimpanan. Contoh ini menggunakan nama grup sumber daya storageRG. Anda dapat menggunakan nama yang berbeda, tetapi Anda harus mengubah perintahnya.

Buat grup sumber daya untuk memuat akun penyimpanan baru.

New-AzResourceGroup `
  -Name storageRG `
  -Location westus2

Dapatkan ID sumber daya spesifikasi templat.

$id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "1.0").Versions.Id

Terapkan spesifikasi templat.

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG

Anda memberikan parameter persis seperti yang Anda lakukan untuk penyebaran file Bicep. Terapkan ulang spesifikasi template dengan parameter untuk jenis akun penyimpanan.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageAccountType Standard_GRS
```

Buat grup sumber daya untuk memuat akun penyimpanan baru.

az group create \
  --name storageRG \
  --location westus2

Dapatkan ID sumber daya spesifikasi templat.
```
id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")
```
Catatan

Terdapat masalah dalam mendapatkan ID spesifikasi template dan menetapkannya ke variabel di Windows PowerShell.

Terapkan spesifikasi templat.

az deployment group create \
  --resource-group storageRG \
  --template-spec $id

Anda memberikan parameter persis seperti yang Anda lakukan untuk penyebaran file Bicep. Terapkan ulang spesifikasi template dengan parameter untuk jenis akun penyimpanan.
```
az deployment group create \
  --resource-group storageRG \
  --template-spec $id \
  --parameters storageAccountType="Standard_GRS"
```

Untuk menyebarkan spesifikasi template menggunakan file Bicep, gunakan modul. Modul tertaut ke spesifikasi template yang ada. Untuk informasi selengkapnya, lihat file dalam spesifikasi template.

Salin modul Bicep berikut dan simpan ke komputer Anda sebagai storage.bicep.

module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
}

Ganti <subscriptionId> di modul. Gunakan Azure PowerShell atau Azure CLI untuk mendapatkan ID langganan Anda.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Gunakan Azure PowerShell atau Azure CLI untuk membuat grup sumber daya baru untuk akun penyimpanan.

New-AzResourceGroup `
  -Name storageRG `
  -Location westus2

az group create \
  --name storageRG \
  --location westus2

Sebarkan spesifikasi template dengan Azure PowerShell atau Azure CLI.

New-AzResourceGroupDeployment `
  -ResourceGroupName storageRG `
  -TemplateFile "C:\templates\storage.bicep"

az deployment group create \
  --resource-group storageRG \
  --template-file "C:\templates\storage.bicep"

Anda dapat menambahkan parameter dan menyebarkan ulang spesifikasi template dengan jenis akun penyimpanan yang berbeda. Salin sampel dan ganti file storage.bicep Anda. Kemudian, sebarkan ulang penyebaran spesifikasi template.
```
module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
  params: {
    storageAccountType: 'Standard_GRS'
  }
}
```

Memberikan akses

Jika Anda ingin mengizinkan pengguna lain di organisasi Anda menerapkan spesifikasi templat Anda, Anda harus memberi mereka akses baca. Anda dapat menetapkan peran Pembaca ke grup Microsoft Entra untuk grup sumber daya yang berisi spesifikasi templat yang ingin Anda bagikan. Untuk informasi selengkapnya, lihat Tutorial: Memberi akses grup ke sumber daya Azure menggunakan Azure PowerShell.

Memperbarui file Bicep

Setelah spesifikasi template dibuat, Anda memutuskan untuk memperbarui file Bicep. Untuk melanjutkan contoh di tab PowerShell atau CLI, salin contoh dan ganti file main.bicep Anda.

Parameter storageNamePrefix menentukan nilai prefiks untuk nama akun penyimpanan. Variabel storageAccountName menggabungkan prefiks dengan string unik.

@allowed([
  'Premium_LRS'
  'Premium_ZRS'
  'Standard_GRS'
  'Standard_GZRS'
  'Standard_LRS'
  'Standard_RAGRS'
  'Standard_RAGZRS'
  'Standard_ZRS'
])
@description('Storage account type.')
param storageAccountType string = 'Standard_LRS'

@description('Location for all resources.')
param location string = resourceGroup().location

@maxLength(11)
@description('The storage account name prefix.')
param storageNamePrefix string = 'storage'

var storageAccountName = '${toLower(storageNamePrefix)}${uniqueString(resourceGroup().id)}'

resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Memperbarui versi spesifikasi templat

Daripada membuat spesifikasi template baru untuk template yang direvisi, tambahkan versi baru bernama 2.0 ke spesifikasi template yang ada. Pengguna dapat memilih untuk menyebarkan salah satu versi.

Buat versi baru dari spesifikasi template.

New-AzTemplateSpec `
  -Name storageSpec `
  -Version "2.0" `
  -ResourceGroupName templateSpecRG `
  -Location westus2 `
  -TemplateFile "C:\templates\main.bicep"

Untuk menerapkan versi baru, dapatkan ID sumber daya untuk versi 2.0 tersebut.

$id = (Get-AzTemplateSpec -ResourceGroupName templateSpecRG -Name storageSpec -Version "2.0").Versions.Id

Sebarkan versi baru dan gunakan storageNamePrefix guna menentukan prefiks untuk nama akun penyimpanan.

New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageNamePrefix "demo"

Buat versi baru dari spesifikasi template.

az ts create \
  --name storageSpec \
  --version "2.0" \
  --resource-group templateSpecRG \
  --location westus2 \
  --template-file "C:\templates\main.bicep"

Untuk menerapkan versi baru, dapatkan ID sumber daya untuk versi 2.0 tersebut.

id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "2.0" --query "id")

Sebarkan versi baru dan gunakan storageNamePrefix guna menentukan prefiks untuk nama akun penyimpanan.

az deployment group create \
   --resource-group storageRG \
   --template-spec $id \
   --parameters storageNamePrefix="demo"

Buat versi baru dari spesifikasi template. Salin contoh dan ganti file main.bicep Anda.

Parameter storageNamePrefix menentukan nilai prefiks untuk nama akun penyimpanan. Variabel storageAccountName menggabungkan prefiks dengan string unik.

param templateSpecName string = 'storageSpec'

param templateSpecVersionName string = '2.0'

@description('Location for all resources.')
param location string = resourceGroup().location

resource createTemplateSpec 'Microsoft.Resources/templateSpecs@2022-02-01' = {
  name: templateSpecName
  location: location
}

resource createTemplateSpecVersion 'Microsoft.Resources/templateSpecs/versions@2022-02-01' = {
  parent: createTemplateSpec
  name: templateSpecVersionName
  location: location
  properties: {
    mainTemplate: {
      '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
      'contentVersion': '1.0.0.0'
      'metadata': {}
      'parameters': {
        'storageAccountType': {
          'type': 'string'
          'defaultValue': 'Standard_LRS'
          'metadata': {
            'description': 'Storage account type.'
          }
          'allowedValues': [
            'Premium_LRS'
            'Premium_ZRS'
            'Standard_GRS'
            'Standard_GZRS'
            'Standard_LRS'
            'Standard_RAGRS'
            'Standard_RAGZRS'
            'Standard_ZRS'
          ]
        }
        'location': {
          'type': 'string'
          'defaultValue': '[resourceGroup().location]'
          'metadata': {
            'description': 'Location for all resources.'
          }
        }
        'storageNamePrefix': {
          'type': 'string'
          'defaultValue': 'storage'
          'metadata': {
            'description': 'The storage account name prefix.'
          }
          'maxLength': 11
        }
      }
      'variables': {
        'storageAccountName': '[format(\'{0}{1}\', toLower(parameters(\'storageNamePrefix\')), uniqueString(resourceGroup().id))]'
      }
      'resources': [
        {
          'type': 'Microsoft.Storage/storageAccounts'
          'apiVersion': '2022-09-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Untuk menambahkan versi baru ke spesifikasi template Anda, sebarkan template Anda dengan Azure PowerShell atau Azure CLI.

New-AzResourceGroupDeployment `
  -ResourceGroupName templateSpecRG `
  -TemplateFile "C:\templates\main.bicep"

az deployment group create \
  --resource-group templateSpecRG \
  --template-file "C:\templates\main.bicep"

Salin modul Bicep berikut dan simpan ke komputer Anda sebagai storage.bicep.

module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:2.0' = {
  name: 'deployVersion2'
  params: {
    storageNamePrefix: 'demo'
  }
}

Ganti <subscriptionId> di modul. Gunakan Azure PowerShell atau Azure CLI untuk mendapatkan ID langganan Anda.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Sebarkan spesifikasi template dengan Azure PowerShell atau Azure CLI.

New-AzResourceGroupDeployment `
  -ResourceGroupName storageRG `
  -TemplateFile "C:\templates\storage.bicep"

az deployment group create \
  --resource-group storageRG \
  --template-file "C:\templates\storage.bicep"

Membersihkan sumber daya

Untuk membersihkan sumber daya yang Anda sebarkan dalam mulai cepat ini, hapus kedua grup sumber daya. Grup sumber daya, spesifikasi template, dan akun penyimpanan akan dihapus.

Gunakan Azure PowerShell atau Azure CLI untuk menghapus grup sumber daya.

Remove-AzResourceGroup -Name "templateSpecRG"

Remove-AzResourceGroup -Name "storageRG"

az group delete --name templateSpecRG

az group delete --name storageRG

Langkah berikutnya

Spesifikasi templat Azure Resource Manager di Bicep