Tworzenie plików Bicep za pomocą programu Visual Studio Code

W tym artykule pokazano, jak używać programu Visual Studio Code do tworzenia plików Bicep.

Instalowanie programu Visual Studio Code

Aby skonfigurować środowisko na potrzeby programowania aplikacji Bicep, zobacz Instalowanie narzędzi Bicep. Po wykonaniu tych kroków masz zainstalowany 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 wbudowanych poleceń Bicep.

Otwórz lub utwórz plik Bicep w programie Visual Studio Code, a następnie wybierz menu Widok, a potem Paleta poleceń. Możesz również nacisnąć F1 lub kombinację Ctrl+Shift+P , aby wyświetlić paletę poleceń. Wprowadź Bicep, aby wyświetlić listę poleceń Bicep.

Te polecenia obejmują:

• Tworzenie szablonu usługi Azure Resource Manager (ARM)
• Plik parametrów kompilacji
• Tworzenie pliku konfiguracji Bicep
• Dekompiluj do Bicep
• Wdrażanie pliku Bicep
• Generowanie pliku parametrów
• Importowanie manifestu usługi Azure Kubernetes (EKSPERYMENTALNE)
• 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 z boku

Te polecenia są również wyświetlane w menu kontekstowym po kliknięciu prawym przyciskiem myszy pliku Bicep:

A po kliknięciu prawym przyciskiem myszy pliku JSON:

Aby dowiedzieć się więcej na temat poleceń w tym artykule, zapoznaj się z poleceniami Bicep CLI.

Oprócz poleceń Bicep można również użyć wbudowanych poleceń programu VS Code, takich jak Format Documents, lub Shift+Alt+F.

Komenda budowania szablonu ARM

Polecenie build konwertuje plik Bicep na szablon arm JSON. Nowy szablon jest przechowywany w tym samym folderze o tej samej nazwie pliku. Jeśli plik o tej samej nazwie istnieje, zastępuje stary plik. Zobacz kompilację , aby uzyskać przykład i więcej informacji.

Polecenie Build Parameters File (Plik parametrów kompilacji)

Polecenie build-params konwertuje również plik parametrów Bicep na plik parametrów JSON. Nowy plik parametrów jest przechowywany w tym samym folderze o tej samej nazwie pliku. Jeśli plik o tej samej nazwie istnieje, zastępuje stary plik. Zobacz build-params dla przykładu.

Polecenie Create Bicep Configuration File (Utwórz plik konfiguracji Bicep)

Plik bicepconfig.json jest plikiem konfiguracji Bicep, który może spersonalizować doświadczenie deweloperskie Bicep. Można dodać bicepconfig.json do wielu katalogów; używany jest plik konfiguracji najbliżej pliku Bicep w hierarchii katalogów. Po wybraniu opcji Utwórz plik konfiguracyjny Bicep w programie Visual Studio Code, rozszerzenie otworzy okno dialogowe, abyś mógł wybrać folder. Folder domyślny to miejsce przechowywania pliku Bicep. Jeśli plik bicepconfig.json już istnieje w folderze, możesz zastąpić istniejący plik.

Aby utworzyć plik konfiguracji Bicep:

1. Otwórz Visual Studio Code.
2. W menu Widok wybierz pozycję Paleta poleceń (lub naciśnij Ctrl/Cmd+Shift+P), a następnie pozycję Bicep: Utwórz plik konfiguracji Bicep.
3. Wybierz katalog plików, w którym chcesz umieścić plik.
4. Zapisz plik konfiguracji po zakończeniu.

Dekompiluj do formatu polecenia Bicep

Polecenie decompile dekompiluje szablon usługi ARM w formacie JSON do pliku Bicep i umieszcza go w tym samym katalogu co oryginalny szablon usługi ARM JSON. Nowy plik ma taką samą nazwę pliku z .bicep rozszerzeniem . 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. Zobacz przykład dekompilacji.

Polecenie wdrażania 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ę do witryny Azure Portal, wybranie subskrypcji, utworzenie lub 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 Zarządzaj>Ustawienia>Rozszerzenie>Konta Microsoft>Microsoft Sovereign Cloud. Obecnie wiele kont zalogowanych nie jest obsługiwanych.

Polecenie Generate Parameters File (Generowanie pliku parametrów)

Polecenie generate-params 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. Zobacz generowanie parametrów , aby uzyskać przykład i więcej informacji.

Importowanie manifestu usługi AKS (wersja zapoznawcza)

To polecenie importuje plik manifestu usługi AKS i tworzy moduł Bicep. Aby uzyskać więcej informacji, zobacz Rozszerzenie Bicep Kubernetes (wersja zapoznawcza) i Szybki start: wdrażanie klastra usługi Azure Kubernetes Service (AKS) przy użyciu rozszerzenia Bicep Kubernetes (wersja zapoznawcza).

Polecenie Wstaw zasób

To polecenie deklaruje zasób w pliku Bicep, podając identyfikator istniejącego zasobu. Wybierz pozycję Wstaw zasób w programie Visual Studio Code i wprowadź identyfikator zasobu w palecie poleceń. Wstawienie zasobu może potrwać kilka minut.

