ポリシーを使用して VS Code の設定を集中管理する

Visual Studio Code のエンタープライズ ポリシーを使用すると、組織は開発チームの VS Code 設定を集中管理でき、組織全体で一貫性と互換性を確保できます。ポリシー値が設定されると、その値は、どのレベル (デフォルト、ユーザー、ワークスペース) で構成された VS Code 設定値よりも優先されます。

IT 管理者は、さまざまなデバイス管理ソリューションを通じて、ユーザーのデバイスに特定の VS Code 構成をデプロイし、強制できます。VS Code は、Windows、macOS、および Linux でのポリシーの適用をサポートしています。

この記事では、VS Code で利用可能なエンタープライズ ポリシーと、さまざまなオペレーティング システムでそれらを構成する方法について説明します。

Windows グループ ポリシー

VS Code は、Windows レジストリ ベースのグループ ポリシーをサポートしています。

これらのプロファイルは、モバイル デバイス管理 (MDM) ソリューションを使用してデプロイするか、個々のデバイスに手動でインストールできます。

ステップ 1: サンプルの ADMX および ADML ファイルを入手する

VS Code バージョン 1.69 以降、各リリースには、利用可能なポリシーを定義する ADMX テンプレート ファイルを含む policies ディレクトリが同梱されています。

ADMX および ADML ファイルは、既存のインストールから取得するか、VS Code の zip アーカイブをダウンロードして解凍することで取得できます。ファイルを取得するには、次の手順に従います。

1. お使いのバージョンの VS Code の VS Code zip アーカイブをダウンロードします。
2. zip ファイルを一時的な場所に解凍します。
3. 解凍したファイル内の policies フォルダーに移動します。このフォルダーには、ADMX テンプレート ファイル (例: vscode.admx) と、さまざまな言語用の ADML ファイルを含む locales サブフォルダーが含まれています。

ステップ 2: ポリシー値を構成する

要件に従ってポリシー値を編集します。

文字列ポリシー - テキスト値または JSON 文字列を受け入れるポリシー

<!-- Example: Allow extensions from specific publishers -->
<key>AllowedExtensions</key>
<string>{"microsoft": true, "github": true}</string>

<!-- Example: Set update mode to a specific value -->
<key>UpdateMode</key>
<string>start</string>

ブール値ポリシー - true/false 値を受け入れるポリシー

<!-- Example: Enable user feedback -->
<key>EnableFeedback</key>
<true/>

<!-- Example: Disable telemetry -->
<key>EnableTelemetry</key>
<false/>

不要なポリシーの削除 - 強制したくないポリシーのキーと値の両方を削除します

<!-- To not enforce an update mode policy, remove these lines: -->
<key>UpdateMode</key>
<string>start</string>

各ポリシーの許容値と動作の詳細については、以下の ポリシー リファレンスを参照してください。

ステップ 3: ポリシーをデプロイする

構成したポリシーを、デバイス管理ソリューションを使用して組織内のすべての関連デバイスに大規模にデプロイできるようになりました。ローカル グループ ポリシー エディターを使用して、大規模にデプロイする前に、ローカルの Windows マシンでポリシーを手動でテストできます。

macOS 構成プロファイル

構成プロファイルは、macOS デバイスの設定を管理します。プロファイルは、利用可能なポリシーに対応するキー/値ペアを持つ XML ファイル (.mobileconfig) です。

これらのプロファイルは、モバイル デバイス管理 (MDM) ソリューションを使用してデプロイするか、個々のデバイスに手動でインストールできます。

ステップ 1: サンプル構成プロファイルを入手する

VS Code バージョン 1.99 以降、各リリースにはサンプル .mobileconfig ファイルが同梱されています。VS Code がインストールされている macOS デバイスでサンプル ファイルを見つけるには、次の手順に従います。

1. Finder を開き、/Applications に移動します。
2. Visual Studio Code.app (またはお使いの VS Code バリアント) を右クリックし、[パッケージの内容を表示] を選択します。
3. Contents/Resources/app/policies に移動します。
4. サンプル .mobileconfig ファイル (例: vscode-sample.mobileconfig) を見つけます。

ステップ 2: ポリシー値を構成する

1. サンプル .mobileconfig ファイルを作業場所 (デスクトップや書類フォルダーなど) にコピーします。

2. コピーしたファイルをテキスト エディター (テキストエディット、VS Code、または任意の XML エディター) で開きます。

3. 要件に従ってポリシー値を編集します。

   文字列ポリシー - テキスト値または JSON 文字列を受け入れるポリシー

   <!-- Example: Allow extensions from specific publishers -->
   <key>AllowedExtensions</key>
   <string>{"microsoft": true, "github": true}</string>
   
   <!-- Example: Set update mode to a specific value -->
   <key>UpdateMode</key>
   <string>start</string>
   

   重要

   ポリシー値に構文エラーがある場合、設定は適用されません。VS Code のウィンドウ ログでエラーを確認できます (⇧⌘P (Windows、Linux は Ctrl+Shift+P) を押して、Show Window Log (ウィンドウ ログを表示) と入力します)。

   ブール値ポリシー - true/false 値を受け入れるポリシー

   <!-- Example: Enable user feedback -->
   <key>EnableFeedback</key>
   <true/>
   
   <!-- Example: Disable telemetry -->
   <key>EnableTelemetry</key>
   <false/>
   

   不要なポリシーの削除 - 強制したくないポリシーのキーと値の両方を削除します

   <!-- To not enforce an update mode policy, remove these lines: -->
   <key>UpdateMode</key>
   <string>start</string>
   

