Avvio rapido: Creare e distribuire una specifica di modello con Bicep

Articolo
09/26/2024

Questo avvio rapido descrive come creare e distribuire una specifica di modello con un file Bicep. Una specifica di modello viene distribuita in un gruppo di risorse in modo che gli utenti dell'organizzazione possano distribuire le risorse in Microsoft Azure. Le specifiche di modello consentono di condividere i modelli di distribuzione senza dover concedere agli utenti l'accesso per modificare il file Bicep. Questo esempio di specifica di modello usa un file Bicep per distribuire un account di archiviazione.

Quando si crea una specifica di modello, il file Bicep viene sottoposto a transpile in JavaScript Object Notation (JSON). La specifica di modello usa JSON per distribuire le risorse di Azure. Attualmente, non è possibile usare il portale di Microsoft Azure per importare un file Bicep e creare una risorsa specifica di modello.

Prerequisiti

Un account Azure con una sottoscrizione attiva. Creare un account gratuitamente.
Azure PowerShell versione 6.3.0 o successiva o l'interfaccia della riga di comando di Azure versione 2.27.0 o successiva.
Visual Studio Code con l'estensione Bicep.

Creare un file Bicep

Per creare una specifica di modello si userà un file Bicep. Copiare l'esempio seguente e salvarlo nel computer come main.bicep. Gli esempi usano il percorso C:\templates\main.bicep. È possibile usare un percorso diverso, ma è necessario modificare i comandi.

Il file Bicep seguente viene usato nelle schede PowerShell e Interfaccia della riga di comando. La scheda File Bicep usa un modello diverso che combina Bicep e JSON per creare e distribuire una specifica di modello.

@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@2023-04-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountType
  }
  kind: 'StorageV2'
  properties: {}
}

output storageAccountNameOutput string = storageAccount.name

Creare la specifica di modello

La specifica di modello è un tipo di risorsa denominato Microsoft.Resources/templateSpecs. Per creare una specifica di modello, usare l'interfaccia della riga di comando di Azure, Azure PowerShell o un file Bicep.

In questo esempio viene usato il nome del gruppo di risorse templateSpecRG. È possibile usare un nome diverso, ma è necessario modificare i comandi.

Creare un nuovo gruppo di risorse per contenere la specifica di modello.
```
New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2
```

Creare la specifica di modello in quel gruppo di risorse. Assegnare alla nuova specifica di modello il nome storageSpec.

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

Creare un nuovo gruppo di risorse per contenere la specifica di modello.
```
az group create \
  --name templateSpecRG \
  --location westus2
```

Creare la specifica di modello in quel gruppo di risorse. Assegnare alla nuova specifica di modello il nome storageSpec.

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

È possibile creare una specifica di modello con un file Bicep, ma mainTemplate deve essere in JSON. Il modello JSON non usa la sintassi JSON standard. Ad esempio, non sono presenti virgole di fine riga, virgolette doppie vengono sostituite con virgolette singole e le barre rovesciata (\) vengono usate per l'escape delle virgolette singole all'interno di espressioni.

Copiare il modello seguente e salvarlo nel computer come 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': '2023-04-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Usare Azure PowerShell o l'interfaccia della riga di comando di Azure per creare un nuovo gruppo di risorse.

New-AzResourceGroup `
  -Name templateSpecRG `
  -Location westus2

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

Creare la specifica di modello in quel gruppo di risorse. Il nome della specifica di modello storageSpec e il numero di versione 1.0 sono parametri nel file Bicep.

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

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

Distribuire la specifica di modello

Usare la specifica di modello per distribuire un account di archiviazione. In questo esempio viene usato il nome del gruppo di risorse storageRG. È possibile usare un nome diverso, ma è necessario modificare i comandi.

Creare un gruppo di risorse per contenere il nuovo account di archiviazione.
```
New-AzResourceGroup `
  -Name storageRG `
  -Location westus2
```

Ottenere l'ID risorsa della specifica di modello.

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

Distribuire la specifica di modello.

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

Specificare i parametri usando la stessa procedura adottata per la distribuzione di file Bicep. Ridistribuire la specifica di modello con un parametro per il tipo di account di archiviazione.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageAccountType Standard_GRS
```

Creare un gruppo di risorse per contenere il nuovo account di archiviazione.
```
az group create \
  --name storageRG \
  --location westus2
```
Ottenere l'ID risorsa della specifica di modello.
```
id=$(az ts show --name storageSpec --resource-group templateSpecRG --version "1.0" --query "id")
```
Nota

È stato rilevato un problema noto relativo al recupero di un ID specifica di modello e all'assegnazione di tale ID a una variabile in Windows PowerShell.

Distribuire la specifica di modello.

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

Specificare i parametri usando la stessa procedura adottata per la distribuzione di file Bicep. Ridistribuire la specifica di modello con un parametro per il tipo di account di archiviazione.
```
az deployment group create \
  --resource-group storageRG \
  --template-spec $id \
  --parameters storageAccountType="Standard_GRS"
