Creare file Bicep usando Visual Studio Code

  • Articolo

Questo articolo illustra come usare Visual Studio Code per creare file Bicep.

Installa VS Code

Per configurare l'ambiente per lo sviluppo Bicep, vedere Installare gli strumenti Bicep. Dopo aver completato questi passaggi, si disporrà di Visual Studio Code e dell'estensione Bicep. È disponibile anche la versione più recente dell'interfaccia della riga di comando di Azure o la versione più recente modulo di Azure PowerShell.

Comandi Bicep

Visual Studio Code include diversi comandi Bicep.

Aprire o creare un file Bicep in VS Code, selezionare il menu Visualizza e quindi selezionare Riquadro comandi. È anche possibile usare F1 o la combinazione di tasti CTRL+MAIUSC+P per visualizzare il riquadro comandi. Digitare Bicep per elencare i comandi Bicep.

Screenshot dei comandi Bicep di Visual Studio Code nel riquadro comandi.

Tra questi comandi vi sono:

Questi comandi vengono visualizzati anche nel menu di scelta rapida quando si fa clic con il pulsante destro del mouse su un file Bicep:

Screenshot dei comandi Bicep di Visual Studio Code nel menu di scelta rapida per i file Bicep.

Quando si fa clic con il pulsante destro del mouse su un file JSON:

Screenshot dei comandi Bicep di Visual Studio Code nel menu di scelta rapida per i modelli JSON arm.

Compilare un modello di Azure Resource Manager

Il comando build converte un file Bicep in un modello di Azure Resource Manager (modello ARM). Il nuovo modello JSON viene archiviato nella stessa cartella con lo stesso nome file. Se esiste un file con lo stesso nome file, sovrascrive il file precedente. Per altre informazioni, vedere Comandi dell'interfaccia della riga di comando di Bicep.

Creare un file di configurazione Bicep

Il file di configurazione Bicep (bicepconfig.json) può essere usato per personalizzare l'esperienza di sviluppo Bicep. È possibile aggiungere bicepconfig.json in più directory. Viene usato il file di configurazione più vicino al file bicep nella gerarchia di directory. Quando si seleziona questo comando, l'estensione apre una finestra di dialogo per selezionare una cartella. La cartella predefinita è la posizione in cui si archivia il file Bicep. Se nella cartella è già presente un file bicepconfig.json, è possibile sovrascrivere il file esistente.

Per creare un file di configurazione Bicep:

  1. Aprire Visual Studio Code.
  2. Nel menu Visualizza selezionare Riquadro comandi oppure premere CTRL/CMD+MAIUSC+P) e quindi selezionare Bicep: crea file di configurazione Bicep.
  3. Selezionare la directory di file in cui inserire il file.
  4. Al termine, salvare il file di configurazione.

Decompilare in Bicep

Questo comando decompila un modello ARM JSON in un file Bicep e lo inserisce nella stessa directory del modello ARM JSON. Il nuovo file ha lo stesso nome di file con estensione .bicep. Se nella stessa cartella esiste già un file Bicep con lo stesso nome di file, Visual Studio Code richiede di sovrascrivere il file esistente o di creare una copia.

Distribuisci file Bicep

È possibile distribuire file Bicep direttamente da Visual Studio Code. Selezionare Distribuisci file Bicep nel riquadro comandi o nel menu di scelta rapida. L'estensione richiede di accedere ad Azure, selezionare la sottoscrizione, creare/selezionare il gruppo di risorse e immettere i valori dei parametri.

Nota

Il comando Bicep distribuisci dall’interno di vscode usa l'estensione account di Azure per l'autenticazione. Non usa profili cloud da bicepconfig.json.

Generare un file di parametri

Questo comando crea un file di parametri nella stessa cartella del file Bicep. È possibile scegliere di creare un file di parametri Bicep o un file di parametri JSON. Il nuovo nome del file di parametri Bicep è <bicep-file-name>.bicepparam, mentre il nuovo nome file di parametri JSON è <bicep-file-name>.parameters.json.

Importare il manifesto Kubernetes (Anteprima)

Questo comando importa un file manifesto Kubernetes e crea un modulo Bicep. Per altre informazioni, vedere Provider Kubernetes di estendibilità di Bicepe Avvio rapido: distribuire applicazioni di Azure nel cluster del servizio Azure Kubernetes (AKS) usando il provider Kubernetes Bicep (Anteprima).

Inserisci risorsa

Il comando insert resource aggiunge una dichiarazione di risorsa nel file Bicep specificando l'ID risorsa di una risorsa esistente. Dopo aver selezionato Inserisci risorsa, immettere l'ID risorsa nel riquadro comandi. L'inserimento della risorsa richiede alcuni minuti.

