インストール構成をインポートまたはエクスポートする

[アーティクル]
04/01/2024

インストール構成ファイルを使用して、Visual Studio でインストールされる内容を構成できます。これを行うには、Visual Studio インストーラーを使用して、ワークロード、コンポーネント、Marketplace の拡張機能の情報を.vsconfigファイルにエクスポートします。 *.vsconfigファイルを作成したら、手動でさらに調整し、追加の項目を追加または削除できます。 *.vsconfigファイルの構造と構文を以下に示します。また、構成ファイルを新規または既存の Visual Studio インストールにインポートし、それを使用してレイアウトまたはオフラインインストールを作成または変更してソリューションディレクトリまたはリポジトリに配置し、不足しているコンポーネントのインストールをトリガーして、他のユーザーと共有できます。

Visual Studio インストーラーを使用して構成をエクスポートする

インストール構成ファイルは、以前にインストールした Visual Studio のインスタンスからエクスポートできます。

Note

Visual Studio 2022 バージョン 17.10 プレビュー以降では、インスタンス全体のコンテキストで読み込まれた Visual Studio Marketplace 拡張機能を *.vsconfig ファイルにエクスポートできるようになりました。ネットワーク共有から読み込まれた拡張機能やユーザーコンテキストで読み込まれた拡張機能など、他の種類の拡張機能をエクスポートできるようにするexport機能を備えるには、お知らせください。

Visual Studio インストーラー UI を使用する

Visual Studio インストーラーを開きます。
製品カードで [その他] ボタンを選択し、[構成のエクスポート] を選択します。
.vsconfig ファイルを保存する場所を参照するか入力して、[詳細の確認] を選択します。
選択内容が正確であることを確認し、[エクスポート] を選択します。

構成ファイルをプログラムでエクスポートする

コマンドラインexportドキュメントからのインストールの Visual Studio の説明に従って、動詞を使用して構成をプログラムでエクスポートできます。

Visual Studio インストーラーを使用して構成をインポートする

インストール構成ファイルを以前にインストールした Visual Studio のインスタンスにインポートしたり、それを使用して Visual Studio の新しいインストールを初期化したりできます。構成ファイルを Visual Studio にインポートすると、まだインストールされていない構成ファイルにリストされているものがインストールされます。

Visual Studio インストーラー UI を使用する

インストール構成ファイルをインポートする準備ができたら、次の手順を実行します。

Visual Studio インストーラーを開き、Visual Studio を閉じます。ほとんどのインストーラー操作では、Visual Studio 製品自体を閉じる必要があります。
[インストール済み] タブまたは [使用可能] タブで、Visual Studio 製品カードの [その他の>インポート構成] を選択します。
インポートする.vsconfigファイルを見つけて、[詳細の確認] を選択します。
選択内容が正確であることを確認し、[変更] を選択します。

構成ファイルをプログラムで使用して既存のインストールにコンポーネントを追加する

この --config パラメーターを使用して、既存のインストールを初期化または変更してコンポーネントを追加することができます。以下の例では、クライアントマシンに既にあるインストーラをmodify既存のインストールに使用してします。

"C:\Program Files (x86)\Microsoft Visual Studio\Installer\setup.exe" modify --installPath "C:\Program Files\Microsoft Visual Studio\2022\Professional" --config "C:\myconfig.vsconfig" --passive --allowUnsignedExtensions

Note

構成ファイル (*.vsconfig) を使用して既存のインストールにコンポーネントを追加するには、modify インストール済みの製品ではなく、update をインストールする必要があります。 Updateは、インストールされている既存のコンポーネントを最新バージョンに更新するだけです。さまざまなインストーラー操作の詳細については、コマンドラインドキュメントから Visual Studio のインストールを参照してください。

構成ファイルを使用して、レイアウトの内容を初期化する

必要な Visual Studio のバージョンとエディションに対応する適切なブートストラップを使用して、管理者コマンドプロンプトを開き、次のコマンドを実行して--configパラメーターを使用し、レイアウトのコンテンツを構成します: *.vsconfig ファイルを使用してレイアウトから初期化およびインストールする方法の詳細については、こちらをご覧ください。

vs_enterprise.exe --layout "c:\localVSlayout" --config "c:\myconfig.vsconfig" --lang en-US

構成ファイルを使用して、不足しているコンポーネントを自動的にインストールする

ソリューションのルートディレクトリに *.vsconfig ファイルを保存してからソリューションを開くと、不足しているコンポーネントが自動的に検出され、それらをインストールするように求められます。

Note

[注]: *.vsconfigファイルに拡張子が含まれている場合、現在では Visual Studio Marketplace でホストされている拡張機能のみが、"is-missing" の自動検出とインストールをトリガーします。このロジックに、Marketplace 以外の場所からインストールされた拡張機能を含める場合は、ここでシナリオの詳細を指定してください。

ソリューションエクスプローラーで追加のコンポーネントが提案される

ソリューションエクスプローラーから *.vsconfig ファイルを直接生成することもできます。

ソリューションファイルを右クリックします。
[追加]>[インストール構成ファイル] を選択します。
.vsconfig ファイルを保存する場所を確認し、[詳細の確認] を選択します。
必要なワークロードとコンポーネントがあることを確認してから、[エクスポート] を選択します。

また、Visual Studio のインストール構成*.vsconfigファイルをダウンストリームに再帰的に配置し、それらをすべてマージするオープンソースユーティリティも作成しました。 VSConfigFinder ツールの詳細については、こちらをご覧ください。

vsconfig ファイル形式

