Quickstart: Een sjabloonspecificatie maken en implementeren met Bicep

Artikel
10/18/2023

In deze quickstart wordt beschreven hoe u een sjabloonspecificatie maakt en implementeert met een Bicep-bestand. Een sjabloonspecificatie wordt geïmplementeerd in een resourcegroep, zodat personen in uw organisatie resources kunnen implementeren in Microsoft Azure. Met sjabloonspecificaties kunt u implementatiesjablonen delen zonder gebruikers toegang te geven om het Bicep-bestand te wijzigen. In dit voorbeeld van een sjabloonspecificatie wordt een Bicep-bestand gebruikt om een opslagaccount te implementeren.

Wanneer u een sjabloonspecificatie maakt, wordt het Bicep-bestand getranspileerd in JavaScript Object Notation (JSON). In de sjabloonspecificatie wordt JSON gebruikt om Azure-resources te implementeren. Op dit moment kunt u microsoft Azure Portal niet gebruiken om een Bicep-bestand te importeren en een sjabloonspecificatieresource te maken.

Vereisten

Een Azure-account met een actief abonnement. Gratis een account maken
Azure PowerShell versie 6.3.0 of hoger of Azure CLI versie 2.27.0 of hoger.
Visual Studio Code met de Bicep-extensie.

Bicep-bestand maken

U maakt een sjabloonspecificatie op basis van een lokaal Bicep-bestand. Kopieer het volgende voorbeeld en sla het op uw computer op als main.bicep. In de voorbeelden wordt het pad C:\templates\main.bicep gebruikt. U kunt een ander pad gebruiken, maar u moet de opdrachten wijzigen.

Het volgende Bicep-bestand wordt gebruikt op de tabbladen PowerShell en CLI . Op het tabblad Bicep-bestand wordt een andere sjabloon gebruikt waarin Bicep en JSON worden gecombineerd om een sjabloonspecificatie te maken en te implementeren.

@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

Sjabloonspecificatie maken

De sjabloonspecificatie is een resourcetype met de naam Microsoft.Resources/templateSpecs. Als u een sjabloonspecificatie wilt maken, gebruikt u Azure CLI, Azure PowerShell of een Bicep-bestand.

In dit voorbeeld wordt de naam templateSpecRGvan de resourcegroep gebruikt. U kunt een andere naam gebruiken, maar u moet de opdrachten wijzigen.

Maak een nieuwe resourcegroep voor de sjabloonspecificatie.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

Maak de sjabloonspecificatie in deze resourcegroep. Geef de nieuwe sjabloonspecificatie de naam storageSpec.

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

Maak een nieuwe resourcegroep voor de sjabloonspecificatie.

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

Maak de sjabloonspecificatie in deze resourcegroep. Geef de nieuwe sjabloonspecificatie de naam storageSpec.

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

U kunt een sjabloonspecificatie maken met een Bicep-bestand, maar de mainTemplate sjabloon moet in JSON staan. De JSON-sjabloon gebruikt geen standaard-JSON-syntaxis. Er zijn bijvoorbeeld geen einde-van-regelkomma's, dubbele aanhalingstekens worden vervangen door enkele aanhalingstekens en backslashes (\) worden gebruikt om enkele aanhalingstekens binnen expressies te ontsnappen.

Kopieer de volgende sjabloon en sla deze op uw computer op als 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\')]'
        }
      }
    }
  }
}

Gebruik Azure PowerShell of Azure CLI om een nieuwe resourcegroep te maken.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

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

Maak de sjabloonspecificatie in deze resourcegroep. De sjabloonspecificatienaam storageSpec en versienummer 1.0 zijn parameters in het Bicep-bestand.

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

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

Sjabloonspecificatie implementeren

Gebruik de sjabloonspecificatie om een opslagaccount te implementeren. In dit voorbeeld wordt de naam storageRGvan de resourcegroep gebruikt. U kunt een andere naam gebruiken, maar u moet de opdrachten wijzigen.

Eerst maakt u een resourcegroep die het nieuwe opslagaccount bevat.
```
New-AzResourceGroup `
  -Name storageRG `
  -Location westus2
```

Haal de resource-id op van de sjabloonspecificatie.

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

Implementeer de sjabloonspecificatie.

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

U geeft parameters precies zoals u zou doen voor een bicep-bestandsimplementatie. Implementeer de sjabloonspecificatie opnieuw met een parameter voor het type opslagaccount.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageAccountType Standard_GRS
```

Eerst maakt u een resourcegroep die het nieuwe opslagaccount bevat.
```
az group create \
  --name storageRG \
  --location westus2
