Tworzenie plików Bicep przy użyciu programu Visual Studio Code
W tym artykule pokazano, jak używać programu Visual Studio Code do tworzenia plików Bicep.
Instalowanie programu VS Code
Aby skonfigurować środowisko na potrzeby programowania aplikacji Bicep, zobacz Instalowanie narzędzi Bicep. Po wykonaniu tych kroków będziesz mieć program Visual Studio Code i rozszerzenie Bicep. Masz również najnowszy interfejs wiersza polecenia platformy Azure lub najnowszy moduł programu Azure PowerShell.
Polecenia Bicep
Program Visual Studio Code zawiera kilka poleceń Bicep.
Otwórz lub utwórz plik Bicep w programie VS Code, wybierz menu Widok , a następnie pozycję Paleta poleceń. Możesz również użyć F1 lub kombinacji Ctrl+Shift+P , aby wyświetlić paletę poleceń. Wpisz Bicep , aby wyświetlić listę poleceń Bicep.
Te polecenia obejmują:
- Kompilowanie szablonu usługi ARM
- Plik parametrów kompilacji
- Tworzenie pliku konfiguracji Bicep
- Dekompiluj do Bicep
- Wdrażanie pliku Bicep
- Generowanie pliku parametrów
- Importowanie manifestu platformy Kubernetes (wersja zapoznawcza)
- Wstaw zasób
- Otwórz narzędzie Bicep Visualizer
- Otwórz narzędzie Bicep Visualizer po stronie
- Wklej kod JSON jako Bicep
- Przywracanie modułów Bicep (Force)
- Pokaż okienko wdrożenia
- Pokaż okienko wdrożenia po stronie
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 istnieje, zastępuje stary plik. Aby uzyskać więcej informacji, zobacz polecenia interfejsu wiersza polecenia Bicep.
Plik parametrów kompilacji
Polecenie build konwertuje plik parametrów Bicep na plik parametrów JSON. Nowy plik parametrów JSON jest przechowywany w tym samym folderze o tej samej nazwie pliku. Jeśli plik o tej samej nazwie 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 deweloperów 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 przechowywania pliku Bicep. bicepconfig.json Jeśli plik już istnieje w folderze, możesz zastąpić istniejący plik.
Aby utworzyć plik konfiguracji Bicep:
- Otwórz Visual Studio Code.
- W menu Widok wybierz pozycję Paleta poleceń (lub naciśnij 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 tę samą nazwę pliku z rozszerzeniem bicep . Jeśli plik Bicep o tej samej nazwie już istnieje w tym samym folderze, program Visual Studio Code wyświetli monit o zastąpienie istniejącego pliku lub utworzenie kopii.
Wdrażanie pliku Bicep
Pliki Bicep można wdrażać bezpośrednio z poziomu programu Visual Studio Code. Wybierz pozycję Wdróż plik Bicep z palety poleceń lub z menu kontekstowego. Rozszerzenie wyświetla monit o zalogowanie się na platformie Azure, wybranie subskrypcji, utworzenie/wybranie grupy zasobów i wprowadzenie wartości parametrów.
Uwaga
Polecenie Bicep deploy w programie Visual Studio Code używa nowego wbudowanego interfejsu API uwierzytelniania do zarządzania uwierzytelnianiem. Nie używa profilów chmury z bicepconfig.json. Aby zalogować się do chmury niestandardowej, wybierz pozycję Zarządzaj>>rozszerzeniami>>Microsoft Accounts Microsoft Sovereign Cloud. Obecnie wiele kont zalogowanych nie jest obsługiwanych.
Generowanie pliku parametrów
To polecenie tworzy plik parametrów w tym samym folderze co plik Bicep. Możesz utworzyć plik parametrów Bicep lub plik parametrów JSON. Nowa nazwa pliku parametrów Bicep to <bicep-file-name>.bicepparam, a nowa nazwa pliku parametrów JSON to <bicep-file-name>.parameters.json.
Importowanie manifestu platformy Kubernetes (wersja zapoznawcza)
To polecenie importuje plik manifestu kubernetes i tworzy moduł Bicep. Aby uzyskać więcej informacji, zobacz Dostawca rozszerzenia Kubernetes Bicep i Szybki start: wdrażanie aplikacji platformy Azure w klastrze usługi 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ń. Wstawienie zasobu może potrwać kilka minut.
Identyfikator zasobu można znaleźć przy użyciu jednej z następujących metod:
Użyj rozszerzenia zasobów platformy Azure dla programu Visual Studio Code.
Użyj witryny Azure Portal.
Użyj interfejsu wiersza polecenia platformy Azure lub programu Azure PowerShell:
az resource list
Podobnie jak w przypadku eksportowania szablonów, proces próbuje utworzyć dostępny zasób. Jednak większość wstawionych zasobów wymaga pewnych modyfikacji, zanim będzie można ich użyć do wdrożenia zasobów platformy Azure.
Aby uzyskać więcej informacji, zobacz Decompiling ARM template JSON to Bicep (Decompiling ARM template JSON to Bicep).
Otwórz wizualizator Bicep
Wizualizator pokazuje zasoby zdefiniowane w pliku Bicep z informacjami o zależności zasobów. Diagram przedstawia wizualizację pliku Bicep maszyny wirtualnej z systemem Linux.
Możesz również otworzyć wizualizator obok pliku Bicep.
Wklej jako Bicep
Fragment kodu JSON można wkleić z szablonu usługi ARM do pliku Bicep. Program Visual Studio Code automatycznie dekompiluje kod JSON do Bicep. Ta funkcja jest dostępna tylko w przypadku rozszerzenia Bicep w wersji 0.14.0 lub nowszej i jest domyślnie włączona. Aby wyłączyć tę funkcję, zobacz Rozszerzenie VS Code i Bicep.
Korzystając z tej funkcji, możesz wkleić następujące elementy:
- 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 podwójnymi cudzysłowami konwertuje na jeden z pojedynczym cudzysłowem.
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@2023-04-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": "2024-02-01",
"name": "[parameters('batchAccountName')]",
"location": "[parameters('location')]",
"tags": {
"ObjectName": "[parameters('batchAccountName')]"
},
"properties": {
"autoStorage": {
"storageAccountId": "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]"
}
}
}
Program Visual Studio Code automatycznie konwertuje kod JSON na Bicep. Zwróć uwagę, że należy również dodać parametr o nazwie batchAccountName.
Dekompilacji można cofnąć za pomocą Ctrl+Z. Oryginalny kod JSON pojawia się w pliku .
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.
Pokaż okienko wdrażania
Okienko wdrażania Bicep jest funkcją eksperymentalną. Aby uzyskać więcej informacji, zobacz Using the Deployment Pane (Korzystanie z okienka wdrażania).
Możesz również otworzyć okienko wdrażania obok pliku Bicep.
Wyświetl dokumentację
W programie Visual Studio Code możesz otworzyć odwołanie do szablonu dla typu zasobu, nad którym pracujesz. W tym celu umieść kursor na nazwie symbolicznej zasobu, a następnie wybierz pozycję Wyświetl dokumentację.
Przejdź do definicji
Podczas definiowania modułu i niezależnie od typu przywoływanego pliku — niezależnie od tego, czy jest to plik lokalny, plik rejestru modułu, czy specyfikacja szablonu — możesz otworzyć plik, wybierając lub wyróżniając ścieżkę modułu, a następnie naciskając [F12]. Jeśli przywołany plik jest zweryfikowanym modułem platformy Azure (AVM), możesz przełączać się między skompilowanym plikiem JSON lub Bicep. Aby otworzyć plik Bicep prywatnego modułu rejestru, upewnij się, że moduł został opublikowany w rejestrze z włączonym przełącznikiem WithSource . Aby uzyskać więcej informacji, zobacz Publikowanie plików w rejestrze. Rozszerzenie Bicep programu Visual Studio Code w wersji 0.27.1 lub nowszej jest wymagane do otwierania plików Bicep z rejestru modułów prywatnych.
Rozwiązywanie problemów
Okienko Problems zawiera podsumowanie błędów i ostrzeżeń w pliku Bicep:
Aby uzyskać listę kodów błędów/ostrzeżeń, zobacz Kody błędów/ostrzeżeń Bicep.
Następne kroki
Aby zapoznać się z samouczkiem szybki start, zobacz Szybki start: tworzenie plików Bicep za pomocą programu Visual Studio Code.