Aby znaleźć identyfikator zasobu, możesz użyć jednej z następujących metod:

• Użyj rozszerzenia Zasobów platformy Azure dla programu Visual Studio Code.

  

• Sprawdź witrynę Azure Portal.

• Użyj interfejsu wiersza polecenia platformy Azure lub programu Azure PowerShell:

  Interfejs wiersza polecenia platformy Azure

  az resource list
  

  Azure PowerShell

  Get-AzResource
  

---

Podobnie jak w przypadku procesu eksportowania szablonów, ten proces próbuje utworzyć zasób do użycia. Jednak większość wstawionych zasobów należy zmienić w jakiś sposób, zanim będzie można ich użyć do wdrożenia zasobów platformy Azure. Aby uzyskać więcej informacji, zobacz Dekompilowanie szablonu ARM z JSON do Bicep.

Otwórz komendę Bicep Visualizer

Narzędzie Bicep Visualizer pokazuje zasoby zdefiniowane w pliku Bicep i zależności między nimi. Na poniższym diagramie przedstawiono wizualną reprezentację pliku Bicep dla maszyny wirtualnej z systemem Linux.

Możesz otworzyć narzędzie Bicep Visualizer obok pliku Bicep.

Wklej JSON jako komendę Bicep

Można wkleić fragment kodu JSON z szablonu ARM do pliku Bicep. Program Visual Studio Code automatycznie dekompiluje plik 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 Visual Studio Code i rozszerzenie Bicep.

Ta funkcja umożliwia wklejanie:

• Pełne szablony ARM w JSON.
• Pojedyncze lub wiele zasobów.
• Wartości JSON, takie jak obiekty, tablice lub ciągi. Ciąg znaków z podwójnymi cudzysłowami zmienia się na ciąg 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

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ć batchAccountName parametr.

Można cofnąć dekompilacji, naciskając Ctrl+Z. Oryginalny kod JSON pojawia się w pliku .

Polecenie Restore Bicep Modules (Przywracanie modułów Bicep)

Gdy plik Bicep używa modułów publikowanych w rejestrze, restore polecenie pobiera kopie wszystkich wymaganych modułów z rejestru. Przechowuje te kopie w lokalnej pamięci podręcznej. Aby uzyskać więcej informacji i przykład, zobacz przywracanie.

Pokaż polecenie Okienko wdrażania

Zobacz Okienko wdrażania.

Korzystanie z sugestii dotyczących szybkiej poprawki

Żarówka w programie VS Code reprezentuje sugestię szybkiej poprawki. Pojawia się, gdy edytor wykryje problem lub szansę poprawy w kodzie. Kliknięcie żarówki powoduje wyświetlenie menu akcji, które mogą rozwiązać problem lub ulepszyć kod.

Aby uzyskać polecenia wyodrębniania, zobacz Wyodrębnianie parametrów, zmiennych i typów. W obszarze Więcej akcji sugeruje dodanie dekoratorów.

Wyodrębnianie parametrów, zmiennych i typów

Wyodrębnianie zmiennych, parametrów i typów danych zdefiniowanych przez użytkownika obejmuje izolowanie i definiowanie tych składników z istniejącego kodu w celu poprawy struktury kodu, możliwości konserwacji i jasności.

Poniższy zrzut ekranu przedstawia definicję zasobu klastra AKS. Można wyodrębnić parametr lub zmienną albo typ danych zdefiniowany przez użytkownika na podstawie właściwości, takiej jak identity. identity Wybierz wiersz z kodu, a następnie wybierz żółtą ikonę żarówki. W oknach kontekstowych są wyświetlane dostępne opcje wyodrębniania.

• Wyodrębnij zmienną: Utwórz nową zmienną oraz opcję aktualizacji nazwy zmiennej:

  

• Wyodrębnij parametr prostego typu danych: Utwórz nowy parametr z prostym typem danych, takim jak ciąg, int itp., oraz opcja aktualizowania nazwy parametru:

  

• Wyodrębnij parametr typu danych zdefiniowanego przez użytkownika: Utwórz nowy parametr z typem danych zdefiniowanym przez użytkownika oraz opcją aktualizacji nazwy parametru:

  

  Wymaga to dostosowania po wyodrębnieniu.

• Utwórz typ zdefiniowany przez użytkownika: utwórz nowy typ zdefiniowany przez użytkownika oraz opcję aktualizacji nazwy typu.

  

  W przeciwieństwie do innych opcji nie zastępuje wybranego kodu odwołaniem do nowego typu. W poprzednim przykładzie wartość identity pozostaje tak, jak jest. Aby użyć nowego typu, należy dołączyć go do kodu.

Opcja Wyświetl dokumentację

W programie Visual Studio Code możesz otworzyć odwołanie do szablonu dla typu zasobu, w którym pracujesz. W tym celu umieść kursor na nazwie symbolicznej zasobu, a następnie wybierz pozycję Wyświetl dokumentację.

Przejdź do pliku

