Vytváření souborů Bicep pomocí editoru Visual Studio Code

Článek
06/17/2023

V tomto článku se dozvíte, jak pomocí editoru Visual Studio Code vytvářet soubory Bicep.

Instalace VSCode

Informace o nastavení prostředí pro vývoj bicep najdete v tématu Instalace nástrojů Bicep. Po dokončení těchto kroků budete mít Visual Studio Code a rozšíření Bicep. Máte také nejnovější Azure CLI nebo nejnovější modul Azure PowerShell.

Příkazy Bicep

Visual Studio Code se dodává s několika příkazy Bicep.

Otevřete nebo vytvořte soubor Bicep v nástroji VS Code, vyberte nabídku View (Zobrazení ) a pak vyberte Command Palette (Paleta příkazů). K vyvolání palety příkazů můžete použít také klávesu F1 nebo kombinaci kláves Ctrl+Shift+P . Příkazy Bicep zobrazíte zadáním příkazu Bicep .

Snímek obrazovky s příkazy Bicep editoru Visual Studio Code na paletě příkazů

Jedná se například o tyto příkazy:

Sestavení šablony ARM
Vytvoření konfiguračního souboru Bicep
Dekompilovat do bicepu
Nasazení souboru Bicep
Vygenerovat soubor parametrů
Import manifestu Kubernetes (Preview)
Vložit zdroj
Otevření vizualizéru Bicep
Otevření vizualizéru Bicep na straně
Obnovení modulů Bicep (vynucení)

Tyto příkazy se také zobrazí v místní nabídce, když kliknete pravým tlačítkem na soubor Bicep:

Když kliknete pravým tlačítkem na soubor JSON:

Sestavení šablony ARM

Příkaz build převede soubor Bicep na šablonu Azure Resource Manager (šablonu ARM). Nová šablona JSON je uložená ve stejné složce se stejným názvem souboru. Pokud existuje soubor se stejným názvem, přepíše starý soubor. Další informace najdete v tématu Příkazy rozhraní příkazového řádku Bicep.

Vytvoření konfiguračního souboru Bicep

Konfigurační soubor Bicep (bicepconfig.json) můžete použít k přizpůsobení vývojového prostředí Bicep. Můžete přidat bicepconfig.json více adresářů. Použije se konfigurační soubor, který je nejblíže souboru bicep v hierarchii adresářů. Když vyberete tento příkaz, rozšíření otevře dialogové okno pro výběr složky. Výchozí složka je místo, kam ukládáte soubor Bicep. bicepconfig.json Pokud už soubor ve složce existuje, můžete existující soubor přepsat.

Vytvoření konfiguračního souboru Bicep:

Otevřete Visual Studio Code.
V nabídce View (Zobrazení ) vyberte Command Palette (nebo stiskněte Ctrl/Cmd+Shift+P) a pak vyberte Bicep: Create Bicep Configuration File (Vytvořit konfigurační soubor Bicep).
Vyberte adresář souborů, do kterého chcete soubor umístit.
Až budete hotovi, konfigurační soubor uložte.

Dekompilovat do bicepu

Tento příkaz dekompiliuje šablonu ARM JSON do souboru Bicep a umístí ji do stejného adresáře jako šablona ARM JSON. Nový soubor má stejný název s příponou .bicep . Pokud už ve stejné složce existuje soubor Bicep se stejným názvem, visual Studio Code vás vyzve k přepsání existujícího souboru nebo vytvoření kopie.

Nasazení souboru Bicep

Soubory Bicep můžete nasadit přímo z editoru Visual Studio Code. Na paletě příkazů nebo v místní nabídce vyberte Deploy Bicep file (Nasadit soubor Bicep ). Rozšíření vás vyzve k přihlášení do Azure, výběru předplatného, vytvoření/výběru skupiny prostředků a zadání hodnot parametrů.

Poznámka

