Windows app installer multi tool (#44)

* Update Get-AVDW365Gateways.ps1

Changed URL to GCCH JSON Download

* Squashed commit of the following:

commit 33f3d0b
Author: Donna Ryan <100233767+DonnaRyanMicrosoft@users.noreply.github.com>
Date:   Wed Mar 26 15:17:12 2025 -0400

    Initial Commit

    Includes both detection and remediation script, plus readme.md files

* Initial Commit

* Changed MSRDC uninstall order

Also some minor formatting changes

* DisableAutoUpdate reg key support

created function to allow admins to set the DisableAutoUpdate registry key

* Updated outputs

minor bug fix

* Added logging for install processes

Store and Winget installation output now logged separately

* Fixed ID10T error

deleted extra stuff that shouldn't have been pasted

* added comments

* Added Param Block

commented out old variable assignments

* Formatting

* Logging enabled + error handling

Added logging module,
Added error handling
Added rename MSIX download and rename to original file name.

* Added Readme.Md instructions

Wrote the basic instructions

* Changed MSRDC Uninstall Parameter

Changed parameter type to Switch. This makes the parameter true if present, otherwise false. Changed the name of the parameter for clarity.

* Updated Readme.md

Removed notes from head of script. Updated Readme.md

* Formatting and Copyright

Minor formatting changes with copyright,  name, and version added

* Changed name of file to new name

renamed script

* Changed Folder Name

Renamed Folder

Author: DonnaRyanMicrosoft

Remote Desktop Client Migration Script/Remote Desktop Client Migration Script.ps1

@@ -0,0 +1,232 @@
+<#
+.COPYRIGHT
+Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+See LICENSE in the project root for license information.
+#>
+
+#Microsoft Remote Desktop Client Migration Script
+#Version 1.0
+#For more info, visit: https://github.com/microsoft/Windows365-PSScripts
+
+Param(
+    [parameter(mandatory = $false, HelpMessage = "Where to source installer payload")] 
+    [ValidateSet('Store','WinGet','MSIX')]
+    [string]$source = "Store",
+    [parameter(mandatory = $false, HelpMessage = "Value to set auto update reg key")]
+    [ValidateSet(0,1,2,3)]
+    [int]$DisableAutoUpdate = 0,
+    [parameter(mandatory = $false, HelpMessage = "Do not uninstall Remote Desktop if found")]
+    [switch]$SkipRemoteDesktopUninstall ,
+    [parameter(mandatory = $false, HelpMessage = "Log path and file name")] 
+    [string]$logpath = "$env:windir\temp\MultiTool.log"
+)
+
+#$DisableAutoUpdate values:
+#0: Enables updates (default value)
+#1: Disable updates from all locations
+#2: Disable updates from the Microsoft Store
+#3: Disable updates from the CDN location
+
+#logging function
+function update-log {
+    Param(
+        [Parameter(
+            Mandatory = $true, 
+            ValueFromPipeline = $true,
+            ValueFromPipelineByPropertyName = $true,
+            Position = 0
+        )]
+        [string]$Data,
+        [validateset('Information', 'Warning', 'Error', 'Comment')]
+        [string]$Class = "Information",
+        [validateset('Console', 'File', 'Both')]
+        [string]$Output 
+    )
+
+    $date = get-date -UFormat "%m/%d/%y %r"
+    $String = $Class + " " + $date + " " + $data
+    if ($Output -eq "Console") { Write-Output $string | out-host }
+    if ($Output -eq "file") { Write-Output $String | out-file -FilePath $logpath -Append }
+    if ($Output -eq "Both") {
+        Write-Output $string | out-host
+        Write-Output $String | out-file -FilePath $logpath -Append
+    }
+}
+
+#function to uninstall MSRDC by pulling MSIEXEC.EXE GUID from the registy - primary method
+function uninstall-MSRDCreg{
+    
+    $MSRCDreg = Get-ItemProperty hklm:\software\microsoft\windows\currentversion\uninstall\* | Where-Object {$_.Displayname -like "*Remote Desktop*"} | Select-Object DisplayName,DisplayVersion,UninstallString,QuietUninstallString
+    if ($MSRCDreg.DisplayName -eq "Remote Desktop"){
+        update-log -Data "Remote Desktop Installation Found" -Class Information -Output Both
+        $uninstall = $MSRCDreg.uninstallstring -replace "MsiExec.exe /X",""
+        update-log -Data "Uninstalling Remote Desktop"  -Class Information -Output Both
+        
+        try{
+            Start-Process -FilePath "msiexec.exe" -ArgumentList "/x $($uninstall) /q /norestart" -ErrorAction Stop
+        }
+        catch
+        {
+            update-log -Data "Something went wrong uninstalling Remote Desktop" -Class Error -Output Both 
+            Update-Log -data $_.Exception.Message -Class Error -Output Both
+        }
+    }
+    else
+    {
+    update-log -Data "Remote Desktop not detected via registry. Trying as package" -Class Information -Output Both
+    uninstall-MSRDC
+    }
+}
+
+#Function to uninstall MSRDC via uninstall-package as a secondary method
+function uninstall-MSRDC{
+    try{
+        update-log -Data "Looking to see if Remote Desktop is an installed package" -Class Information -Output Both
+        try{
+            $MSRDC = Get-Package -Name "Remote Desktop" -ErrorAction Stop
+        }
+        catch
+        {
+            Update-Log -data $_.Exception.Message -Class Error -Output Both
+        }
+
+        if ($MSRDC.name -eq "Remote Desktop"){
+           update-log -Data "Remote Desktop Install Found" -Class Information -Output Both
+           #update-log -Data "Version: " $MSRDC.Version
+           update-log -Data "Uninstalling Remote Desktop" -Class Information -Output Both
+           try{
+                Uninstall-Package -Name "Remote Desktop" -force -ErrorAction Stop| Out-Null
+           }
+           catch
+           {
+                Update-Log -data $_.Exception.Message -Class Error -Output Both
+           }
+         
+           update-log -Data "Remote Desktop uninstalled" -Class Information -Output Both
+       }
+    }
+    catch
+    {
+        update-log -Data "Remote Desktop not found as package." -Class Information -Output Both
+    }
+}
+
+#function to install Windows App from MS Store - write install process log to $env:windir\temp\WindowsAppStoreInstall.log
+function install-windowsappstore{
+   update-log -Data "Writing install process log to $env:windir\temp\WindowsAppStoreInstall.log" -Class Information -Output Both
+   try{
+        invoke-command -ScriptBlock { winget install 9N1F85V9T8BN --accept-package-agreements --accept-source-agreements} | Out-File -FilePath $env:windir\temp\WindowsAppStoreInstall.log -Append #MS Store Install 
+   }
+   catch
+   {
+        Update-Log -data $_.Exception.Message -Class Error -Output Both
+        Exit 1
+   }
+}
+
+#Function to install Windows App from Winget CDN - write install process log to $env:windir\temp\WindowsAppWinGetInstall.log
+function install-windowsappwinget{
+    update-log -Data "Writing install process log to $env:windir\temp\WindowsAppWinGetInstall.log" -Class Information -Output Both
+    try{
+        invoke-command -ScriptBlock {winget install Microsoft.WindowsApp --accept-package-agreements --accept-source-agreements} | Out-File -FilePath $env:windir\temp\WindowsAppWinGetInstall.log -Append #Winget Install
+    }
+    catch
+    {
+        Update-Log -data $_.Exception.Message -Class Error -Output Both
+        Exit 1
+    }
+}
+
+#Function to install Windows App from MSIX direct download
+function install-windowsappMSIX{
+
+    try{
+        if ((test-path -Path $env:windir\Temp\WindowsApp.msix) -eq $true){Remove-Item -Path $env:windir\Temp\WindowsApp.msix -Force -ErrorAction Stop}        
+        
+        $Payload = Invoke-WebRequest -uri "https://go.microsoft.com/fwlink/?linkid=2262633" -UseBasicParsing -OutFile $env:windir\Temp\WindowsApp.msix -PassThru -ErrorAction Stop
+        $filename = ($Payload.BaseResponse.ResponseUri.AbsolutePath -replace ".*/")
+    
+        if ((test-path -Path $env:windir\Temp\$filename) -eq $true){Remove-Item -Path $env:windir\Temp\$filename -Force -ErrorAction Stop}    
+    
+        Rename-Item -Path $env:windir\Temp\WindowsApp.msix -NewName $filename -Force -ErrorAction Stop
+        update-log -Data "Downloaded $filename to $env:windir\temp" -Class Information -Output Both
+        }
+    catch{
+        Update-Log -data $_.Exception.Message -Class Error -Output Both
+    }
+    try{
+        Add-AppxPackage -Path $env:windir\temp\$filename -ErrorAction Stop
+    }
+    catch{
+        Update-Log -data $_.Exception.Message -Class Error -Output Both
+    }
+}
+
+#Function to check if Windows App is installed
+function invoke-WAInstallCheck{
+    if ((($testWA = get-appxpackage -name MicrosoftCorporationII.Windows365).name) -eq "MicrosoftCorporationII.Windows365"  ){
+        update-log -Data "Windows App Installation found." -Class Information -Output Both
+        Return 0
+    }
+    else
+    {
+        update-log -Data "Windows App installation not found." -Class Information -Output Both
+        Return 1
+    }
+}
+
+#function to set the registry key to control auto updates
+function invoke-disableautoupdate($num){
+    update-log -Data "Setting disableautoupdate reg key" -Class Information -Output Both
+    $path = "HKLM:\SOFTWARE\Microsoft\WindowsApp"
+    If (!(Test-Path $path)) {
+        New-Item -Path $path -Force
+    }
+    try{
+        New-ItemProperty -Path $path -Name DisableAutomaticUpdates -PropertyType DWORD -Value $num -Force -ErrorAction Stop| Out-Null    
+    }
+    catch{
+        Update-Log -data $_.Exception.Message -Class Error -Output Both
+    }
+}
+
+#check if Windows App is installed. If so, skip installation. Else, install
+if ((invoke-WAInstallCheck) -eq 0){
+    update-log -Data "Skipping Windows App Installation" -Class Information -Output Both
+    }
+else
+    {
+    if ($source -eq "Store"){
+        update-log -Data "Starting Windows App installation from Microsoft Store" -Class Information -Output Both
+        install-windowsappstore
+        }
+    if ($source -eq "WinGet"){
+        update-log -Data "Starting Windows App installation from WinGet" -Class Information -Output Both
+        install-windowsappwinget
+        }
+    if ($source -eq "MSIX"){
+        update-log -Data "Starting Windows App installation from MSIX download" -Class Information -Output Both
+        install-windowsappMSIX
+        }
+}
+
+#verify if Windows App has now been installed. If so, move to uninstalling MSRDC. Else, fail.
+if ((invoke-WAInstallCheck) -eq 0){
+    update-log -Data "Validated Windows App Installed" -Class Information -Output Both
+    if ($SkipRemoteDesktopUninstall -eq $False){uninstall-MSRDCreg}
+    }
+    else
+    {
+    update-log -Data "Windows App does not appear to be installed. Something went wrong" -Class Error -Output Both
+    exit 1
+    }
+
+#Apply auto update registry key if option selected
+if ($DisableAutoUpdate -ne 0){
+    if ($DisableAutoUpdate -eq 1){invoke-disableautoupdate -num 1}
+    if ($DisableAutoUpdate -eq 2){invoke-disableautoupdate -num 2}
+    if ($DisableAutoUpdate -eq 3){invoke-disableautoupdate -num 3}
+}
+
+update-log -Data "Installation Complete" -Class Information -Output Both
+update-log -data "************" -Class Information -Output File

Remote Desktop Client Migration Script/readme.md

@@ -0,0 +1,105 @@
+# Windows App Installer MultiTool
+
+A PowerShell utility to detect and install the Windows 365 "Windows App" client, optionally set its auto-update registry key, and remove legacy "Remote Desktop" installs when present. This README documents the script behavior, parameters, examples, logs and troubleshooting.
+
+## What it does
+- Detects whether the Windows App (`MicrosoftCorporationII.Windows365`) is installed.
+- Installs the Windows App from one of three sources:
+  - Microsoft Store (via winget id `9N1F85V9T8BN`) — `Store` (default)
+  - WinGet CDN package (`Microsoft.WindowsApp`) — `WinGet`
+  - Direct MSIX download (FWLINK) and `Add-AppxPackage` — `MSIX`
+- Optionally writes `HKLM:\SOFTWARE\Microsoft\WindowsApp\DisableAutomaticUpdates` to control auto updates.
+- Optionally uninstalls legacy "Remote Desktop" via registry/MSI or package uninstall methods.
+- Writes logs to console and to the configured log file.
+
+## Files
+- `Windows App Installer.ps1` — main script.
+- Runtime logs:
+  - Default log: `%windir%\Temp\MultiTool.log` (can be changed with `-logpath`)
+  - Store install trace: `%windir%\Temp\WindowsAppStoreInstall.log`
+  - WinGet install trace: `%windir%\Temp\WindowsAppWinGetInstall.log`
+
+## Requirements
+- Windows (modern Windows 10/11 recommended).
+- PowerShell (script compatible with Windows PowerShell 5.1 and later).
+- Administrative privileges to install packages and write to HKLM.
+- Internet access for Store/WinGet/MSIX downloads.
+- Winget and/or Microsoft Store available for corresponding install methods (use `MSIX` when Store is blocked).
+
+## Parameters
+- `-source` (string)  
+  Where to source the installer payload. Allowed values: `Store` (default), `WinGet`, `MSIX`.
+- `-DisableAutoUpdate` (int)  
+  Sets the registry DWORD `HKLM:\SOFTWARE\Microsoft\WindowsApp\DisableAutomaticUpdates`. Allowed values:
+  - `0` — Enable updates (default)
+  - `1` — Disable updates from all locations
+  - `2` — Disable updates from Microsoft Store
+  - `3` — Disable updates from the CDN
+- `-SkipRemoteDesktopUninstall` (switch)  
+  If present, skip attempting to remove legacy Remote Desktop.
+- `-logpath` (string)  
+  Path to the primary log file (default: `$env:windir\temp\MultiTool.log`).
+
+## High-level functions (what they do)
+- `update-log` — logging helper (console / file / both).
+- `invoke-WAInstallCheck` — returns 0 if Windows App is present, 1 otherwise.
+- `install-windowsappstore` — triggers Store install (uses winget id `9N1F85V9T8BN`) and logs to temp file.
+- `install-windowsappwinget` — triggers WinGet install for `Microsoft.WindowsApp` and logs to temp file.
+- `install-windowsappMSIX` — downloads MSIX via FWLINK and installs with `Add-AppxPackage`.
+- `uninstall-MSRDCreg` — primary uninstall of legacy Remote Desktop via registry MSI uninstall string.
+- `uninstall-MSRDC` — secondary uninstall via `Get-Package` / `Uninstall-Package`.
+- `invoke-disableautoupdate` — creates/sets `DisableAutomaticUpdates` DWORD.
+
+## Usage examples (run elevated)
+Default (Store) install:
+```powershell
+PowerShell -ExecutionPolicy Bypass -File ".\Windows App Installer.ps1"
+```
+
+Install via WinGet and disable Store updates (set key = 2):
+```powershell
+PowerShell -ExecutionPolicy Bypass -File ".\Windows App Installer.ps1" -source WinGet -DisableAutoUpdate 2
+```
+
+Install via MSIX and skip removing legacy Remote Desktop:
+```powershell
+PowerShell -ExecutionPolicy Bypass -File ".\Windows App Installer.ps1" -source MSIX -SkipRemoteDesktopUninstall
+```
+
+Specify an alternate log file:
+```powershell
+PowerShell -ExecutionPolicy Bypass -File ".\Windows App Installer.ps1" -logpath "C:\Temp\WinAppInstall.log"
+```
+
+## Exit behavior & logs
+- On fatal install failures the script calls `exit 1`.
+- Normal success writes completion messages to logs and returns normally.
+- Check logs for details:
+  - Primary: `%windir%\Temp\MultiTool.log` (or the `-logpath` you supplied)
+  - Install traces: `%windir%\Temp\WindowsAppStoreInstall.log`, `%windir%\Temp\WindowsAppWinGetInstall.log`
+
+## Troubleshooting
+- Permission / access denied:
+  - Run PowerShell as Administrator.
+- Winget not found or Microsoft Store disabled:
+  - Use `-source MSIX` to attempt a direct MSIX install.
+- `Add-AppxPackage` errors:
+  - Ensure sideloading is allowed or that the package signature and system policy permit the install.
+- Remote Desktop uninstall fails:
+  - The script tries registry/MSI first then package uninstall. Manual removal may be required if uninstall strings are missing.
+- For diagnostics:
+  - Inspect the three logs listed above for error messages and stack traces.
+
+## Known limitations
+- Script assumes availability of `winget` for Store/WinGet flows; environments with Store disabled may fail unless `MSIX` chosen.
+- Error handling is present but could be more granular (some functions catch and log but do not standardize exit codes).
+- Not explicitly tested on Windows LTSC or older Windows 10 branches — behavior may vary.
+
+## Recommended next steps
+- Add a `-WhatIf`/dry-run mode.
+- Add explicit checks for `winget`/Store presence before choosing install path.
+- Convert `update-log` to structured logging (timestamped JSON) for automation.
+- Add more granular exit codes to represent specific failure types.
+
+## License
+No license is specified. Add a `LICENSE` file if you intend to publish or share.