Bicep-fájlok létrehozása a Visual Studio Code használatával

Cikk
07/18/2024

Ez a cikk bemutatja, hogyan hozhat létre Bicep-fájlokat a Visual Studio Code használatával.

A VS Code telepítése

A Bicep-fejlesztés környezetének beállításához tekintse meg a Bicep-eszközök telepítését. A lépések elvégzése után a Visual Studio Code és a Bicep bővítmény lesz a rendelkezésére. A legújabb Azure CLI-vel vagy a legújabb Azure PowerShell-modullal is rendelkezik.

Bicep-parancsok

A Visual Studio Code számos Bicep-parancsot tartalmaz.

Nyisson meg vagy hozzon létre egy Bicep-fájlt a VS Code-ban, válassza a Nézet menüt, majd válassza a Parancskatalógus lehetőséget. A parancskatalógus megjelenítéséhez használhatja az F1 billentyűkombinációt vagy a Ctrl+Shift+P billentyűkombinációt is. Írja be a Bicep parancsokat a Bicep-parancsok listázásához.

Képernyőkép a Visual Studio Code Bicep parancsairól a parancskatalógusban.

Ezek a parancsok a következők:

ARM-sablon létrehozása
Bicep-konfigurációs fájl létrehozása
Lebontás a Bicep-be
Bicep-fájl üzembe helyezése
Paraméterfájl létrehozása
Kubernetes-jegyzék importálása (előzetes verzió)
Erőforrás beszúrása
A Bicep Visualizer megnyitása
A Bicep Visualizer megnyitása oldalra
Bicep-modulok visszaállítása (kényszerítés)

Ezek a parancsok akkor is megjelennek a helyi menüben, ha a jobb gombbal egy Bicep-fájlra kattint:

Ha a jobb gombbal egy JSON-fájlra kattint:

ARM-sablon létrehozása

A build parancs egy Bicep-fájlt Azure Resource Manager-sablonná (ARM-sablonná) alakít át. Az új JSON-sablon ugyanabban a mappában van tárolva, ugyanazzal a fájlnévvel. Ha ugyanazzal a fájlnévvel rendelkező fájl létezik, felülírja a régi fájlt. További információ: Bicep CLI-parancsok.

Bicep-konfigurációs fájl létrehozása

A Bicep konfigurációs fájl (bicepconfig.json) segítségével testre szabhatja a Bicep fejlesztési élményét. Több könyvtárat is hozzáadhat bicepconfig.json . A címtárhierarchiában a bicep-fájlhoz legközelebbi konfigurációs fájlt használja a rendszer. Amikor kiválasztja ezt a parancsot, a bővítmény megnyílik egy párbeszédpanel, amelyen kijelölhet egy mappát. Az alapértelmezett mappa az, ahol a Bicep-fájlt tárolja. Ha már bicepconfig.json létezik fájl a mappában, felülírhatja a meglévő fájlt.

Bicep-konfigurációs fájl létrehozása:

Nyissa meg a Visual Studio Code-ot.
A Nézet menüben válassza a Parancskatalógus lehetőséget (vagy nyomja le a Ctrl/Cmd+Shift+P billentyűkombinációt), majd válassza a Bicep: Bicep konfigurációs fájl létrehozása lehetőséget.
Válassza ki azt a fájlkönyvtárat, ahová a fájlt el szeretné helyezni.
Ha elkészült, mentse a konfigurációs fájlt.

Lebontás a Bicep-be

Ez a parancs egy ARM JSON-sablont egy Bicep-fájlba bont, és ugyanabban a könyvtárban helyezi el, mint az ARM JSON-sablon. Az új fájl neve megegyezik a .bicep kiterjesztéssel. Ha egy azonos fájlnévvel rendelkező Bicep-fájl már létezik ugyanabban a mappában, a Visual Studio Code megkéri, hogy írja felül a meglévő fájlt, vagy hozzon létre egy másolatot.

Bicep-fájl üzembe helyezése

Bicep-fájlokat közvetlenül a Visual Studio Code-ból helyezhet üzembe. Válassza a Bicep-fájl üzembe helyezése lehetőséget a parancskatalógusból vagy a helyi menüből. A bővítmény kéri, hogy jelentkezzen be az Azure-ba, válassza ki az előfizetést, hozzon létre/válasszon erőforráscsoportot, és adja meg a paraméterértékeket.

Feljegyzés

A Bicep üzembe helyezési parancsa a vscode-on belülről az Azure-fiókbővítményt használja a hitelesítéshez. Nem használ felhőprofilokat bicepconfig.json.

Paraméterfájl létrehozása

Ez a parancs létrehoz egy paraméterfájlt a Bicep-fájllal megegyező mappában. Bicep-paraméterfájlt vagy JSON-paraméterfájlt is létrehozhat. Az új Bicep paraméterfájl neve <bicep-file-name>.bicepparam, míg az új JSON paraméterfájl neve .<bicep-file-name>.parameters.json

Kubernetes-jegyzék importálása (előzetes verzió)