*.vsconfig ファイルは、コンポーネントセクションと必要に応じて拡張セクションを含む json ファイル形式です。コンポーネントセクションには、ワークロードとコンポーネントが含まれており、次のような見た目になります。

{
  "version": "1.0", 
  "components": [ 
    "Microsoft.VisualStudio.Component.CoreEditor", 
    "Microsoft.VisualStudio.Workload.CoreEditor", 
    "Microsoft.VisualStudio.Component.NuGet" 
    ] 
}

Extensions

Visual Studio 2022 バージョン 17.9 以降では、*.vsconfig ファイルに拡張機能を指定され、Visual Studio インストーラーを使用してコンピューター全体に読み込み、すべてのユーザーが使用できるようにします。 Visual Studio 2022 バージョン 17.10 プレビュー以降では、前述のように、export Visual Studio インストーラーを使用して、インスタンス全体のコンテキストに読み込まれた *.vsconfig ファイルに Visual Studio Marketplace 拡張機能を使用できるようになりました。

構成ファイルで拡張機能をサポートする場合は、いくつかの既知の注意事項があります。

これらの構成ファイルを介してロードされる拡張機能はインスタンス全体にインストールされるため、インストールするには管理者のアクセス許可を持っているか、AllowStandardUserControl ポリシーを通じてインストーラーの制御が許可されている必要があります。 Visual Studio 拡張機能マネージャーによって以前にインストールされた拡張機能には、インスタンス全体ではなくユーザーごとにインストールされる機能があり (これまでは)、ユーザーはインストールするために管理者アクセス許可を得る必要はありませんでした。
現在、Visual Studio インストーラーは、*.vsixパッケージに含まれている拡張機能や、非常に「複雑」ではない拡張機能など、特定の種類の拡張機能のインポートのみがサポートされます。構成ファイルを介して正しく読み込まれていない拡張子がある場合は、新しい開発者コミュニティの提案を通じてお知らせください。
*.vsconfig ファイルがソリューションディレクトリ内にある場合、Visual Studio Marketplace でホストされている拡張機能のみが、自動 "不足" 検出とインストールをトリガーします。このロジックに、Marketplace 以外の場所からインストールされた拡張機能を含める場合は、ここでシナリオの詳細を指定してください。
プログラムによって*.vsconfigファイルを使用して拡張機能を追加する場合は、新しい--allowUnsignedExtensionsパラメーターを使用して、署名されていない拡張機能を--passiveまたは--quietコンテキストに読み込みできるようにする必要があります。レイアウトからインストールする場合は、response.json ファイルに "allowUnsignedExtensions" : true 構文を追加して、同様の効果を得ることができます。

すべてのインスタンス全体の拡張機能は、スケジュールされたタスクを通じて 1 日に 1 回ほど自動的に更新されます。詳細については、こちらをご覧ください。

拡張機能を含む .vsconfig ファイルの形式は次のようになります。

{
  "version": "1.0", 
  "components": [ 
    // Whatever components you want to install come here, in quotes, separated by commas.
    // You can use the installer to select the components you want to install and then export them,
    // Or you can specify the ones you want according to the [component-id's](https://learn.microsoft.com/en-us/visualstudio/install/workload-and-component-ids).
    // This array should not be null! If you don't want to install any component, just leave the array empty.
  ],
  "extensions": [
    // The extensions you want to install are specified in this section, in quotes, separated by commas.
    // Extensions are optional in .vsconfig, so if you don't want any, you can delete the entire extensions section.
    // The extensions must be in a *.vsix package
    // Make sure that the extensions you specify are designed to work with that version of Visual Studio.
    // examples below
    "https://marketplace.visualstudio.com/items?itemName=MadsKristensen.ImageOptimizer64bit",   //unsigned extension
    "https://marketplace.visualstudio.com/items?itemName=vsext.RegexMatchVisualizer",  //signed extension
    "c:\\mylocaldrive\\someextension.vsix",
    "\\\\server\\share\\myextension.vsix",
    "https://myweb/anotherextension.vsix"
  ]
}

サポートまたはトラブルシューティング

ときには、問題が発生してしまうことがあります。 Visual Studio のインストールが失敗した場合は、「Visual Studio のインストールとアップグレードの問題のトラブルシューティング」に記載されているステップバイステップガイドをご覧ください。

他のいくつかのサポートオプションを次に示します。

インストール関連の問題については、インストールチャット (英語のみ) のサポートオプションを提供しています。
Visual Studio インストーラーおよび Visual Studio IDE の両方に表示される [問題の報告] ツールから、製品の問題を Microsoft に報告してください。自分は IT 管理者であるのに、Visual Studio がインストールされていない場合は、こちらで IT 管理者フィードバックを送信できます。
Visual Studio 開発者コミュニティで機能の提案、製品の問題の追跡、回答の検索を行うことができます。

インストール構成をインポートまたはエクスポートする

Visual Studio インストーラーを使用して構成をエクスポートする

Visual Studio インストーラー UI を使用する

構成ファイルをプログラムでエクスポートする

Visual Studio インストーラーを使用して構成をインポートする

Visual Studio インストーラー UI を使用する

構成ファイルをプログラムで使用して既存のインストールにコンポーネントを追加する

構成ファイルを使用して、レイアウトの内容を初期化する

構成ファイルを使用して、不足しているコンポーネントを自動的にインストールする

vsconfig ファイル形式

Extensions

サポートまたはトラブルシューティング

関連するコンテンツ

フィードバック

フィードバック

その他のリソース