🔧
Visual StudioワークロードとコンポーネントをPowerShellで一括自動インストールする方法

2024/10/18に公開
 解法Visual Studioの特定ワークロードやコンポーネントをPowerShellスクリプトを使って一括で自動的にインストールする方法を紹介します。このスクリプトは、複数のプロダクトとチャネルの組み合わせをチェックし、該当するインストールパスが見つかった場合に、必要なワークロードをまとめてインストールします。管理者権限を必要とするため、適切な権限で実行してください。
# エラーが発生した場合に即座に停止するように設定
$ErrorActionPreference = "Stop"

# 管理者権限チェック
if (-NOT ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator")) {
    Write-Error "このスクリプトは管理者権限で実行する必要があります。PowerShellを管理者として実行し、スクリプトを再度実行してください。"
    exit 1
}

# Visual Studio Installerのパスを変数として定義
$vsInstallerDir = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer"
$vswhereExe = Join-Path $vsInstallerDir "vswhere.exe"
$vsInstallerExe = Join-Path $vsInstallerDir "vs_installer.exe"
$productIds = @(
    "Microsoft.VisualStudio.Product.Enterprise",
    "Microsoft.VisualStudio.Product.Professional",
    "Microsoft.VisualStudio.Product.Community"
)
$channelIds = @(
    "VisualStudio.17.Preview",
    "VisualStudio.17.Release"
)
$workloadIds = @(
    "Microsoft.VisualStudio.Workload.CoreEditor",
    "Microsoft.VisualStudio.Workload.NetWeb",
    "Microsoft.VisualStudio.Workload.Azure",
    "Microsoft.VisualStudio.Workload.ManagedDesktop",
    "Microsoft.VisualStudio.Workload.Universal",
    "Microsoft.VisualStudio.Workload.Data",
    "Microsoft.VisualStudio.Workload.DataScience",
    "Microsoft.VisualStudio.Workload.VisualStudioExtension",
    "Microsoft.VisualStudio.Workload.Office",
    "Microsoft.Net.Component.4.8.1.SDK",
    "Microsoft.Net.Component.4.8.1.TargetingPack"
)

# プロダクトとチャネルの組み合わせを作成
$combinations = foreach ($productId in $productIds) {
    foreach ($channelId in $channelIds) {
        [PSCustomObject]@{
            ProductId = $productId
            ChannelId = $channelId
        }
    }
}

# インストールパスを取得し、インストール可能なプロダクトとチャネルを特定
$missingWorkloads = @()
foreach ($combination in $combinations) {
    $productId = $combination.ProductId
    $channelId = $combination.ChannelId

    $installationPath = & $vswhereExe -format json -prerelease |
        ConvertFrom-Json |
        Where-Object { $_.productId -eq $productId -and $_.channelId -eq $channelId } |
        Select-Object -First 1 |
        Select-Object -ExpandProperty installationPath -ErrorAction SilentlyContinue

    if ($installationPath) {
        # インストールされていないワークロードをチェック
        foreach ($workloadId in $workloadIds) {
            $isExists = & $vswhereExe `
                -products $productId `
                -requires $workloadId `
                -format json `
                -prerelease |
                ConvertFrom-Json |
                Where-Object { $_.channelId -eq $channelId } |
                Measure-Object |
                ForEach-Object { $_.Count -gt 0 }

            if ($isExists -eq $false) {
                Write-Host "Workload '$workloadId' is not installed." -ForegroundColor Yellow
                $missingWorkloads += $workloadId
            }
            else {
                Write-Host "Workload '$workloadId' は既にインストールされています。"
            }
        }

        # 未インストールのワークロードがあれば一括でインストール
        if ($missingWorkloads.Count -gt 0) {
            Write-Host "以下のワークロードをインストールします: $($missingWorkloads -join ', ')" -ForegroundColor Cyan

            # Start-Processを使用してワークロードを一括で追加
            # 重要: Start-Processを使用する理由
            # vs_installer.exeの実行後、スクリプトが自動的に終了せず、Enterキーの入力を待つ問題を解決するため
            $process = Start-Process `
                -FilePath $vsInstallerExe `
                -ArgumentList `
                    "modify", `
                    "--productId", $productId, `
                    "--channelId", $channelId, `
                    "--add", ($missingWorkloads -join " --add "), `
                    "--includeRecommended", `
                    "--quiet", `
                    "--norestart" `
                -NoNewWindow `
                -PassThru `
                -Wait

            # プロセスの終了コードをチェックしてエラーを報告
            if ($process.ExitCode -ne 0) {
                Write-Error "チャンネル $channelId のインストール修正に失敗しました。終了コード: $($process.ExitCode)"
            }
            else {
                Write-Host "ワークロードのインストール修正に成功しました。" -ForegroundColor Cyan
            }
        }
        else {
            Write-Host "すべてのワークロードは既にインストールされています。"
        }
    }
}

 解説このPowerShellスクリプトは、以下の流れでVisual Studioの特定ワークロードやコンポーネントをインストールするよう設計されています：
管理者権限の確認:

スクリプトの実行には管理者権限が必要であり、管理者でない場合はエラーメッセージを表示して終了します。
Visual Studioのインストーラのパス設定:

vswhere.exe および vs_installer.exe のパスを設定し、Enterprise、Professional、Communityエディションの各チャネル（PreviewとRelease）を対象にしています。
Visual Studioのインストールパスの取得:

vswhere.exe を使用して、指定したプロダクトIDとチャネルIDに一致するVisual Studioのインストールパスを取得します。
ワークロードおよびコンポーネントの確認とインストール:

複数のプロダクトとチャネルの組み合わせについて、vswhere.exe を使ってインストール済みのワークロードやコンポーネントを確認し、存在しない場合は vs_installer.exe を用いて一括で自動インストールを実行します。
プロセスの管理:

Start-Process を使用してインストール後のプロセスを管理し、終了コードをチェックしてエラーを適切に報告します。

 補足情報このスクリプトは、Visual Studioのカスタマイズや再インストールを自動化したい場合に便利です。特に、複数の開発者向けに同じ環境を整える場合や、CI/CD環境で使用する場合に効果的です。
管理者権限が必要なため、PowerShellを管理者として実行することを忘れないでください。また、vswhere.exe と vs_installer.exe はMicrosoftの公式ツールであり、Visual Studioのインストールディレクトリに含まれています。
解法

解説

補足情報

Discussion
