開発ボックスのユーザー カスタマイズ ファイルを記述する

Dev Box のユーザーカスタマイズ機能は、開発ボックスのセットアップを効率化するのに役立ちます。 新しいプロジェクトの開始やチームへの参加は、多くの場合、複雑で時間がかかります。 カスタマイズを使用すると、必要なアプリケーション、ツール、リポジトリ、コード ライブラリ、パッケージ、ビルド スクリプトを使用して開発ボックスを構成できます。 この記事では、Visual Studio Code (VS Code) を使用して開発ボックスのユーザー カスタマイズ ファイルを作成、テスト、編集するプロセスについて説明します。

Microsoft Dev Box では、2 つの方法でカスタマイズを使用できます。 チームのカスタマイズは、開発者チームの共有構成を作成するために使用されます。 ユーザーのカスタマイズは、個々の開発者向けの個人用構成を作成するために使用されます。 次の表は、2 種類のカスタマイズの違いをまとめたものです。

特徴	チームのカスタマイズ	ユーザーのカスタマイズ
構成対象	開発ボックス プール	開発ボックス
カスタマイズの適用対象	プール内のすべての開発ボックス	個々の開発ボックス
簡単に共有可能	イエス	いいえ
カスタマイズ ファイル名	Imagedefinition.yaml	myfilename.yaml または workload.yaml
出典:	カタログ	アップロードするか、個人用リポジトリから取得
キー コンテナーのシークレットをサポート	イエス	イエス

[前提条件]

この記事の手順を実行するには、以下が必要です。

• 開発ボックスを作成できるように 、開発ボックス定義、開発ボックス プール、開発ボックス プロジェクトを使用 してデベロッパー センターを構成します。
• 少なくとも 1 つのプロジェクトの Dev Box ユーザー セキュリティ グループのメンバーになること。
• カスタマイズ ファイルで使用できるタスクを含むカタログを開発センターにアタッチする。 カタログがない場合は、「 GitHub または Azure Repos からカタログを追加して構成する」を参照してください。

カスタマイズを構成するために必要なアクセス許可

開発ボックスにカスタマイズを作成して適用するために必要なアクションを実行するには、次のアクセス許可が必要です:

アクション	アクセス許可/ロール
カスタマイズ ファイルを作成する。	指定なし。 カスタマイズ ファイルは誰でも作成できます。
開発ボックスの作成時に、開発者ポータルを使って、YAML ファイルのアップロードと適用を行う。	Dev Box ユーザー

ユーザー カスタマイズ ファイルを作成する

VS Code を使用してカスタマイズ ファイルを作成および管理できます。 VS Code の Microsoft Dev Box 拡張機能を使用して、アタッチされたカタログ内のタスクを検出し、カスタマイズ ファイルをテストできます。

1. テスト用に開発ボックスを作成します (または、既存の開発ボックスを使います)。

2. テスト開発ボックスに VS Code をインストールし、 Dev Box 拡張機能をインストールします。

3. サンプル リポジトリから サンプル YAML カスタマイズ ファイル をダウンロードし、VS Code で開きます。

4. コマンド パレットを使って、カタログで利用できるタスクを検出します。 [ 表示>コマンド パレット>Dev ボックス: この開発ボックスで使用可能なタスクの一覧を選択します。

   

5. コマンド パレットを使用して、VS Code でカスタマイズをテストします。 [ 表示>コマンド パレット>Dev ボックス: カスタマイズ タスクの適用を選択します。

   

6. カスタマイズ ファイルが実行され、指定したタスクがテスト開発ボックスに適用されます。 変更を検査し、VS Code ターミナルでタスクの実行中に生成されたエラーまたは警告を調べます。 VS Code ターミナルで、タスクの実行中にエラーまたは警告を確認します。

7. カスタマイズ ファイルが正常に実行されたら、それをカタログにアップロードします。

省略可能: 既存の WinGet 構成ファイルを使用して開発ボックスをカスタマイズする

WinGet 構成は、Windows 環境をすぐにコード化できる状態にするために必要な一意のソフトウェアと構成設定のセットの定義に、コードとしての構成アプローチを使用します。 これらの構成ファイルは開発ボックスをセットアップするためにも使用できます。これには、Microsoft 提供のクイック スタート カタログに含まれている WinGet タスクを使用します。

この例では、既存の WinGet Desired State Configuration (DSC) ファイルを使用する開発ボックスカスタマイズ ファイルを示します。

tasks:
    - name: winget
      parameters:
          configure: "projectConfiguration.dsc.yaml"

詳細については、 WinGet の構成に関するページを参照してください。

ユーザー カスタマイズ ファイルを使用して開発ボックスを作成する

個々のカスタマイズ ファイルを使用するには、開発ボックスの作成時にローカル ドライブからアップロードするか、リポジトリからダウンロードします。 リポジトリに格納されているカスタマイズ ファイルは workload.yaml と呼ばれる必要があります。 アップロード用にローカルに保存されるカスタマイズ ファイルは 、myfilename.yaml と呼ばれる必要があります。 アップロード用にローカルに保存されているカスタマイズ ファイルに myfilename.yaml という名前を付けます。

ファイルをアップロードする

1. 開発者ポータルで、[新規>新規開発] ボックスを選択します。

2. [ 開発ボックスの追加 ] ウィンドウで、開発ボックスの詳細を追加します。

3. [ カスタマイズの適用] を選択し、[続行] を選択 します。

   

4. [ カスタマイズ ファイルのアップロード] を選択し、[ ファイルからカスタマイズを追加] を選択し、 myfilename.yaml ファイルを参照して選択します。

   

5. カスタマイズ ファイル内のタスクが正しく適用されることを確認するには、続行する前にタスクを検証する必要があります。 [検証] を選択します。

   

6. 開発ボックスの作成の概要を確認し、[ 作成] を選択します。

   

リポジトリからファイルを取得する

1. 開発者ポータルで、[新規>新規開発] ボックスを選択します。

2. [ 開発ボックスの追加 ] ウィンドウで、開発ボックスの詳細を追加します。

3. [ カスタマイズの適用] を選択し、[続行] を選択 します。

   

4. [ カスタマイズ ファイルのアップロード] を選択し、[ リポジトリからカスタマイズ ファイルを選択] を選択し、 workload.yaml ファイルを格納するリポジトリの URL を入力します。

   

5. カスタマイズ ファイル内のタスクが正しく適用されることを確認するには、続行する前にタスクを検証する必要があります。 [検証] を選択します。

   

6. 開発ボックスの作成の概要を確認し、[ 作成] を選択します。

   

関連コンテンツ

• Microsoft Dev Box チームのカスタマイズ
• Dev Box チームのカスタマイズ用にイメージングを構成する
• GitHub または Azure Repos からカタログを追加して構成する