透過使用 Visual Studio Code 建立 Bicep 檔案

發行項
12/06/2024

本文說明如何使用 Visual Studio Code 建立 Bicep 檔案。

安裝 VS Code

若要設定您的環境以進行 Bicep 開發，請參閱安裝 Bicep 工具 (部分機器翻譯)。完成那些步驟之後，您將會有 Visual Studio Code (英文) 和Bicep 延伸模組 (英文)。您也可以使用最新的 Azure CLI (部分機器翻譯) 或最新的 Azure PowerShell 模組 (英文)。

Bicep 命令

Visual Studio Code 隨附數個 Bicep 命令。

在 VS Code 中開啟或建立 Bicep 檔案，選取 [ 檢視 ] 選單，然後 選取 [命令選擇區]。您也可以使用 F1 或按鍵組合 Ctrl+Shift+P 來顯示命令選擇區。輸入 Bicep 以列出 Bicep 命令。

命令選擇區中 Visual Studio Code Bicep 命令的螢幕擷取畫面。

這些命令包括：

組建 ARM 範本
建置參數檔案
建立 Bicep 設定檔
反向組譯成 Bicep
部署 Bicep 檔案
產生參數檔案
匯入 Kubernetes 資訊清單 (預覽)
插入資源
開啟 Bicep 視覺化檢視
將 Bicep 視覺化檢視開啟至側邊
將 JSON 貼上為 Bicep
還原 Bicep 模組 (強制)
顯示部署窗格
顯示側邊的部署窗格

當您以滑鼠右鍵按一下 Bicep 檔案時，這些命令也會顯示在捷徑功能表中：

當您在 JSON 檔案上按一下滑鼠右鍵時：

組建 ARM 範本

build 命令會將 Bicep 檔案轉換為 Azure Resource Manager 範本 (ARM 範本)。新的 JSON 範本會儲存在具有相同檔案名的相同資料夾中。如果存在具有相同檔案名的檔案，則會覆寫舊的檔案。如需詳細資訊，請參閱 Bicep CLI 命令。

建置參數檔案

命令 build 會將 Bicep 參數檔案轉換成 JSON 參數檔案。新的 JSON 參數檔案會儲存在具有相同檔名的相同資料夾中。如果存在具有相同檔案名的檔案，則會覆寫舊的檔案。如需詳細資訊，請參閱 Bicep CLI 命令。

建立 Bicep 設定檔

Bicep 設定檔 (bicepconfig.json) 可用來自訂 Bicep 開發體驗。您可以在多個目錄中新增 bicepconfig.json。系統會使用目錄階層中最接近 Bicep 檔案的設定檔。當您選取此命令時，延伸模組會開啟對話方塊供您選取資料夾。預設資料夾是您儲存 Bicep 檔案的資料夾。如果資料夾中已有 bicepconfig.json 檔案，您可以覆寫現有的檔案。

建立 Bicep 設定檔：

打開 Visual Studio Code。
從 [檢視] 功能表，選取 [命令選擇區] (或按下 Ctrl/Cmd+Shift+P)，然後選取 [Bicep: 建立 Bicep 設定檔]。
選取您要放置檔案的檔案目錄。
完成時儲存設定檔。

反向組譯成 Bicep

此命令會將 ARM JSON 範本反向組譯成 Bicep 檔案，並將它放在與 ARM JSON 範本相同的目錄中。新檔案具有相同的檔案名稱與 .bicep 副檔名。如果具有相同檔案名稱的 Bicep 檔案已存在於相同的資料夾中，Visual Studio Code 會提示您覆寫現有的檔案或建立複本。

部署 Bicep 檔案

您可以直接從 Visual Studio Code 部署 Bicep 檔案。從命令選擇區或捷徑功能表中選取 [部署 Bicep 檔案]。延伸模組會提示您登入 Azure、選取訂用帳戶，建立/選取資源群組，然後輸入參數值。

注意

Visual Studio Code 中的 Bicep deploy 命令會使用新的內建驗證 API 來管理驗證。它不會使用來自 bicepconfig.json 的雲端設定檔。若要登入自定義雲端，請選取 [管理>設定>擴充>功能Microsoft帳戶>Microsoft主權雲端]。 目前不支援多個登入帳戶。

產生參數檔案

此命令會在與 Bicep 檔案相同的資料夾中建立參數檔案。您可以選擇建立 Bicep 參數檔案或 JSON 參數檔案。新的 Bicep 參數檔名為 <bicep-file-name>.bicepparam，而新的 JSON 參數檔名態 <bicep-file-name>.parameters.json。