```
Haal de resource-id op van de sjabloonspecificatie.
```
id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")
```
Notitie

Er is een bekend probleem met het ophalen van een sjabloonspecificatie-id en het toewijzen ervan aan een variabele in Windows PowerShell.

Implementeer de sjabloonspecificatie.

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

U geeft parameters precies zoals u zou doen voor een bicep-bestandsimplementatie. Implementeer de sjabloonspecificatie opnieuw met een parameter voor het type opslagaccount.
```
az deployment group create \
  --resource-group storageRG \
  --template-spec $id \
  --parameters storageAccountType="Standard_GRS"
```

Als u een sjabloonspecificatie wilt implementeren met behulp van een Bicep-bestand, gebruikt u een module. De module is gekoppeld aan een bestaande sjabloonspecificatie. Zie bestand in sjabloonspecificatie voor meer informatie.

Kopieer de volgende Bicep-module en sla deze op uw computer op als storage.bicep.

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

Vervang <subscriptionId> deze in de module. Gebruik Azure PowerShell of Azure CLI om uw abonnements-id op te halen.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Gebruik Azure PowerShell of Azure CLI om een nieuwe resourcegroep te maken voor het opslagaccount.

New-AzResourceGroup `
  -Name storageRG `
  -Location westus2

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

Implementeer de sjabloonspecificatie met Azure PowerShell of Azure CLI.

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

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

U kunt een parameter toevoegen en de sjabloonspecificatie opnieuw implementeren met een ander type opslagaccount. Kopieer het voorbeeld en vervang het bestand storage.bicep . Implementeer vervolgens de implementatie van de sjabloonspecificatie opnieuw.
```
module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
  params: {
    storageAccountType: 'Standard_GRS'
  }
}
```

Toegang verlenen

Als u wilt dat andere gebruikers in uw organisatie uw sjabloonspecificatie implementeren, moet u hen leestoegang verlenen. U kunt de rol Lezer toewijzen aan een Microsoft Entra-groep voor de resourcegroep die sjabloonspecificaties bevat die u wilt delen. Zie Zelfstudie: Een groep toegang verlenen tot Azure-resources met behulp van Azure PowerShell voor meer informatie.

Bicep-bestand bijwerken

Nadat de sjabloonspecificatie is gemaakt, hebt u besloten het Bicep-bestand bij te werken. Als u wilt doorgaan met de voorbeelden in de PowerShell - of CLI-tabbladen , kopieert u het voorbeeld en vervangt u het bestand main.bicep .

De parameter storageNamePrefix geeft een voorvoegselwaarde op voor de naam van het opslagaccount. De storageAccountName variabele voegt het voorvoegsel samen met een unieke tekenreeks.

@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

Versie van sjabloonspecificatie bijwerken

In plaats van een nieuwe sjabloonspecificatie te maken voor de herziene sjabloon, voegt u een nieuwe versie toe met de naam van 2.0 de bestaande sjabloonspecificatie. Gebruikers kunnen ervoor kiezen om een van beide versies te implementeren.

Maak een nieuwe versie van de sjabloonspecificatie.

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

Als u de nieuwe versie wilt implementeren, haalt u de resource-id op voor de 2.0-versie.

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

Implementeer de nieuwe versie en gebruik het storageNamePrefix om een voorvoegsel op te geven voor de naam van het opslagaccount.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageNamePrefix "demo"
```

Maak een nieuwe versie van de sjabloonspecificatie.

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

Als u de nieuwe versie wilt implementeren, haalt u de resource-id op voor de 2.0-versie.

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

Implementeer de nieuwe versie en gebruik het storageNamePrefix om een voorvoegsel op te geven voor de naam van het opslagaccount.

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

Maak een nieuwe versie van de sjabloonspecificatie. Kopieer het voorbeeld en vervang het bestand main.bicep .

De parameter storageNamePrefix geeft een voorvoegselwaarde op voor de naam van het opslagaccount. De storageAccountName variabele voegt het voorvoegsel samen met een unieke tekenreeks.

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\')]'
        }
      }
    }
  }
}

Als u de nieuwe versie wilt toevoegen aan de sjabloonspecificatie, implementeert u uw sjabloon met Azure PowerShell of Azure CLI.

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

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

Kopieer de volgende Bicep-module en sla deze op uw computer op als storage.bicep.

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

Vervang <subscriptionId> deze in de module. Gebruik Azure PowerShell of Azure CLI om uw abonnements-id op te halen.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Implementeer de sjabloonspecificatie met Azure PowerShell of Azure CLI.

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

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

Resources opschonen

Als u de resources wilt opschonen die u in deze quickstart hebt geïmplementeerd, verwijdert u beide resourcegroepen. De resourcegroep, sjabloonspecificaties en opslagaccounts worden verwijderd.

Gebruik Azure PowerShell of Azure CLI om de resourcegroepen te verwijderen.

Remove-AzResourceGroup -Name "templateSpecRG"

Remove-AzResourceGroup -Name "storageRG"

az group delete --name templateSpecRG

az group delete --name storageRG

Volgende stappen

Azure Resource Manager-sjabloonspecificaties in Bicep

Delen via