Delen via

Bicep-bestanden maken met Visual Studio Code

  • Artikel

In dit artikel leest u hoe u Visual Studio Code gebruikt om Bicep-bestanden te maken.

VS-code installeren

Zie Bicep-hulpprogramma's installeren om uw omgeving in te stellen voor Bicep-ontwikkeling. Nadat u deze stappen hebt voltooid, hebt u Visual Studio Code en de Bicep-extensie. U hebt ook de nieuwste Azure CLI of de nieuwste Azure PowerShell-module.

Bicep-opdrachten

Visual Studio Code wordt geleverd met verschillende Bicep-opdrachten.

Open of maak een Bicep-bestand in VS Code, selecteer het menu Beeld en selecteer vervolgens Opdrachtpalet. U kunt ook F1 of de toetsencombinatie Ctrl+Shift+P gebruiken om het opdrachtenpalet weer te geven. Typ Bicep om de Bicep-opdrachten weer te geven.

Schermopname van Visual Studio Code Bicep-opdrachten in het opdrachtenpalet.

Deze opdrachten zijn onder andere:

Deze opdrachten worden ook weergegeven in het contextmenu wanneer u met de rechtermuisknop op een Bicep-bestand klikt:

Schermopname van Visual Studio Code Bicep-opdrachten in het contextmenu voor Bicep-bestanden.

Wanneer u met de rechtermuisknop op een JSON-bestand klikt:

Schermopname van Visual Studio Code Bicep-opdrachten in het contextmenu voor ARM JSON-sjablonen.

ARM-sjabloon bouwen

Met de build opdracht wordt een Bicep-bestand geconverteerd naar een Azure Resource Manager-sjabloon (ARM-sjabloon). De nieuwe JSON-sjabloon wordt opgeslagen in dezelfde map met dezelfde bestandsnaam. Als er een bestand met dezelfde bestandsnaam bestaat, wordt het oude bestand overschreven. Zie Bicep CLI-opdrachten voor meer informatie.

Bicep-configuratiebestand maken

Het Bicep-configuratiebestand (bicepconfig.json) kan worden gebruikt om uw Bicep-ontwikkelervaring aan te passen. U kunt meerdere mappen toevoegen bicepconfig.json . Het configuratiebestand dat het dichtst bij het bicep-bestand in de maphiërarchie ligt, wordt gebruikt. Wanneer u deze opdracht selecteert, wordt met de extensie een dialoogvenster geopend waarin u een map kunt selecteren. In de standaardmap slaat u het Bicep-bestand op. Als er al een bicepconfig.json bestand in de map bestaat, kunt u het bestaande bestand overschrijven.

Een Bicep-configuratiebestand maken:

  1. Open Visual Studio Code.
  2. Selecteer in het menu Beeld het opdrachtpalet (of druk op Ctrl/Cmd+Shift+P) en selecteer vervolgens Bicep: Bicep-configuratiebestand maken.
  3. Selecteer de bestandsmap waar u het bestand wilt plaatsen.
  4. Sla het configuratiebestand op wanneer u klaar bent.

Decompileren in Bicep

Met deze opdracht wordt een ARM JSON-sjabloon gedecompileert in een Bicep-bestand en wordt deze in dezelfde map als de ARM JSON-sjabloon opgeslagen. Het nieuwe bestand heeft dezelfde bestandsnaam met de extensie .bicep . Als er al een Bicep-bestand met dezelfde bestandsnaam in dezelfde map bestaat, wordt u in Visual Studio Code gevraagd het bestaande bestand te overschrijven of een kopie te maken.

Bicep-bestand implementeren

U kunt Bicep-bestanden rechtstreeks vanuit Visual Studio Code implementeren. Selecteer Bicep-bestand implementeren in het opdrachtenpalet of in het contextmenu. De extensie vraagt u om u aan te melden bij Azure, een abonnement te selecteren, een resourcegroep te maken/te selecteren en parameterwaarden in te voeren.

Notitie

De bicep deploy-opdracht vanuit vscode maakt gebruik van de Azure-accountextensie voor verificatie. Er worden geen cloudprofielen van bicepconfig.json gebruikt.

Parametersbestand genereren

Met deze opdracht maakt u een parameterbestand in dezelfde map als het Bicep-bestand. U kunt ervoor kiezen om een Bicep-parameterbestand of een JSON-parameterbestand te maken. De nieuwe naam van het bicep-parameterbestand is <bicep-file-name>.bicepparam, terwijl de nieuwe JSON-parameterbestandsnaam is <bicep-file-name>.parameters.json.

Kubernetes-manifest importeren (preview)

Met deze opdracht importeert u een Kubernetes-manifestbestand en maakt u een Bicep-module. Zie Bicep-uitbreidbaarheid kubernetes-provider en quickstart: Azure-toepassingen implementeren in AKS-cluster (Azure Kubernetes Service) met bicep Kubernetes-provider (preview)voor meer informatie.

Resource invoegen

Met insert resource de opdracht wordt een resourcedeclaratie toegevoegd aan het Bicep-bestand door de resource-id van een bestaande resource op te geven. Nadat u Resource invoegen hebt geselecteerd, voert u de resource-id in het opdrachtenpalet in. Het duurt even voordat de resource is ingevoegd.

U kunt de resource-id vinden met behulp van een van de volgende methoden:

Net als bij het exporteren van sjablonen probeert het proces een bruikbare resource te maken. Voor de meeste ingevoegde resources is echter enige wijziging vereist voordat ze kunnen worden gebruikt voor het implementeren van Azure-resources.

Zie Decompiling ARM-sjabloon JSON naar Bicep voor meer informatie.

Bicep visualizer openen

De visualizer toont de resources die zijn gedefinieerd in het Bicep-bestand met de informatie over de resourceafhankelijkheid. Het diagram is de visualisatie van een Bicep-bestand van een virtuele Linux-machine.

Visual Studio Code Bicep visualizer

U kunt de visualizer ook naast het Bicep-bestand openen.

Bicep-modules herstellen

Wanneer uw Bicep-bestand modules gebruikt die naar een register zijn gepubliceerd, worden met de herstelopdracht kopieën van alle vereiste modules uit het register opgehaald. Deze kopieën worden opgeslagen in een lokale cache. Zie herstellen voor meer informatie.

Document met weergavetype

Vanuit Visual Studio Code kunt u de sjabloonverwijzing openen voor het resourcetype waaraan u werkt. Als u dit wilt doen, beweegt u de cursor boven de symbolische naam van de resource en selecteert u het document Weergavetype.

Schermopname van visual Studio Code Bicep-weergavetypedocument.

Naar definitie gaan

Wanneer u een module definieert, ongeacht de typen van het bestand waarnaar wordt verwezen, of het nu een lokaal bestand, moduleregisterbestand, sjabloonspecificatie is, kunt u het bestand openen door het modulepad te selecteren of te markeren en vervolgens op [F12] te drukken. Als het bestand waarnaar wordt verwezen een Azure Verified Modules (AVM) is, kunt u schakelen tussen gecompileerd JSON- of Bicep-bestand. Als u het Bicep-bestand van een privéregistermodule wilt kunnen openen, moet u ervoor zorgen dat de module wordt gepubliceerd naar het register met de WithSource schakeloptie ingeschakeld. Zie Bestanden publiceren naar het register voor meer informatie. De Visual Studio Code Bicep-extensie versie 0.27.1 of hoger is vereist voor het openen van bicep-bestand vanuit het privémoduleregister.

Plakken als Bicep

U kunt een JSON-fragment uit een ARM-sjabloon plakken in bicep-bestand. Visual Studio Code decompileert de JSON automatisch met Bicep. Deze functie is alleen beschikbaar met de Bicep-extensie versie 0.14.0 of hoger. Deze functie is standaard ingeschakeld. Zie VS Code en Bicep-extensie om de functie uit te schakelen.

Met deze functie kunt u het volgende plakken:

  • Volledige ARM JSON-sjablonen.
  • Eén resource of meerdere resources.
  • JSON-waarden, zoals objecten, matrices en tekenreeksen. Een tekenreeks met dubbele aanhalingstekens wordt geconverteerd naar enkele aanhalingstekens.

U kunt bijvoorbeeld beginnen met het volgende Bicep-bestand:

@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@2021-08-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountsku
  }
  kind: 'StorageV2'
  tags: {
    ObjectName: storageAccountName
  }
  properties: {}
}

output storageAccountName string = storageAccountName

Plak de volgende JSON:

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

Visual Studio Code converteert de JSON automatisch naar Bicep. U ziet dat u ook de parameter met de naam batchAccountNamemoet toevoegen.

U kunt de decompilatie ongedaan maken met Ctrl+Z. De oorspronkelijke JSON wordt weergegeven in het bestand.

Volgende stappen

Zie Quickstart: Bicep-bestanden maken met Visual Studio Code om een quickstart te doorlopen.