Quickstart: Create Bicep files with Visual Studio Code

Ez a rövid útmutató bemutatja, hogyan hozhat létre Bicep-fájlokat a Visual Studio Code használatával. Hozzon létre egy tárfiókot és egy virtuális hálózatot. Azt is megtudhatja, hogy a Bicep-bővítmény hogyan biztosít típusbiztonságot, szintaxis-ellenőrzést és automatikus kiegészítést a fejlesztés egyszerűsítése érdekében.

A Visual Studio hasonló szerzői élményt támogat. További információért tekintse meg a Rövid útmutatót: Bicep-fájlok létrehozása a Visual Studióval .

Előfeltételek

Ha nem rendelkezik Azure-előfizetéssel, a kezdés előtt hozzon létre egy ingyenes fiókot .

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 telepítve van a Visual Studio Code és a Bicep bővítmény . A legújabb Azure CLI-verzióval vagy az Azure PowerShell-modullal is rendelkezik.

Erőforrás-kódrészlet hozzáadása

A Visual Studio Code és a Bicep bővítmény előre definiált kódrészleteket biztosít a fejlesztés egyszerűsítése érdekében. Ebben a rövid útmutatóban hozzáad egy kódrészletet, amely létrehoz egy virtuális hálózatot.

Indítsa el a Visual Studio Code-ot, és hozzon létre egy main.bicep nevű új fájlt. A main.bicep-ben írja be vnet, válassza ki a res-vnet elemet a listából, majd nyomja le a TAB vagy az ENTER billentyűt.

Tip

Ha nem látja ezeket az IntelliSense-beállításokat a Visual Studio Code-ban, győződjön meg arról, hogy a Bicep-bővítményt az előfeltételekben megadott módon telepítette. Ha telepítette a bővítményt, adjon egy kis időt a Bicep nyelvi szolgáltatásnak a Bicep-fájl megnyitása után. Általában gyorsan indul el, és addig nem lesznek IntelliSense-opciók, amíg el nem indul. A jobb alsó sarokban lévő értesítés azt jelzi, hogy a szolgáltatás elindul. Amikor az értesítés eltűnik, a szolgáltatás fut.

A Bicep-fájl most a következő kódot tartalmazza:

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2019-11-01' = {
  name: 'name'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

Ebben a kódrészletben megtalálja a virtuális hálózat definiálásához szükséges összes értéket. You might notice two curly underlines. A sárga egy elavult API-verzióval kapcsolatos figyelmeztetést jelez, míg a piros görbült aláhúzás egy hiányzó paraméterdefiníció által okozott hibát jelez. The Bicep linter checks Bicep files for syntax errors and best practice violations. Vigye a kurzort a kurzor fölé @2019-11-01, és egy előugró ablaktábla a "Microsoft.Network/virtualNetworks" legújabb API-verziójának használatát jeleníti meg. Válassza a Gyorsjavítás lehetőséget az előugró panelen, majd az API-verzió frissítéséhez válassza a Csere 2024-05-01 verzióra lehetőséget.

Másik lehetőségként távolítsa el @2019-11-01, és cserélje le a helyére @. Válassza ki a legújabb API-verziót.

A következő szakaszban kijavíthatja a hiányzó paraméterdefiníciós hibát.

A kódot úgy is módosíthatja, hogy megfeleljen a követelményeknek. Mivel például name a virtuális hálózat nem egyértelmű neve, a name tulajdonságot exampleVneta következőre módosíthatja:

name: 'exampleVNet'

Paraméter hozzáadása

Az utolsó szakaszban hozzáadott kódrészlet nem rendelkezik paraméterdefinícióval, locationamint azt a piros görbületi aláhúzás jelzi. A fájl tetején adja hozzá a következőt:

param location

Amikor szóközt ad hozzá a location után, vegye észre, hogy az IntelliSense felajánlja a paraméterhez rendelkezésre álló adattípusokat. Válassza ki stringet.

Adja meg a paraméter alapértelmezett értékét:

param location string = resourceGroup().location

Az előző sor hozzárendeli az erőforráscsoport helyét a virtuális hálózati erőforráshoz. További információ az alapértelmezett értékben használt függvényről: resourceGroup().

A fájl tetején adjon hozzá egy másik paramétert a tárfiók nevéhez (amelyet a rövid útmutatóban később hoz létre) egy alapértelmezett értékkel:

param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

További információ: Interpoláció és uniqueString().

Ez a paraméter jól működik, de a tárfiókok a név hosszára korlátozottak. A névnek legalább 3, legfeljebb 24 karakter hosszúságúnak kell lennie. Ezeket a követelményeket úgy adhatja meg, hogy dekorátorokat ad hozzá a paraméterhez.

Adjon hozzá egy sort a paraméter fölé, és írja be a következőt @: You see the available decorators. Figyelje meg, hogy vannak dekorátorok a minLength és a maxLength esetében.

Adja hozzá mindkét díszítőt, és adja meg a karakterkorlátokat (például az alábbi 3-at és 24-et):

@minLength(3)
@maxLength(24)
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

A paraméter leírását is hozzáadhatja. Include information that helps people deploying the Bicep file to understand which value to provide:

