クイックスタート: Visual Studio Code を使用して Bicep ファイルを作成する

[アーティクル]
03/20/2024

このクイックスタートでは、Visual Studio Code で Bicep ファイルを作成する手順について説明します。ストレージアカウントと仮想ネットワークを作成します。また、Bicep 拡張機能に備わっているタイプセーフ、構文の検証、オートコンプリートによって、開発がどのように簡略化されるかについても説明します。

同様の作成エクスペリエンスは、Visual Studio でもサポートされています。「クイックスタート: Visual Studio を使用して Bicep ファイルを作成する」を参照してください。

前提条件

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

Bicep の開発環境を設定するには、「Bicep ツールをインストールする」を参照してください。これらの手順を完了すると、Visual Studio Code と Bicep 拡張機能を利用できるようになります。また、最新の Azure CLI または最新の Azure PowerShell モジュールを用意します。

リソーススニペットを追加する

VS Code と Bicep 拡張機能を使用すると、提供される定義済みスニペットによって開発を簡略化できます。このクイックスタートでは、仮想ネットワークを作成するスニペットを追加します。

Visual Studio Code を起動し、main.bicep という名前の新しいファイルを作成します。

[main.bicep] に「vnet」と入力し、リストから [res-vnet] を選択して [TAB] または [ENTER] キーを押します。

Screenshot of adding snippet for virtual network.

ヒント

これらの IntelliSense オプションが VS Code に表示されない場合は、「前提条件」で指定されている Bicep 拡張機能をインストールしていることを確認してください。この拡張機能をインストールしている場合は、Bicep ファイルを開いた後、Bicep 言語サービスが起動されるまで少し時間を置いてください。通常はすぐに起動されますが、起動されるまでは IntelliSense オプションが表示されません。右下隅の通知は、このサービスが起動中であることを示します。その通知が消えたとき、このサービスが実行されています。

これで、Bicep ファイルには次のコードが追加されました。

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2019-11-01' = {
  name: 'name'
  location: location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

このスニペット内で、仮想ネットワークを定義するために必要なすべての値を見つけます。 2 つの波形の下線が表示されることがあります。黄色の波型の下線は古い API バージョンに関連する警告を示し、赤色の波型の下線はパラメータ定義が見つからないことに起因するエラーを示します。

@2019-11-01 を削除し、@ で置き換えます。最新の API バージョンを選択します。

Screenshot of updating API version.

次のセクションでは、パラメータ定義がないエラーを修正します。

必要に応じてこのコードを変更することもできます。たとえば、name は仮想ネットワークに適した名前ではありません。 name プロパティを examplevnet に変更します。

name: 'exampleVNet'

パラメーターの追加

前のセクションで追加したコードスニペットには、パラメータ定義がありません。

ファイルの先頭に次を追加します。

param location

location の後にスペースを追加すると、そのパラメータに使用できるデータ型が IntelliSense によって提案されることがわかります。 [string] を選択します。

Screenshot of adding string type to parameter.

次のように、パラメータに既定値を指定します。

param location string = resourceGroup().location

既定値で使用される関数の詳細については、「resourceGroup()」を参照してください。

ストレージアカウント名の別のパラメータを追加し、既定値を指定します。

param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

詳細については、補間と uniqueString() に関するページを参照してください。

このパラメーターは問題なく機能しますが、ストレージアカウントの名前には長さの制限があります。名前は 3 文字以上、24 文字以下にする必要があります。これらの要件を指定するには、パラメーターにデコレーターを追加します。

パラメーターの上に行を追加して、「 @ 」と入力します。使用できるデコレータが表示されます。 minLength と maxLength の両方のデコレータがあることに注目してください。

Screenshot of adding decorators to parameter.

両方のデコレーターを追加して、次のように文字数制限を指定します。

@minLength(3)
@maxLength(24)
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

また、パラメーターの説明を追加することもできます。 Bicep ファイルをデプロイする担当者が、指定する値を理解するために役立つ情報を含めてください。

@minLength(3)
@maxLength(24)
@description('Provide a name for the storage account. Use only lower case letters and numbers. The name must be unique across Azure.')
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

これで、パラメータを使用する準備は完了です。

リソースを追加する

ここでは、スニペットを使用してストレージアカウントを定義するのではなく、IntelliSense を使用して値を設定します。 IntelliSense を使用すると、手動で値を入力するよりも簡単にこの手順を行うことができます。

リソースを定義するには、resource キーワードを使用します。仮想ネットワークの下に「resource exampleStorage」と入力します。

resource exampleStorage