È possibile trovare l'ID risorsa usando uno di questi metodi:

Analogamente all'esportazione di modelli, il processo tenta di creare una risorsa utilizzabile. Tuttavia, la maggior parte delle risorse inserite richiede alcune modifiche prima di poter essere usati per distribuire le risorse di Azure.

Per altre informazioni, vedere Decompilazione di JSON del modello ARM in Bicep.

Aprire il visualizzatore Bicep

Il visualizzatore mostra le risorse definite nel file Bicep con le informazioni sulle dipendenze delle risorse. Il diagramma è la visualizzazione di un file Bicep per macchina virtuale Linux.

Visualizzatore Bicep di Visual Studio Code

È anche possibile aprire il visualizzatore affiancato al file Bicep.

Ripristinare i moduli Bicep

Quando il file Bicep usa moduli pubblicati in un Registro di sistema, il comando Ripristina ottiene copie di tutti i moduli necessari dal Registro di sistema. Archivia tali copie in una cache locale. Per altre informazioni, vedere ripristino.

Visualizzare il documento del tipo

Da Visual Studio Code è possibile aprire il riferimento al modello per il tipo di risorsa su cui si sta lavorando. A tale scopo, passare il cursore sul nome simbolico della risorsa e selezionare Visualizza documento tipo.

Screenshot del documento tipo di visualizzazione Bicep di Visual Studio Code.

Andare a Definizione

Quando si definisce un modulo, indipendentemente dai tipi del file a cui si fa riferimento, che si tratti di un file locale, di un file del Registro di sistema del modulo o di una specifica di modello, è possibile aprire il file a cui si fa riferimento selezionando o evidenziando il percorso del modulo e quindi premere [F12]. Se il file a cui si fa riferimento è un modulo di Verifica di Azure (AVM), è possibile passare da un file JSON compilato a un file Bicep. Per poter aprire il file Bicep di un modulo del Registro di sistema privato, assicurarsi che il modulo venga pubblicato nel Registro di sistema con l'opzione WithSource abilitata. Per altre informazioni, vedere Pubblicare file nel Registro di sistema. L'estensione Bicep di Visual Studio Code versione 0.27.1 o successiva è necessaria per aprire il file Bicep dal registro dei moduli privati.

Incolla come Bicep

È possibile incollare un frammento JSON da un modello di Resource Manager al file Bicep. Visual Studio Code decompila automaticamente il codice JSON in Bicep. Questa funzionalità è disponibile solo con l'estensione Bicep versione 0.14.0 o successiva. Questa funzionalità è abilitata per impostazione predefinita. Per disabilitare la funzionalità, vedere Vs Code e estensione Bicep.

Questa funzionalità permette di incollare:

  • Modelli ARM JSON completi.
  • Singola risorsa o più risorse.
  • Valori JSON, ad esempio oggetti, array e sttringhe. Una stringa con virgolette doppie viene convertita in virgolette singole.

Ad esempio, è possibile iniziare con il file Bicep seguente:

@description('Storage Account type')
@allowed([
  'Standard_LRS'
  'Standard_GRS'
  'Standard_ZRS'
  'Premium_LRS'
])
param storageAccountsku string = 'Standard_LRS'

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

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

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-04-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountsku
  }
  kind: 'StorageV2'
  tags: {
    ObjectName: storageAccountName
  }
  properties: {}
}

output storageAccountName string = storageAccountName

Incollare anche il codice JSON seguente:

{
  "type": "Microsoft.Batch/batchAccounts",
  "apiVersion": "2024-02-01",
  "name": "[parameters('batchAccountName')]",
  "location": "[parameters('location')]",
  "tags": {
    "ObjectName": "[parameters('batchAccountName')]"
  },
  "properties": {
    "autoStorage": {
      "storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
    }
  }
}

Visual Studio Code converte automaticamente il codice JSON in Bicep. Si noti anche che è necessario aggiungere il parametro denominato batchAccountName.

È possibile annullare la decompilazione usando CTRL+Z. Il codice JSON originale viene visualizzato nel file.

Risoluzione dei problemi

Il riquadro Problems riepiloga gli errori e gli avvisi nel file Bicep.

Screenshot del riquadro dei problemi Bicep di Visual Studio Code.

Per l'elenco dei codici di errore/avviso, vedere Codici di errore/avviso Bicep.

Passaggi successivi

Per un avvio rapido, vedere Avvio rapido: creare file Bicep con Visual Studio Code.