@minLength(3)
@maxLength(24)
@description('Provide a name for the storage account. Use only lowercase letters and numbers. The name must be unique across Azure.')
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

A paraméterek használatra készek.

Erőforrás hozzáadása

A tárfiók definiálásához nem kódrészletet használ, hanem az IntelliSense használatával állítja be az értékeket. Az IntelliSense megkönnyíti ezt a lépést, mint az értékek manuális beírása.

Erőforrás meghatározásához használja a kulcsszót resource . Below your virtual network, type resource storageAccount:

resource storageAccount

storageAccount az üzembe helyezett erőforrás szimbolikus neve. Ezzel a névvel hivatkozhat az erőforrásra a Bicep-fájl más részeiben.

Ha a szimbolikus név után szóközt ad hozzá, megjelenik az erőforrástípusok listája. Folytassa a storageacc beírását, amíg ki nem választja az elérhető lehetőségek közül.

A Microsoft.Storage/storageAccounts kiválasztása után megjelennek az elérhető API-verziók. Válassza ki a legújabb verziót. A következő képernyőkép: 2023-05-01.

Az erőforrástípus egyetlen idézőjele után adjon hozzá = egy szóközt. Megjelenik a tulajdonságok erőforráshoz való hozzáadásának lehetőségei. Válassza ki a szükséges tulajdonságokat.

Ez a beállítás hozzáadja az üzembe helyezéshez szükséges erőforrástípus összes tulajdonságát. A beállítás kiválasztása után a tárfiók a következő tulajdonságokkal rendelkezik:

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-05-01' = {
  name:
  location:
  sku: {
    name:
  }
  kind:
}

Már majdnem elkészült, a következő lépés pedig az, hogy értékeket adjon meg ezekhez a tulajdonságokhoz.

Az IntelliSense ismét segít. Állítsa be a name értékét storageAccountName-ra, amely az a paraméter, amely a tárolási fiók nevét tartalmazza. A location esetén állítsa azt a location értékre, amely egy korábban létrehozott paraméter. A sku.name és kind hozzáadásakor az IntelliSense megjeleníti az érvényes beállításokat.

Ha nem kötelező tulajdonságokat szeretne hozzáadni a szükséges tulajdonságok mellett, helyezze a kurzort a kívánt helyre, és nyomja le a Ctrl Szóköz+. Az alábbi képernyőképen látható, hogyan javasolja az IntelliSense az elérhető tulajdonságokat:

Ha befejezte, a következőket kapja:

@minLength(3)
@maxLength(24)
@description('Provide a name for the storage account. Use only lowercase letters and numbers. The name must be unique across Azure.')
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'
param location string = resourceGroup().location

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2024-05-01' = {
  name: 'exampleVNet'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

resource storageAccount 'Microsoft.Storage/storageAccounts@2023-05-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
}

A Bicep szintaxisával kapcsolatos további információkért lásd a Bicep fájlstruktúráját és szintaxisát.

Erőforrások vizualizációja

A Bicep Visualizer megjeleníti a fájlban lévő erőforrások grafikus ábrázolását.

Az eszköz megnyitásához válassza a Bicep Visualizer gombot a jobb felső sarokban:

Ez a vizualizáció a Bicep-fájlban definiált erőforrásokat és a függőségeik közötti összekötőket jeleníti meg. Az ebben a rövid útmutatóban definiált két erőforrás nem függ egymástól, ezért nincs közöttük összekötő:

Deploy the Bicep file

1. Kattintson a jobb gombbal a Bicep-fájlra a Visual Studio Code-ban, majd válassza a Bicep-fájl üzembe helyezése lehetőséget.

   

2. Írja be az üzembehelyezési szövegmezőbe a DeployStorageAndVNet nevet, majd nyomja le az ENTER billentyűt.

   

3. A felső Erőforráscsoport kiválasztása listamezőben válassza az Új erőforráscsoport létrehozása lehetőséget.

4. Adja meg a exampleRG nevet az erőforráscsoport neveként, majd nyomja le az ENTER billentyűt.

5. Válassza ki az erőforráscsoport helyét, válassza az USA középső régióját vagy egy tetszőleges helyet, majd nyomja le az ENTER billentyűt.

6. A Paraméterfájl kiválasztása területen válassza a Nincs lehetőséget.

Az erőforrások létrehozása néhány percet vesz igénybe. További információ: Bicep-fájlok üzembe helyezése a Visual Studio Code-ban.

Az Azure CLI-vel vagy az Azure PowerShell-lel is üzembe helyezheti a Bicep-fájlt:

Azure CLI

az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters storageAccountName=uniquename

Azure PowerShell

New-AzResourceGroup -Name exampleRG -Location eastus

New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep -storageAccountName "uniquename"

Amikor az üzembe helyezés befejeződik, látnia kell egy üzenetet, amely leírja, hogy az üzembe helyezés sikeres volt.

Az erőforrások tisztítása

Ha az Azure-erőforrásokra már nincs szükség, az Azure CLI vagy az Azure PowerShell modul használatával törölje a quickstart erőforráscsoportját.

Azure CLI

az group delete --name exampleRG

Azure PowerShell

Remove-AzResourceGroup -Name exampleRG

Következő lépések

Ismerkedjen meg a Bicep Learn-moduljaival.