Tworzenie plików Bicep przy użyciu Visual Studio Code
W tym artykule pokazano, jak używać Visual Studio Code do tworzenia plików Bicep.
Instalowanie programu VS Code
Aby skonfigurować środowisko na potrzeby opracowywania aplikacji Bicep, zobacz Instalowanie narzędzi Bicep. Po wykonaniu tych kroków będziesz mieć Visual Studio Code i rozszerzenie Bicep. Masz również najnowszy interfejs wiersza polecenia platformy Azure lub najnowszy moduł Azure PowerShell.
Polecenia Bicep
Visual Studio Code zawiera kilka poleceń Bicep.
Otwórz lub utwórz plik Bicep w programie VS Code, wybierz menu Widok , a następnie wybierz pozycję Paleta poleceń. Możesz również użyć klawisza F1 lub kombinacji klawiszy Ctrl+Shift+P , aby wyświetlić paletę poleceń. Wpisz Bicep , aby wyświetlić listę poleceń Bicep.
Są to:
- Tworzenie szablonu usługi ARM
- Tworzenie pliku konfiguracji Bicep
- Dekompiluj do Bicep
- Wdrażanie pliku Bicep
- Generowanie pliku parametrów
- Importowanie manifestu kubernetes (wersja zapoznawcza)
- Wstaw zasób
- Otwórz program Bicep Visualizer
- Otwórz program Bicep Visualizer po stronie
- Przywracanie modułów Bicep (wymuś)
Te polecenia są również wyświetlane w menu kontekstowym po kliknięciu prawym przyciskiem myszy pliku Bicep:
Po kliknięciu prawym przyciskiem myszy pliku JSON:
Tworzenie szablonu usługi ARM
Polecenie build konwertuje plik Bicep na szablon usługi Azure Resource Manager (szablon usługi ARM). Nowy szablon JSON jest przechowywany w tym samym folderze o tej samej nazwie pliku. Jeśli plik o tej samej nazwie pliku istnieje, zastępuje stary plik. Aby uzyskać więcej informacji, zobacz polecenia interfejsu wiersza polecenia Bicep.
Tworzenie pliku konfiguracji Bicep
Plik konfiguracji Bicep (bicepconfig.json) może służyć do dostosowywania środowiska programistycznego Bicep. Możesz dodać bicepconfig.json wiele katalogów. Używany jest plik konfiguracji najbliżej pliku bicep w hierarchii katalogów. Po wybraniu tego polecenia rozszerzenie otwiera okno dialogowe umożliwiające wybranie folderu. Folder domyślny to miejsce, w którym jest przechowywany plik Bicep. bicepconfig.json Jeśli plik już istnieje w folderze, możesz zastąpić istniejący plik.
Aby utworzyć plik konfiguracji Bicep:
- Otwórz program Visual Studio Code.
- W menu Widok wybierz pozycję Paleta poleceń (lub naciśnij klawisze Ctrl/Cmd+Shift+P), a następnie wybierz pozycję Bicep: Utwórz plik konfiguracji Bicep.
- Wybierz katalog plików, w którym chcesz umieścić plik.
- Zapisz plik konfiguracji po zakończeniu.
Dekompiluj do Bicep
To polecenie dekompiluje szablon JSON usługi ARM do pliku Bicep i umieszcza go w tym samym katalogu co szablon JSON usługi ARM. Nowy plik ma taką samą nazwę pliku z rozszerzeniem bicep . Jeśli plik Bicep o tej samej nazwie już istnieje w tym samym folderze, Visual Studio Code monituje o zastąpienie istniejącego pliku lub utworzenie kopii.
Wdrażanie pliku Bicep
Pliki Bicep można wdrażać bezpośrednio z Visual Studio Code. Wybierz pozycję Wdróż plik Bicep z palety poleceń lub z menu kontekstowego. Rozszerzenie monituje o zalogowanie się na platformie Azure, wybieranie subskrypcji, tworzenie/wybieranie grupy zasobów i wprowadzanie wartości parametrów.
Uwaga
Polecenie Bicep deploy z poziomu programu vscode używa rozszerzenia konta platformy Azure do uwierzytelniania. Nie używa ona profilów chmury z pliku bicepconfig.json.
Generowanie pliku parametrów
To polecenie tworzy plik parametrów w tym samym folderze co plik Bicep. Możesz utworzyć plik parametru Bicep lub plik parametrów JSON. Nowa nazwa pliku parametru Bicep to <bicep-file-name>.bicepparam, a nowa nazwa pliku parametru JSON to <bicep-file-name>.parameters.json.
Importowanie manifestu kubernetes (wersja zapoznawcza)
To polecenie importuje plik manifestu Kubernetes i tworzy moduł Bicep. Aby uzyskać więcej informacji, zobacz Dostawca kubernetes rozszerzalności Bicep i Szybki start: wdrażanie aplikacji platformy Azure w klastrze Azure Kubernetes Service (AKS) przy użyciu dostawcy Bicep Kubernetes (wersja zapoznawcza).
Wstaw zasób
Polecenie insert resource dodaje deklarację zasobu w pliku Bicep, podając identyfikator zasobu istniejącego zasobu. Po wybraniu pozycji Wstaw zasób wprowadź identyfikator zasobu w palecie poleceń. Wstaw zasób może potrwać kilka minut.
Identyfikator zasobu można znaleźć przy użyciu jednej z następujących metod:
Użyj rozszerzenia usługi Azure Resource dla Visual Studio Code.
Użyj witryny Azure Portal.
Użyj interfejsu wiersza polecenia platformy Azure lub Azure PowerShell:
az resource list
Podobnie jak w przypadku eksportowania szablonów, proces próbuje utworzyć zasób do użycia. Jednak większość wstawionych zasobów wymaga pewnych modyfikacji, zanim będzie można ich używać do wdrażania zasobów platformy Azure.
Aby uzyskać więcej informacji, zobacz Decompiling ARM template JSON to Bicep (Dekompiling ARM template JSON to Bicep).
Otwórz wizualizator Bicep
Wizualizator przedstawia zasoby zdefiniowane w pliku Bicep z informacjami o zależnościach zasobów. Diagram przedstawia wizualizację pliku Bicep maszyny wirtualnej z systemem Linux.
Możesz również otworzyć wizualizatora obok pliku Bicep.
Przywracanie modułów Bicep
Gdy plik Bicep używa modułów publikowanych w rejestrze, polecenie przywracania pobiera kopie wszystkich wymaganych modułów z rejestru. Przechowuje te kopie w lokalnej pamięci podręcznej. Aby uzyskać więcej informacji, zobacz przywracanie.
Wyświetlanie dokumentu typu
W Visual Studio Code możesz łatwo otworzyć odwołanie do szablonu dla typu zasobu, nad którym pracujesz. W tym celu umieść kursor nad nazwą symboliczną zasobu, a następnie wybierz pozycję Wyświetl typ dokumentu.
Wklej jako Bicep
Możesz wkleić fragment kodu JSON z szablonu usługi ARM do pliku Bicep. Visual Studio Code automatycznie dekompiluje kod JSON na Bicep. Ta funkcja jest dostępna tylko w przypadku rozszerzenia Bicep w wersji 0.14.0 lub nowszej. Ta funkcja jest domyślnie włączona. Aby wyłączyć tę funkcję, zobacz rozszerzenie VS Code i Bicep.
Za pomocą tej funkcji można wkleić:
- Pełne szablony JSON usługi ARM.
- Pojedynczy zasób lub wiele zasobów.
- Wartości JSON, takie jak obiekty, tablice i ciągi. Ciąg z cudzysłowami podwójnymi jest konwertowany na apostrofy.
Na przykład możesz rozpocząć od następującego pliku 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
Następnie wklej następujący kod 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 automatycznie konwertuje kod JSON na wartość Bicep. Zwróć uwagę, że należy również dodać parametr o nazwie batchAccountName.
Dekompilację można cofnąć za pomocą klawiszy Ctrl+Z. Oryginalny kod JSON pojawia się w pliku .
Następne kroki
Aby zapoznać się z przewodnikiem Szybki start, zobacz Szybki start: tworzenie plików Bicep przy użyciu Visual Studio Code.