Podczas definiowania modułu i niezależnie od typu przywoływanego pliku — pliku lokalnego, pliku rejestru modułów lub specyfikacji szablonu — możesz otworzyć plik, wybierając lub wyróżniając ścieżkę modułu i naciskając [F12]. Jeśli przywołany plik jest Azure Verified Module, czyli AVM, możesz przełączać się pomiędzy skompilowanym plikiem JSON a plikiem Bicep. Aby otworzyć plik Bicep prywatnego modułu rejestru, upewnij się, że moduł został opublikowany w rejestrze z włączoną opcją WithSource. Aby uzyskać więcej informacji, zobacz Publikowanie plików w rejestrze. Rozszerzenie Bicep dla programu Visual Studio Code w wersji 0.27.1 lub nowszej jest wymagane do otwierania plików Bicep z prywatnego rejestru modułów.

Okienko wdrożenia

Okienko wdrażania to panel UI, który umożliwia połączenie się z subskrypcją platformy Azure i przeprowadzanie walidacji, wdrażania oraz operacji typu 'co-jeżeli', zapewniając natychmiastową informację zwrotną bez opuszczania edytora.

Aby użyć okienka wdrażania:

1. Otwórz plik .bicep lub .bicepparam w programie VS Code.

2. Istnieją dwa sposoby otwierania okienka wdrażania:

   • Wybierz przycisk Pokaż okienko wdrażania w prawym górnym rogu, jak pokazano na poniższym zrzucie ekranu:

     

     Domyślnie program VS Code otwiera okienko wdrażania po stronie. Aby otworzyć go na nowej karcie, przytrzymaj Alt podczas wybierania przycisku.

   • Innym sposobem otwarcia okienka wdrożenia jest paleta poleceń. Naciśnij Ctrl+Shift+P, a następnie wybierz pozycję Pokaż okienko wdrożenia lub Pokaż okienko wdrożenia z boku.

     

   Poniższy zrzut ekranu przedstawia pomyślne wdrożenie z wynikami weryfikacji pliku Bicep.

   

3. Wybierz pozycję Zmień zakres , aby zdefiniować zakres wdrożenia. Po uwierzytelnieniu możesz wybrać subskrypcję i grupę zasobów żądanego wdrożenia.

4. Wybierz Wybierz plik parametrów JSON, aby wybrać plik parametrów JSON.

5. Wybierz żądaną akcję — Wdróż, Zweryfikuj lub Co-jeżeli.

   • Wdrażanie: wdraża na platformie Azure, a wynik zawierający zdefiniowane dane wyjściowe są wyświetlane w okienku wdrażania.

   • Weryfikacja: przeprowadza walidację środowiska uruchomieniowego pliku Bicep na platformie Azure, zapewniając, że zasoby, parametry i zasady są poprawne w rzeczywistym środowisku wdrażania. W przeciwieństwie do lintera, który sprawdza tylko błędy składniowe, ta walidacja współdziała z platformą Azure w celu wykrywania potencjalnych problemów z wdrażaniem. Jest to odpowiednik polecenia validate w interfejsie wiersza polecenia platformy Azure i polecenia Test w programie Azure PowerShell. Na przykład:

     Interfejs wiersza polecenia platformy Azure

     az deployment group validate --resource-group <resource-group-name> --template-file <template-file-path>        
     

     Azure PowerShell

     Test-AzResourceGroupDeployment -ResourceGroupName <ResourceGroupName> -TemplateFile <TemplateFilePath>
     

   • Co-jeżeli: wykonuje analizę analizy warunkowej bezpośrednio z okienka wdrażania. W okienku zostaną wyświetlone wyniki pokazujące wszelkie planowane zmiany. Wykonuje to tę samą funkcję co polecenie 'what-if' w Azure PowerShell i Azure CLI. Na przykład:

     Interfejs wiersza polecenia platformy Azure

     az deployment group what-if --resource-group <resource-group-name> --template-file <template-file-path>        
     

     Azure PowerShell

     New-AzResourceGroupDeployment -Whatif -ResourceGroupName <ResourceGroupName> -TemplateFile <TemplateFilePath>
     

   Aby uzyskać więcej informacji, zobacz jeden z następujących artykułów:

   • Analiza hipotetyczna wdrożenia Bicep
   • Wdrażanie plików Bicep za pomocą programu Visual Studio Code
   • Wdrażanie plików Bicep za pomocą interfejsu wiersza polecenia platformy Azure
   • Wdrażanie plików Bicep za pomocą programu Azure PowerShell
   • Wdrażanie plików Bicep za pomocą usługi Azure Cloud Shell

Rozwiązywanie problemów

Okienko Problems zawiera podsumowanie błędów i ostrzeżeń w pliku Bicep:

Diagnostyka rdzenia Bicep udostępnia listę kodów błędów i ostrzeżeń.

Następne kroki

Przejdź do przewodnika Szybki start: tworzenie plików Bicep za pomocą programu Visual Studio Code w celu uzyskania samouczka dotyczącego sposobu stosowania informacji w tym artykule.