Příkaz Bicep deploy z vscode používá k ověřování rozšíření Azure Account . Nepoužívá cloudové profily z souboru bicepconfig.json.

Vygenerovat soubor parametrů

Tento příkaz vytvoří soubor parametrů ve stejné složce jako soubor Bicep. Můžete vytvořit soubor parametrů Bicep nebo soubor parametrů JSON. Nový soubor parametrů Bicep má <bicep-file-name>.bicepparamnázev , zatímco nový soubor parametrů JSON je <bicep-file-name>.parameters.json.

Import manifestu Kubernetes (Preview)

Tento příkaz naimportuje soubor manifestu Kubernetes a vytvoří modul Bicep. Další informace najdete v tématech Poskytovatel rozšiřitelnosti Bicep Kubernetes a Rychlý start: Nasazení aplikací Azure do clusteru Azure Kubernetes Service (AKS) pomocí zprostředkovatele Kubernetes Bicep (Preview).

Vložit prostředek

Příkaz insert resource přidá deklaraci prostředku do souboru Bicep zadáním ID existujícího prostředku. Po výběru možnosti Vložit prostředek zadejte ID prostředku na paletě příkazů. Vložení prostředku chvíli trvá.

ID prostředku můžete zjistit pomocí jedné z těchto metod:

Použijte rozšíření Azure Resource pro Visual Studio Code.
Použijete Azure Portal
Použijte Azure CLI nebo Azure PowerShell:
- Rozhraní příkazového řádku
- PowerShell
```
az resource list
```
```
Get-AzResource
```

Podobně jako při exportu šablon se proces pokusí vytvořit použitelný prostředek. Většina vložených prostředků ale před nasazením prostředků Azure vyžaduje určité úpravy.

Další informace najdete v tématu Dekompilace JSON šablony ARM do Bicep.

Otevření vizualizéru Bicep

Vizualizér zobrazí prostředky definované v souboru Bicep s informacemi o závislostech prostředků. Diagram je vizualizace souboru Bicep virtuálního počítače s Linuxem.

Vizualizér můžete otevřít také vedle souboru Bicep.

Obnovení modulů Bicep

Když soubor Bicep používá moduly, které jsou publikované v registru, získá příkaz restore z registru kopie všech požadovaných modulů. Tyto kopie ukládá do místní mezipaměti. Další informace najdete v tématu obnovení.

Dokument typu zobrazení

V editoru Visual Studio Code můžete snadno otevřít referenční informace k šabloně pro typ prostředku, na kterém pracujete. Uděláte to tak, že najedete myší na symbolický název prostředku a vyberete Zobrazit typ dokumentu.

Snímek obrazovky s dokumentem typu zobrazení Bicep v editoru Visual Studio Code

Vložit jako Bicep

Fragment kódu JSON můžete vložit ze šablony ARM do souboru Bicep. Visual Studio Code automaticky dekompiliuje JSON na Bicep. Tato funkce je k dispozici pouze s rozšířením Bicep verze 0.14.0 nebo novější. Tato funkce je ve výchozím nastavení povolená. Pokud chcete tuto funkci zakázat, přečtěte si téma Rozšíření VS Code a Bicep.

Pomocí této funkce můžete vložit:

Úplné šablony ARM JSON
Jeden nebo více prostředků.
Hodnoty JSON, jako jsou objekty, pole a řetězce. Řetězec s dvojitými uvozovkami se převede na jednoduché uvozovky.

Můžete například začít s následujícím souborem Bicep:

@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

A vložte následující kód 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 automaticky převede JSON na Bicep. Všimněte si, že je potřeba přidat také parametr s názvem batchAccountName.

Dekompilace můžete vrátit zpět pomocí kombinace kláves Ctrl+Z. V souboru se zobrazí původní json.

Další kroky

Projděte si rychlý start v tématu Rychlý start: Vytváření souborů Bicep pomocí editoru Visual Studio Code.