各ポリシーの許容値と動作の詳細については、ポリシー リファレンスを参照してください。

ステップ 3: ポリシーをデプロイする

構成したポリシーを、MDM ソリューションを使用して組織内のすべての関連デバイスに大規模にデプロイできるようになりました。大規模にデプロイする前に、ローカル マシンでポリシーを手動でテストできます。

Linux JSON ポリシー

VS Code バージョン 1.106 以降、/etc/vscode/policy.json に JSON ポリシー ファイルを配置することで、Linux デバイスで VS Code 設定ポリシーを構成できます。このアプローチでは、単純な JSON 形式を使用してポリシー値を定義します。

これらのプロファイルは、モバイル デバイス管理 (MDM) ソリューションを使用してデプロイするか、個々のデバイスに手動でインストールできます。

ステップ 1: サンプル ポリシー ファイルを入手する

VS Code バージョン 1.106 以降、各リリースにはサンプル .policy.json ファイルが同梱されています。これは、既存のインストールから取得するか、VS Code アーカイブをダウンロードして解凍することで取得できます。ファイルは resources/app/policies ディレクトリにあります。

ステップ 2: ポリシー値を構成する

1. サンプル policy.json ファイルを作業場所にコピーします。

   sudo cp /usr/share/code/resources/app/policies/policy.json /tmp/policy.json
   

2. お好みのテキスト エディターを使用してファイルを編集します。

   sudo nano /tmp/policy.json
   # or
   sudo vim /tmp/policy.json
   # or
   code /tmp/policy.json
   

3. 要件に従ってポリシー値を編集します。

   文字列ポリシー - テキスト値または JSON 文字列を受け入れるポリシー

   <!-- Example: Allow extensions from specific publishers -->
   <key>AllowedExtensions</key>
   <string>{"microsoft": true, "github": true}</string>
   
   <!-- Example: Set update mode to a specific value -->
   <key>UpdateMode</key>
   <string>start</string>
   

   重要

   ポリシー値に構文エラーがある場合、設定は適用されません。VS Code のウィンドウ ログでエラーを確認できます (⇧⌘P (Windows、Linux は Ctrl+Shift+P) を押して、Show Window Log (ウィンドウ ログを表示) と入力します)。

   ブール値ポリシー - true/false 値を受け入れるポリシー

   <!-- Example: Enable user feedback -->
   <key>EnableFeedback</key>
   <true/>
   
   <!-- Example: Disable telemetry -->
   <key>EnableTelemetry</key>
   <false/>
   

   不要なポリシーの削除 - 強制したくないポリシーのキーと値の両方を削除します

   <!-- To not enforce an update mode policy, remove these lines: -->
   <key>UpdateMode</key>
   <string>start</string>
   

各ポリシーの許容値と動作の詳細については、ポリシー リファレンスを参照してください。

ステップ 3: ポリシーをデプロイする

構成したポリシーを、MDM ソリューションを使用して組織内のすべての関連デバイスに大規模にデプロイできるようになりました。大規模にデプロイする前に、ローカル マシンでポリシーを手動でテストできます。

ポリシー適用の検証

エンタープライズ ポリシーをデバイスにデプロイした後、[開発者: ポリシーの診断] (Developer: Policy Diagnostics) コマンドを使用して、VS Code がそれらを読み取り、適用していることを確認できます。このコマンドを実行すると、デバイスの現在のポリシー状態に関するレポートを含む新しい無題の Markdown ドキュメントが開きます。Windows、macOS、Linux で同じように機能します。

レポートには次のセクションが含まれます。

• システム情報: VS Code の製品名、バージョン、コミット。レポートを特定のビルドに関連付けるのに役立ちます。
• アカウント情報: サインインしているデフォルト アカウントの詳細。アカウント プロバイダーから返された生のアカウント レベル ポリシー データを含みます。
• アカウント ポリシー ゲート: AI 機能を制御する承認済み GitHub 組織ゲートの状態。可能な状態は inactive、satisfied、restricted です。状態が restricted の場合、レポートには noAccount、wrongProvider、orgNotApproved、policyNotResolved などの理由もリストされます。
• ポリシー制御設定: 登録されている各設定のポリシー状態をリストする 2 つの表。
  • 適用済みポリシー: 現在ポリシーによってオーバーライドされている設定。設定キー、ポリシー名、ポリシー ソース、デフォルト値、現在の値、ポリシーによって強制されている値が含まれます。
  • 未適用ポリシー: 現在強制されていない登録済みポリシー。この表を使用して、キーのスペルミスや、読み取られていないポリシー ファイルなどのデプロイ エラーを検出します。
• 認証情報: 登録されている認証プロバイダー、セッション、アカウント、および各アカウントへのアクセス権を持つ拡張機能。

VS Code エンタープライズ ポリシー リファレンス

次の表は、VS Code で利用可能なすべてのエンタープライズ ポリシーをリストしたものです。