exampleStorage は、デプロイするリソースのシンボリック名です。この名前は、Bicep ファイルの他の部分にあるリソースを参照するために使用できます。

シンボリック名の後にスペースを追加すると、リソースの種類の一覧が表示されます。続けて「storageacc」と入力すると、使用できるオプションから選択できるようになります。

Screenshot of selecting storage accounts for resource type.

[Microsoft.Storage/storageAccounts] を選択すると、使用できる API バージョンが表示されます。最新のバージョンを選びます。次のスクリーンショットでは 2023-01-01 です。

Screenshot of select API version for resource type.

リソースの種類の一重引用符の後に = とスペースを追加します。リソースにプロパティを追加するためのオプションが表示されます。 [required-properties] を選択します。

Screenshot of adding required properties.

このオプションを選択すると、デプロイに必要なリソースの種類のすべてのプロパティが追加されます。このオプションを選択すると、ストレージアカウントに次のプロパティが追加されます。

resource exampleStorage 'Microsoft.Storage/storageAccounts@2023-01-01' =  {
  name:
  location:
  sku: {
    name:
  }
  kind:
}

完了までもう少しです。これらのプロパティに値を指定するだけです。

ここでも IntelliSense が役立ちます。 name を storageAccountName に設定します。これは、ストレージアカウントの名前を含むパラメーターです。 location では、先ほど作成したパラメータの location に設定します。 sku.name と kind を追加すると、IntelliSense によって有効なオプションが表示されます。

完了すると、次のようになります。

@minLength(3)
@maxLength(24)
param storageAccountName string = 'store${uniqueString(resourceGroup().id)}'

resource virtualNetwork 'Microsoft.Network/virtualNetworks@2019-11-01' = {
  name: 'exampleVNet'
  location: resourceGroup().location
  properties: {
    addressSpace: {
      addressPrefixes: [
        '10.0.0.0/16'
      ]
    }
    subnets: [
      {
        name: 'Subnet-1'
        properties: {
          addressPrefix: '10.0.0.0/24'
        }
      }
      {
        name: 'Subnet-2'
        properties: {
          addressPrefix: '10.0.1.0/24'
        }
      }
    ]
  }
}

resource exampleStorage 'Microsoft.Storage/storageAccounts@2021-02-01' = {
  name: storageAccountName
  location: 'eastus'
  sku: {
    name: 'Standard_LRS'
  }
  kind: 'StorageV2'
}

Bicep の構文の詳細については、Bicep の構造に関する記事を参照してください。

リソースを視覚化する

ファイル内のリソースの表現を確認することができます。

右上にあるビジュアライザーボタンを選択すると、Bicep Visualizer が開きます。

Screenshot of Bicep Visualizer.

このビジュアライザーには、Bicep ファイルに定義されているリソースと、リソースの依存関係情報が表示されます。このクイックスタートで定義した 2 つのリソースには依存関係がないので、2 つのリソース間にコネクタは表示されません。

Screenshot of Bicep Visualizer diagram.

Bicep ファイルをデプロイする

VSCode 内の Bicep ファイルを右クリックし、[Deploy Bicep file] (Bicep ファイルのデプロイ) を選択します。
[Please enter name for deployment] (デプロイの名前を入力してください) テキストボックスに「deployStorageAndVNet」と入力し、[ENTER] キーを押します。
上部の [リソースグループの選択] ボックスで、[新しいリソースグループの作成] を選択します。
リソースグループ名として exampleRG と入力し、[Enter] キーを押します。
リソースグループの場所を選択し、[米国中部] または任意の場所を選択して、[ENTER] キーを押します。
[パラメーターファイルの選択] から [なし] を選択します。

リソースが作成されるまでしばらくかかります。詳細については、Visual Studio Code での Bicep ファイルのデプロイに関するページを参照してください。

Azure CLI または Azure PowerShell を使用して Bicep ファイルをデプロイできます。

CLI
PowerShell

az group create --name exampleRG --location eastus

az deployment group create --resource-group exampleRG --template-file main.bicep --parameters storageAccountName=uniquename

New-AzResourceGroup -Name exampleRG -Location eastus

New-AzResourceGroupDeployment -ResourceGroupName exampleRG -TemplateFile ./main.bicep -storageAccountName "uniquename"

デプロイが完了すると、デプロイが成功したことを示すメッセージが表示されます。

リソースをクリーンアップする

Azure リソースが不要になったら、Azure CLI か Azure PowerShell のどちらかのモジュールを使用してクイックスタートリソースグループを削除します。

CLI
PowerShell

az group delete --name exampleRG

Remove-AzResourceGroup -Name exampleRG

次のステップ

Bicep に関する Learn モジュール