Créer des fichiers Bicep à l’aide de Visual Studio Code

Article
07/18/2024

Cet article explique comment utiliser Visual Studio Code pour créer des fichiers Bicep.

Installer VS Code

Pour configurer votre environnement pour le développement Bicep, consultez Installer les outils bicep. Au terme de cette procédure, vous disposerez de Visual Studio Code et de l'extension Bicep. Vous disposez également de la dernière version d’Azure CLI ou du dernier module Azure PowerShell.

Commandes Bicep

Visual Studio Code est fourni avec plusieurs commandes Bicep.

Ouvrez ou créez un fichier Bicep dans VS Code, sélectionnez le menu Affichage, puis sélectionnez Palette de commandes. Vous pouvez également utiliser F1 ou la combinaison de touches Ctrl+Maj+P pour afficher la palette de commandes. Saisissez Bicep pour afficher la liste des commandes Bicep.

Capture d’écran des commandes Bicep de Visual Studio Code dans la palette de commandes.

Ces commandes sont les suivantes :

Générer un modèle ARM
Créer le fichier de configuration Bicep
Décompiler dans Bicep
Déployer le fichier Bicep
Générer un fichier de paramètres
Importer un manifeste Kubernetes (préversion)
Insérer la ressource
Ouvrir le visualiseur Bicep
Ouvrir le visualiseur Bicep sur le côté
Restaurer des modules Bicep (de force)

Ces commandes s’affichent également dans le menu contextuel quand vous cliquez avec le bouton droit sur un fichier Bicep :

Lorsque vous cliquez avec le bouton droit sur un fichier JSON :

Générer un modèle ARM

La commande build convertit un fichier Bicep en modèle Azure Resource Manager (modèle ARM). Le nouveau modèle JSON est stocké dans le même dossier avec le même nom de fichier. Si un fichier portant le même nom de fichier existe, il remplace l’ancien fichier. Pour plus d’informations, consultez Commandes CLI Bicep.

Créer le fichier de configuration Bicep

Le fichier de configuration Bicep (bicepconfig.json) peut être utilisé pour personnaliser votre expérience de développement Bicep. Vous pouvez ajouter bicepconfig.json dans plusieurs répertoires. Le fichier de configuration le plus proche du fichier Bicep dans la hiérarchie de répertoire est utilisé. Lorsque vous sélectionnez cette commande, l’extension ouvre une boîte de dialogue pour vous permettre de sélectionner un dossier. Le dossier par défaut est celui où vous stockez le fichier Bicep. Si un fichier bicepconfig.json existe déjà dans le dossier, vous pouvez écraser le fichier existant.

Pour créer un fichier de configuration Bicep :

Ouvrez Visual Studio Code.
Dans le menu Affichage, sélectionnez Palette de commandes (ou appuyez sur Ctrl/Cmd+Maj+P), puis sélectionnez Bicep : Créer un fichier de configuration Bicep.
Sélectionnez le répertoire de fichiers dans lequel vous souhaitez placer le fichier.
Enregistrez le fichier de configuration lorsque vous avez terminé.

Décompiler dans Bicep

Cette commande décompile un modèle JSON ARM dans un fichier Bicep et le place dans le même répertoire que le modèle JSON ARM. Le nouveau fichier porte le même nom de fichier avec l’extension .bicep. Si un fichier Bicep portant le même nom de fichier existe déjà dans le même dossier, Visual Studio Code vous invite à remplacer le fichier existant ou à créer une copie.

Déployer le fichier Bicep

Vous pouvez déployer les fichiers Bicep directement à partir de Visual Studio Code. Sélectionnez Déployer le fichier Bicep dans la palette de commandes ou dans le menu contextuel. L’extension vous invite à vous connecter à Azure, à sélectionner un abonnement, à créer/sélectionner un groupe de ressources, puis à entrer des valeurs de paramètre.

Notes

La commande de déploiement Bicep à partir de vscode utilise l’extension de compte Azure pour l’authentification. Elle n’utilise pas les profils cloud de bicepconfig.json.

Générer un fichier de paramètres

Cette commande crée un fichier de paramètres dans le même dossier que le fichier Bicep. Vous pouvez choisir de créer un fichier de paramètres Bicep ou JSON. Le nouveau nom de fichier de paramètre Bicep est <bicep-file-name>.bicepparam, tandis qu’il est <bicep-file-name>.parameters.json pour le fichier de paramètre JSON.

Importer un manifeste Kubernetes (préversion)