Ez a parancs importál egy Kubernetes-jegyzékfájlt, és létrehoz egy Bicep-modult. További információ: Bicep bővíthetőségi Kubernetes-szolgáltató és rövid útmutató: Azure-alkalmazások üzembe helyezése az Azure Kubernetes Service -fürtön a Bicep Kubernetes-szolgáltató (előzetes verzió) használatával.

Erőforrás beszúrása

A insert resource parancs hozzáad egy erőforrás-deklarációt a Bicep-fájlhoz egy meglévő erőforrás erőforrás-azonosítójának megadásával. Miután kiválasztotta az Erőforrás beszúrása lehetőséget, adja meg az erőforrás-azonosítót a parancskatalógusban. Az erőforrás beszúrása néhány percet vesz igénybe.

Az erőforrás-azonosítót az alábbi módszerek egyikével találja meg:

Használja az Azure Resource-bővítményt a Visual Studio Code-hoz.
Használja az Azure Portalt.
Az Azure CLI vagy az Azure PowerShell használata:
- Parancssori felület
- PowerShell
```
az resource list
```
```
Get-AzResource
```

A sablonok exportálásához hasonlóan a folyamat egy használható erőforrást próbál létrehozni. A beszúrt erőforrások többsége azonban némi módosítást igényel az Azure-erőforrások üzembe helyezéséhez.

További információt az ARM-sablon JSON-ból Bicep-hez való lebontásáról talál.

Bicep-vizualizáció megnyitása

A vizualizáció a Bicep-fájlban definiált erőforrásokat jeleníti meg az erőforrás-függőségi adatokkal. A diagram egy Linux rendszerű Bicep-fájl vizualizációja.

A vizualizációt egymás mellett is megnyithatja a Bicep-fájllal.

Bicep-modulok visszaállítása

Amikor a Bicep-fájl egy beállításjegyzékben közzétett modulokat használ, a visszaállítási parancs lekéri az összes szükséges modul másolatát a beállításjegyzékből. Ezeket a másolatokat egy helyi gyorsítótárban tárolja. További információ: visszaállítás.

Típusdokumentum megtekintése

A Visual Studio Code-ból megnyithatja az éppen használt erőforrástípus sablonreferenciáját. Ehhez vigye a kurzort az erőforrás szimbolikus nevére, majd válassza a Nézet típusú dokumentum lehetőséget.

Képernyőkép a Visual Studio Code Bicep nézettípus dokumentumáról.

Ugrás a definícióra

Modul meghatározásakor a hivatkozott fájl típusától függetlenül – legyen az helyi fájl, modulregisztrációs fájl vagy sablon specifikáció – a hivatkozott fájlt a modul elérési útjának kiválasztásával vagy kiemelésével nyithatja meg, majd nyomja le az [F12] billentyűt. Ha a hivatkozott fájl egy Azure Verified Modules (AVM), válthat a lefordított JSON- vagy Bicep-fájlok között. Egy privát regisztrációs modul Bicep-fájljának megnyitásához győződjön meg arról, hogy a modul engedélyezve van a kapcsolóval a WithSource beállításjegyzékben. További információ: Fájlok közzététele a beállításjegyzékben. A Visual Studio Code Bicep 0.27.1-es vagy újabb verziójára van szükség a Bicep-fájl privát modulregisztrációs adatbázisból való megnyitásához.

Beillesztés Bicep-ként

Egy JSON-kódrészletet beilleszthet egy ARM-sablonból a Bicep-fájlba. A Visual Studio Code automatikusan lebontja a JSON-t a Bicepre. Ez a funkció csak a Bicep 0.14.0-s vagy újabb verziójával érhető el. Alapértelmezetten ez a funkció engedélyezett. A funkció letiltásához lásd a VS Code és a Bicep bővítményt.

Ezzel a funkcióval beillesztheti a következőt:

Teljes ARM JSON-sablonok.
Egy vagy több erőforrás.
JSON-értékek, például objektumok, tömbök és sztringek. A kettős idézőjeleket tartalmazó sztringek egyetlen idézőjelekké alakulnak.

Például a következő Bicep-fájllal kezdhet:

@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

Illessze be a következő JSON-t:

{
  "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'))]"
    }
  }
}

A Visual Studio Code automatikusan átalakítja a JSON-t Bicep-vé. Figyelje meg, hogy a névvel ellátott batchAccountNameparamétert is hozzá kell adnia.

A felbontást a Ctrl+Z billentyűkombinációval vonhatja vissza. Az eredeti JSON megjelenik a fájlban.

Hibaelhárítás

A Problems panel összefoglalja a Bicep-fájl hibáit és figyelmeztetéseit.

Képernyőkép a Visual Studio Code Bicep-problémák paneljéről.

A hiba-/figyelmeztetési kódok listáját a Bicep-hiba-/figyelmeztetési kódokban találja.

Következő lépések

A rövid útmutatót a Következő rövid útmutatóban tekintheti meg: Bicep-fájlok létrehozása a Visual Studio Code-tal.

Megosztás a következőn keresztül: