Skapa Bicep-filer med hjälp av Visual Studio Code

Artikel
05/11/2024

Den här artikeln visar hur du använder Visual Studio Code för att skapa Bicep-filer.

Installera VS-kod

Information om hur du konfigurerar din miljö för Bicep-utveckling finns i Installera Bicep-verktyg. När du har slutfört dessa steg har du Visual Studio Code och Bicep-tillägget. Du har också antingen den senaste Azure CLI-modulen eller den senaste Azure PowerShell-modulen.

Bicep-kommandon

Visual Studio Code levereras med flera Bicep-kommandon.

Öppna eller skapa en Bicep-fil i VS Code, välj menyn Visa och välj sedan Kommandopalett. Du kan också använda F1 eller tangentkombinationen Ctrl+Skift+P för att ta upp kommandopaletten. Skriv Bicep för att visa Bicep-kommandona.

Skärmbild av Visual Studio Code Bicep-kommandon i kommandopaletten.

Dessa kommandon omfattar:

Skapa ARM-mall
Skapa Bicep-konfigurationsfil
Dekompilera till Bicep
Distribuera Bicep-fil
Generera parameterfil
Importera Kubernetes-manifest (förhandsversion)
Infoga resurs
Öppna Bicep Visualizer
Öppna Bicep Visualizer åt sidan
Återställa Bicep-moduler (framtvinga)

Dessa kommandon visas också på snabbmenyn när du högerklickar på en Bicep-fil:

När du högerklickar på en JSON-fil:

Skapa ARM-mall

Kommandot build konverterar en Bicep-fil till en Azure Resource Manager-mall (ARM-mall). Den nya JSON-mallen lagras i samma mapp med samma filnamn. Om det finns en fil med samma filnamn skriver den över den gamla filen. Mer information finns i Bicep CLI-kommandon.

Skapa Bicep-konfigurationsfil

Bicep-konfigurationsfilen (bicepconfig.json) kan användas för att anpassa Bicep-utvecklingsupplevelsen. Du kan lägga till bicepconfig.json flera kataloger. Konfigurationsfilen som är närmast bicep-filen i kataloghierarkin används. När du väljer det här kommandot öppnar tillägget en dialogruta där du kan välja en mapp. Standardmappen är där du lagrar Bicep-filen. Om det redan finns en bicepconfig.json fil i mappen kan du skriva över den befintliga filen.

Så här skapar du en Bicep-konfigurationsfil:

Öppna Visual Studio Code.
På menyn Visa väljer du Kommandopalett (eller trycker på Ctrl/Cmd+Skift+P) och väljer sedan Bicep: Skapa Bicep-konfigurationsfil.
Välj den filkatalog där du vill placera filen.
Spara konfigurationsfilen när du är klar.

Dekompilera till Bicep

Det här kommandot dekompileras en ARM JSON-mall till en Bicep-fil och placerar den i samma katalog som ARM JSON-mallen. Den nya filen har samma filnamn med .bicep-tillägget . Om det redan finns en Bicep-fil med samma filnamn i samma mapp uppmanar Visual Studio Code dig att skriva över den befintliga filen eller skapa en kopia.

Distribuera Bicep-fil

Du kan distribuera Bicep-filer direkt från Visual Studio Code. Välj Distribuera Bicep-fil från kommandopaletten eller på snabbmenyn. Tillägget uppmanar dig att logga in i Azure, välja prenumeration, skapa/välja resursgrupp och ange parametervärden.

Kommentar

Bicep-distributionskommandot inifrån vscode använder Azure-kontotillägget för autentisering. Den använder inte molnprofiler från bicepconfig.json.

Generera parameterfil

Det här kommandot skapar en parameterfil i samma mapp som Bicep-filen. Du kan välja att skapa en Bicep-parameterfil eller en JSON-parameterfil. Det nya Bicep-parameterfilens namn är <bicep-file-name>.bicepparam, medan det nya JSON-parameterfilens namn är <bicep-file-name>.parameters.json.