Cette commande importe un fichier manifeste Kubernetes et crée un module Bicep. Pour plus d’informations, consultez Fournisseur Kubernetes d’extensibilité Bicep et Démarrage rapide : déployer des applications Azure sur des clusters Azure Kubernetes Services (AKS) à l’aide du fournisseur Kubernetes d’extensibilité Bicep (en préversion).

Insérer une ressource

La commande insert resource ajoute une déclaration de ressource dans le fichier Bicep en fournissant l’ID de ressource d’une ressource existante. Une fois que vous avez sélectionné Insérer une ressource, entrez l’ID de ressource dans la palette de commandes. Quelques instants sont nécessaires pour insérer la ressource.

Vous pouvez trouver l’ID de ressource à l’aide de l’une des méthodes suivantes :

Utiliser l’extension Azure Resources pour Visual Studio Code.
Utilisez le portail Azure.
Utilisez Azure CLI ou Azure PowerShell :
- INTERFACE DE LIGNE DE COMMANDE
- PowerShell
```
az resource list
```
```
Get-AzResource
```

Comme pour l’exportation de modèles, le processus tente de créer une ressource utilisable. Toutefois, la plupart des ressources insérées nécessitent certaines modifications avant de pouvoir être utilisées pour déployer des ressources Azure.

Pour plus d’informations, consultez Décompilation du modèle ARM JSON sur Bicep.

Ouvrir le visualiseur Bicep

Le visualiseur affiche les ressources définies dans le fichier Bicep avec les informations de dépendance des ressources. Le diagramme est la visualisation d’un fichier Bicep de machine virtuelle Linux.

Vous pouvez aussi ouvrir le visualiseur côte à côte avec le fichier Bicep.

Restaurer des modules Bicep

Quand votre fichier Bicep utilise des modules publiés dans un registre, la commande restore obtient des copies de tous les modules nécessaires à partir du registre. Elle stocke ces copies dans un cache local. Pour plus d’informations, consultez restore.

Voir la documentation relative au type

À partir de Visual Studio Code, vous pouvez ouvrir la référence de modèle du type de ressource sur lequel vous travaillez. Pour y parvenir, faites pointer votre curseur sur le nom symbolique de la ressource, puis sélectionnez Voir la documentation relative au type.

Capture d’écran du lien permettant de voir la documentation relative au type dans Bicep pour Visual Studio Code.

Accéder à la définition

Lors de la définition d’un module, quel que soit le type de fichier référencé (fichier local, fichier de registre de module, spécification de modèle), vous pouvez ouvrir le fichier référencé en sélectionnant ou en mettant en surbrillance le chemin d’accès au module, puis en appuyant sur [F12]. Si le fichier référencé est un module vérifié Azure (AVM), vous pouvez basculer entre le fichier JSON compilé ou le fichier Bicep. Pour pouvoir ouvrir le fichier Bicep d’un module de registre privé, vérifiez que le module est publié dans le registre avec le commutateur WithSource activé. Pour plus d’informations, consultez Publier des fichiers dans le registre. L’extension Bicep de Visual Studio Code version 0.27.1 ou ultérieure est requise pour ouvrir le fichier Bicep à partir du registre de modules privés.

Coller en tant que Bicep

Vous pouvez coller un extrait de code JSON à partir d’un modèle ARM dans un fichier Bicep. Visual Studio Code décompile automatiquement le code JSON en Bicep. Cette fonctionnalité n’est disponible qu’avec l’extension Bicep version 0.14.0 ou ultérieure. Cette fonctionnalité est activée par défaut. Pour désactiver la fonctionnalité, consultez VS Code et extension Bicep.

À l’aide de cette fonctionnalité, vous pouvez coller les éléments suivants :

Modèles JSON ARM complets.
Ressource unique ou plusieurs ressources.
Valeurs JSON, telles que des objets, des tableaux et des chaînes. Les guillemets doubles d’une chaîne sont convertis en guillemets simples.

Par exemple, vous pouvez commencer par le fichier Bicep suivant :

@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

Et coller le code JSON suivant :

{
  "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 convertit automatiquement le code JSON en Bicep. Notez que vous devez également ajouter le paramètre nommé batchAccountName.

Vous pouvez annuler la décompilation à l’aide de Ctrl+Z. Le code JSON d’origine apparaît dans le fichier.

Résolution des problèmes

Le volet Problems récapitule les erreurs et les avertissements dans votre fichier Bicep.

Capture d’écran du volet Problèmes de Visual Studio Code Bicep.

Pour obtenir la liste des codes d’erreur/d’avertissement, consultez Codes d’erreur/d’avertissement Bicep.

Étapes suivantes

Pour passer au travers un démarrage rapide, consultez Démarrage rapide : Créer des fichiers Bicep avec Visual Studio Code.

Partage via