How to Batch Import and Update Installed Visual Studio Configurations with PowerShell

This article assumes that configurations have been pre-exported according to How to batch export all installed Visual Studio configurations using PowerShell.

Solution

The following shows how to batch import and modify the configurations of installed Visual Studio instances using PowerShell:

# Script to import Visual Studio configurations and modify installations only when necessary

# Administrator privilege check
if (-NOT ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator"))
{
    Write-Error "This script must be run with administrator privileges. Please run PowerShell as administrator and execute the script again."
    exit 1
}

# Set to stop immediately if an error occurs
$ErrorActionPreference = "Stop"

# Define the Visual Studio Installer path as a variable
$vsInstallerDir = "${env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer"
$vswhereExe = Join-Path $vsInstallerDir "vswhere.exe"
$vsInstallerExe = Join-Path $vsInstallerDir "vs_installer.exe"

# Use vswhere.exe to get information for all installed Visual Studio instances
$vsInstallations = & $vswhereExe -format json -prerelease | ConvertFrom-Json

# Specify the directory where the configuration files are saved
$configDir = Join-Path -Path $PSScriptRoot -ChildPath "vsconfig"

# Ensure the configuration directory exists
if (-not (Test-Path $configDir)) {
    Write-Error "Configuration directory not found: $configDir"
    exit 1
}

foreach ($installation in $vsInstallations) {
    $productId = $installation.productId
    $channelId = $installation.channelId
    $vsconfigPath = Join-Path -Path $configDir -ChildPath "$channelId.vsconfig"

    # Check if a configuration file for the corresponding channel exists
    if (-not (Test-Path $vsconfigPath)) {
        Write-Host "Configuration file for channel $channelId not found. Skipping this installation."
        continue
    }

    Write-Host "Checking current settings for Product ID: $productId, Channel ID: $channelId..."

    # Create a temporary file
    $tempFile = New-TemporaryFile

    try {
        # Export current configuration (suppress output)
        $exportCommand = "& '$vsInstallerExe' export --productId $productId --channelId $channelId --config '$($tempFile.FullName)' --quiet; exit `$LASTEXITCODE"
        $encodedExportCommand = [Convert]::ToBase64String([Text.Encoding]::Unicode.GetBytes($exportCommand))
        $exportProcess = Start-Process pwsh.exe -ArgumentList "-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-EncodedCommand", $encodedExportCommand -WindowStyle Hidden -PassThru -Wait
        $exportExitCode = $exportProcess.ExitCode

        if ($exportExitCode -ne 0) {
            Write-Error "Failed to export current configuration for channel $channelId. Exit code: $exportExitCode"
            continue
        }

        # Compare configuration file contents
        $currentConfig = Get-Content -Path $tempFile.FullName -Raw
        $newConfig = Get-Content -Path $vsconfigPath -Raw

        if ($currentConfig -eq $newConfig) {
            Write-Host "No changes in settings for channel $channelId. Skipping."
            continue
        }

        Write-Host "Modifying installation for Product ID: $productId, Channel ID: $channelId..."

        # Execute installation modification using Start-Process
        $process = Start-Process -FilePath $vsInstallerExe -ArgumentList "modify", "--productId", $productId, "--channelId", $channelId, "--config", $vsconfigPath, "--quiet", "--norestart" -NoNewWindow -PassThru -Wait

        # Check process exit code and report errors
        if ($process.ExitCode -ne 0) {
            Write-Error "Failed to modify installation for channel $channelId. Exit code: $($process.ExitCode)"
        }
    }
    finally {
        # Delete the temporary file
        Remove-Item -Path $tempFile.FullName -Force
    }
}

Write-Host "Modification process completed." -ForegroundColor Cyan

Explanation

This script operates through the following steps:

1. Performs an administrator privilege check.
2. Locates the Visual Studio Installer.
3. Uses vswhere.exe to retrieve information for all installed Visual Studio instances.
4. For each Visual Studio installation:
   • Exports the current settings (suppressing output).
   • Compares the exported settings with the new configuration file.
   • Modifies the installation only if there are changes.

Supplementary Information

• This script must be run with administrator privileges.
• Configuration files for each channel (<channelId>.vsconfig) are required in the vsconfig folder.
• PowerShell Core (pwsh.exe) must be installed on the system.
• The script checks the current status of each installation before processing, so unnecessary modifications can be avoided.

By using this script, you can efficiently manage Visual Studio configurations and modify installations only when necessary.