Importera Kubernetes-manifest (förhandsversion)

Det här kommandot importerar en Kubernetes-manifestfil och skapar en Bicep-modul. Mer information finns i Kubernetes-providern för Bicep-utökningsbarhet och Snabbstart: Distribuera Azure-program till AKS-kluster (Azure Kubernetes Service) med Bicep Kubernetes-providern (förhandsversion).

Infoga resurs

Kommandot insert resource lägger till en resursdeklaration i Bicep-filen genom att ange resurs-ID för en befintlig resurs. När du har valt Infoga resurs anger du resurs-ID:t i kommandopaletten. Det tar en stund att infoga resursen.

Du hittar resurs-ID:t med någon av följande metoder:

Använd Azure Resource-tillägget för Visual Studio Code.
Använd Azure-portalen.
Använd Azure CLI eller Azure PowerShell:
- CLI
- PowerShell
```
az resource list
```
```
Get-AzResource
```

På samma sätt som när du exporterar mallar försöker processen skapa en användbar resurs. De flesta infogade resurser kräver dock vissa ändringar innan de kan användas för att distribuera Azure-resurser.

Mer information finns i Dela upp ARM-mallens JSON till Bicep.

Öppna Bicep-visualiseraren

Visualiseraren visar de resurser som definierats i Bicep-filen med resursberoendeinformationen. Diagrammet är visualiseringen av en Bicep-fil för en virtuell Linux-dator.

Du kan också öppna visualiseraren sida vid sida med Bicep-filen.

Återställa Bicep-moduler

När Bicep-filen använder moduler som publiceras i ett register hämtar återställningskommandot kopior av alla nödvändiga moduler från registret. Den lagrar dessa kopior i en lokal cache. Mer information finns i Återställa.

Visa typdokument

Från Visual Studio Code kan du öppna mallreferensen för den resurstyp som du arbetar med. Det gör du genom att hovra markören över resursens symboliska namn och sedan välja Visa typdokument.

Skärmbild av Visual Studio Code Bicep-visningstypdokument.

Gå till definition

När du definierar en modul, oavsett vilka typer av den refererade filen , oavsett om det är en lokal fil, modulregisterfil, mallspecifikation, kan du öppna den refererade filen genom att välja eller markera modulsökvägen och sedan trycka på [F12]. Om den refererade filen är en Azure Verified Modules (AVM) kan du växla mellan kompilerad JSON- eller Bicep-fil. För att kunna öppna Bicep-filen för en privat registermodul kontrollerar du att modulen publiceras i registret med växeln WithSource aktiverad. Mer information finns i Publicera filer till registret. Visual Studio Code Bicep-tillägget version 0.27.1 eller senare krävs för att öppna Bicep-filen från registret för privata moduler.

Klistra in som Bicep

Du kan klistra in ett JSON-kodfragment från en ARM-mall till Bicep-filen. Visual Studio Code dekompilerar automatiskt JSON till Bicep. Den här funktionen är endast tillgänglig med Bicep-tillägget version 0.14.0 eller senare. Den här funktionen aktiveras som standard. Information om hur du inaktiverar funktionen finns i VS Code- och Bicep-tillägget.

Med den här funktionen kan du klistra in:

Fullständiga ARM JSON-mallar.
Enskild resurs eller flera resurser.
JSON-värden, till exempel objekt, matriser och strängar. En sträng med dubbla citattecken konverteras till enkla citattecken.

Du kan till exempel börja med följande Bicep-fil:

@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

Klistra in följande 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 konverterar automatiskt JSON till Bicep. Observera att du också måste lägga till parametern med namnet batchAccountName.

Du kan ångra dekompileringen med hjälp av Ctrl+Z. Den ursprungliga JSON-filen visas i filen.

Nästa steg

En snabbstart finns i Snabbstart: Skapa Bicep-filer med Visual Studio Code.

Share via