```

Per distribuire una specifica di modello usando un file Bicep, usare un modulo. Il modulo si collega a una specifica di modello esistente. Per ulteriori informazioni, vedere File nella specifica di modello.

Copiare il modulo Bicep seguente e salvarlo nel computer come storage.bicep.

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

Sostituire <subscriptionId> nel modulo. Usare Azure PowerShell o l'interfaccia della riga di comando di Azure per ottenere l'ID sottoscrizione.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```
Usare PowerShell o l'interfaccia della riga di comando di Azure per creare un nuovo gruppo di risorse per l'account di archiviazione.
```
New-AzResourceGroup `
  -Name storageRG `
  -Location westus2
```
```
az group create \
  --name storageRG \
  --location westus2
```

Distribuire la specifica di modello con Azure PowerShell o l'interfaccia della riga di comando di Azure.

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

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

È possibile aggiungere un parametro e ridistribuire la specifica di modello con un tipo di account di archiviazione differente. Copiare l'esempio e sostituire il file storage.bicep. Ridistribuire quindi la distribuzione delle specifiche del modello.
```
module deployTemplateSpec 'ts:<subscriptionId>/templateSpecRG/storageSpec:1.0' = {
  name: 'deployVersion1'
  params: {
    storageAccountType: 'Standard_GRS'
  }
}
```

Concedi accesso

Se si vuole consentire ad altri utenti dell'organizzazione di distribuire la specifica di modello, è necessario concedere loro l'accesso in lettura. È possibile assegnare il ruolo Lettore a un gruppo Microsoft Entra per il gruppo di risorse che contiene le specifiche di modello da condividere. Per ulteriori informazioni, vedere Esercitazione: Concedere l'accesso alle risorse di Azure a un gruppo usando Azure PowerShell.

Aggiornare il file Bicep

Dopo aver creato la specifica di modello, si è deciso di aggiornare il file Bicep. Per continuare con gli esempi nelle schede PowerShell o Interfaccia della riga di comando, copiare l'esempio e sostituire il file main.bicep.

Il parametro storageNamePrefix specifica un valore di prefisso per il nome dell'account di archiviazione. La variabile storageAccountName concatena il prefisso con una stringa univoca.

@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

Aggiornare la versione della specifica di modello

Invece di creare una nuova specifica di modello per il modello modificato, aggiungere una nuova versione denominata 2.0 alla specifica di modello esistente. Gli utenti possono scegliere di distribuire una qualsiasi delle versioni.

Creare una nuova versione per la specifica di modello.

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

Per distribuire la nuova versione, ottenere l'ID della risorsa per la versione 2.0.

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

Distribuire la nuova versione e usare per storageNamePrefix specificare un prefisso per il nome dell'account di archiviazione.
```
New-AzResourceGroupDeployment `
  -TemplateSpecId $id `
  -ResourceGroupName storageRG `
  -storageNamePrefix "demo"
```

Creare una nuova versione per la specifica di modello.

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

Per distribuire la nuova versione, ottenere l'ID della risorsa per la versione 2.0.

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

Distribuire la nuova versione e usare per storageNamePrefix specificare un prefisso per il nome dell'account di archiviazione.

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

Creare una nuova versione per la specifica di modello. Copiare l'esempio e sostituire il file main.bicep.

Il parametro storageNamePrefix specifica un valore di prefisso per il nome dell'account di archiviazione. La variabile storageAccountName concatena il prefisso con una stringa univoca.

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': '2023-04-01'
          'name': '[variables(\'storageAccountName\')]'
          'location': '[parameters(\'location\')]'
          'sku': {
            'name': '[parameters(\'storageAccountType\')]'
          }
          'kind': 'StorageV2'
          'properties': {}
        }
      ]
      'outputs': {
        'storageAccountNameOutput': {
          'type': 'string'
          'value': '[variables(\'storageAccountName\')]'
        }
      }
    }
  }
}

Per aggiungere la nuova versione alla specifica di modello, distribuire il modello con PowerShell o con l'interfaccia della riga di comando di Azure.

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

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

Copiare il modulo Bicep seguente e salvarlo nel computer come storage.bicep.

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

Sostituire <subscriptionId> nel modulo. Usare Azure PowerShell o l'interfaccia della riga di comando di Azure per ottenere l'ID sottoscrizione.
```
(Get-AzContext).Subscription.Id
```
```
az account show --query "id" --output tsv
```

Distribuire la specifica di modello con Azure PowerShell o l'interfaccia della riga di comando di Azure.

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

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

Pulire le risorse

Per pulire le risorse distribuite in questo argomento di avvio rapido, eliminare entrambi i gruppi di risorse. Verranno eliminati il gruppo di risorse, le specifiche del modello e gli account di archiviazione.

Usare Azure PowerShell o l'interfaccia della riga di comando di Azure per eliminare i gruppi di risorse.

Remove-AzResourceGroup -Name "templateSpecRG"

Remove-AzResourceGroup -Name "storageRG"

az group delete --name templateSpecRG

az group delete --name storageRG

Passaggi successivi

Specifiche di modello di Azure Resource Manager in Bicep

Condividi tramite