匯入 Kubernetes 資訊清單 (預覽)

此命令會匯入 Kubernetes 資訊清單檔 (部分機器翻譯)，並建立 Bicep 模組 (部分機器翻譯)。如需詳細資訊，請參閱 Bicep 擴充性 Kubernetes 提供者 (部分機器翻譯) 和快速入門：使用 Bicep Kubernetes 提供者將 Azure 應用程式部署至 Azure Kubernetes Service (AKS) 叢集 (部分機器翻譯)。

插入資源

insert resource 命令會藉由提供現有資源的資源識別碼，在 Bicep 檔案中新增資源宣告。選取 [插入資源] 之後，請在命令選擇區中輸入資源識別碼。插入資源需要一些時間。

您可以使用下列其中一種方法來尋找資源識別碼：

使用適用於 Visual Studio Code 的 Azure 原則延伸模組 (英文)。
使用 Azure 入口網站。
使用 Azure CLI 或 Azure PowerShell：
- CLI
- PowerShell
```
az resource list
```
```
Get-AzResource
```

與匯出範本類似，此流程會嘗試建立可用的資源。不過，大部分插入的資源都需要先進行一些修改，才能用於部署 Azure 資源。

如需詳細資訊，請參閱將 ARM 範本 JSON 反編譯為 Bicep。

開啟 Bicep 視覺化檢視

此視覺化檢視會顯示 Bicep 檔案中定義的資源以及資源相依性資訊。此圖表是 Linux 虛擬機器 Bicep 檔案的視覺效果。

您也可以將視覺化檢視與 Bicep 檔案並排開啟。

貼上為 Bicep

您可以將 ARM 範本的 JSON 代碼段貼到 Bicep 檔案。 Visual Studio Code 會自動將 JSON 反向組譯為 Bicep。此功能僅適用於 Bicep 擴充功能 0.14.0 版或更新版本，且預設為啟用此功能。若要停用此功能，請參閱 VS Code 和 Bicep 延伸模組。

透過使用此功能，您可以貼上︰

完整的 ARM JSON 範本。
單一資源或多個資源。
JSON 值，例如物件、陣列和字串。具有雙引號的字串會轉換成具有單引號的字串。

例如，您可以從下列 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

並貼到下列 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'))]"
    }
  }
}

Visual Studio Code 會自動將 JSON 轉換為 Bicep。請注意，您也需要新增名為 batchAccountName 的參數。

您可以使用 Ctrl+Z 來復原反向組譯。原始 JSON 會出現在檔案中。

還原 Bicep 模組

當 Bicep 檔案使用已發佈至登錄的模組時，還原命令會從登錄取得所有必要模組的複本。其會將那些複本儲存在本機快取中。如需更多資訊，請參閱還原。

顯示部署窗格

Bicep 部署窗格是實驗性功能。如需詳細資訊，請參閱使用部署窗格。

您也可以使用 Bicep 檔案並排開啟部署窗格。

檢視文件

從 Visual Studio Code，您可以開啟目前在處理的資源類型範本參考。若要這樣做，請將游標暫留在資源符號名稱上，然後選取 [ 檢視檔]。

Visual Studio Code Bicep 檢視類型文件的螢幕擷取畫面。

移至定義

定義模組時，不論所參考的檔案類型為何，無論是本機檔案、模組登錄檔案還是範本規格，您都可以選取或反白顯示模組路徑來開啟檔案，然後按 [F12] 。如果參考的檔案是 Azure 已驗證模組 (AVM) (英文)，則可以在編譯的 JSON 或 Bicep 檔案之間切換。若要開啟私人登錄模組的 Bicep 檔案，請確定模組已發行至已啟用參數的 WithSource 登錄。如需詳細資訊，請參閱將檔案發佈至登錄 (部分機器翻譯)。需要 Visual Studio Code Bicep 擴充功能 0.27.1 版或更新版本，才能從私人模塊登錄開啟 Bicep 檔案。

疑難排解

窗格 Problems 摘要說明 Bicep 檔案中的錯誤和警告：

Visual Studio Code Bicep 問題窗格的螢幕擷取畫面。

如需錯誤/警告碼清單，請參閱 Bicep 錯誤/警告碼 (英文)。

下一步

若要逐步解說快速入門教學課程，請參閱快速入門：使用Visual Studio Code 建立 Bicep 檔案。

共用方式為