Public/Remove-EdgeProfile.ps1
|
function Remove-EdgeProfile { <# .SYNOPSIS Removes Edge profiles (bulk cleanup), after making a backup of them. .DESCRIPTION Removes the selected profiles from Edge: unregisters them in 'Local State' and sends the profile folder to the Recycle Bin (-Permanent deletes it). Before that, a backup zip of all categories of the profiles is made with Backup-EdgeProfiles (skip with -SkipBackup). Profiles can be selected with -Name, -Key or -Directory (wildcards), or piped in from Get-EdgeProfile. Orphan folders (Get-EdgeProfile -All) can be removed too. Unless -LocalOnly, a tombstone is written to the sync store so that Sync-EdgeProfiles on other machines does not re-create the profile. Edge of the channel must be fully closed (removing a profile rewrites Local State, which Edge overwrites on exit); -CloseEdge stops it. The 'Default' profile cannot be removed. Asks for confirmation per profile (ConfirmImpact High) unless -Force or -Confirm:$false. .PARAMETER Name Display name(s) of the profiles to remove (wildcards allowed). .PARAMETER Key Key(s) of the profiles to remove (wildcards allowed). .PARAMETER Directory Profile folder name(s), e.g. 'Profile 7' (wildcards allowed). Bound from pipeline objects. .PARAMETER Channel Edge channel. Default: Stable. Bound from pipeline objects. .PARAMETER SkipBackup Do not make a backup zip first. .PARAMETER BackupDestination Folder for the backup zip. Default: the Backup-EdgeProfiles default folder. .PARAMETER Permanent Delete the profile folders instead of sending them to the Recycle Bin. .PARAMETER LocalOnly Do not write a tombstone to the sync store (other machines keep syncing the profile). .PARAMETER CloseEdge Stop Edge of the channel if it is running. .PARAMETER Force Do not ask for confirmation. .PARAMETER PassThru Return a summary object per profile. .EXAMPLE Get-EdgeProfile | Where-Object LastActiveUtc -lt (Get-Date).AddMonths(-6) | Remove-EdgeProfile .EXAMPLE Get-EdgeProfile | Out-ConsoleGridView | Remove-EdgeProfile -CloseEdge Interactive selection (needs the Microsoft.PowerShell.ConsoleGuiTools module). .EXAMPLE Remove-EdgeProfile -Name 'Test *' -Force -WhatIf #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [Parameter(Position = 0)] [SupportsWildcards()] [string[]]$Name, [SupportsWildcards()] [string[]]$Key, [Parameter(ValueFromPipelineByPropertyName)] [SupportsWildcards()] [string[]]$Directory, [Parameter(ValueFromPipelineByPropertyName)] [ValidateSet('Stable', 'Beta', 'Dev', 'Canary')] [string]$Channel = 'Stable', [switch]$SkipBackup, [string]$BackupDestination, [switch]$Permanent, [switch]$LocalOnly, [switch]$CloseEdge, [switch]$Force, [switch]$PassThru, [Parameter(DontShow)] [string]$UserDataRoot, [Parameter(DontShow)] [string]$SyncRoot ) begin { if ($Force -and -not $PSBoundParameters.ContainsKey('Confirm')) { $ConfirmPreference = 'None' } $requests = [System.Collections.Generic.List[object]]::new() } process { $requests.Add([pscustomobject]@{ Channel = $Channel Name = @($Name | Where-Object { $_ }) Key = @($Key | Where-Object { $_ }) Directory = @($Directory | Where-Object { $_ }) }) } end { $requests = @($requests | Where-Object { $_.Name -or $_.Key -or $_.Directory }) if (-not $requests) { Write-Error 'Specify -Name, -Key or -Directory, or pipe profiles from Get-EdgeProfile.' return } foreach ($chGroup in ($requests | Group-Object Channel)) { $ch = $chGroup.Name $sw = [System.Diagnostics.Stopwatch]::StartNew() $info = Get-EdgeChannelInfo -Channel $ch -UserDataRoot $UserDataRoot $local = @(Get-EdgeLocalProfile -Channel $ch -UserDataRoot $UserDataRoot) $all = $local + @(Get-EdgeOrphanProfile -UserDataPath $info.UserDataPath -Channel $ch -Registered $local) # Resolve the selection (each profile once). $selected = [ordered]@{} foreach ($r in $chGroup.Group) { $hits = @() if ($r.Name) { $hits += @(Select-EdgeProfileByFilter -InputObject $all -Filter $r.Name -Property Name) } if ($r.Key) { $hits += @(Select-EdgeProfileByFilter -InputObject $all -Filter $r.Key -Property Key) } if ($r.Directory) { $hits += @(Select-EdgeProfileByFilter -InputObject $all -Filter $r.Directory -Property Directory) } if (-not $hits) { Write-Warning "Edge ${ch}: no profile matches '$((@($r.Name) + @($r.Key) + @($r.Directory)) -join "', '")'." } foreach ($h in $hits) { $selected[$h.Directory] = $h } } $results = [System.Collections.Generic.List[object]]::new() $addResult = { param($p, $action, $reason, $backup, $tomb) $results.Add([pscustomobject]@{ Channel = $ch; Directory = $p.Directory; Name = $p.Name; Key = $p.Key Action = $action; Reason = $reason; BackupPath = $backup; Tombstone = [bool]$tomb }) } if (-not $selected.Count) { continue } $how = $Permanent ? 'delete permanently' : 'move to the Recycle Bin' Write-EdgeStatus '' Write-EdgeStatus ('Remove {0} Edge {1} profile(s) ({2}{3})' -f $selected.Count, $ch, $how, ($WhatIfPreference ? '; WhatIf: nothing is changed' : '')) -Level Header # Confirm per profile. $confirmed = [System.Collections.Generic.List[object]]::new() foreach ($p in $selected.Values) { $isOrphan = [bool]($p.PSObject.Properties['IsOrphan'] -and $p.IsOrphan) if ($p.Directory -eq 'Default') { Write-Warning "The 'Default' profile ('$($p.Name)') cannot be removed (Edge recreates it); skipped." & $addResult $p 'Skipped' 'Default profile' $null $false continue } $label = $isOrphan ? "orphan folder '$($p.Directory)'" : "profile '$($p.Name)' ($($p.Directory))" if ($PSCmdlet.ShouldProcess("Edge $ch $label", "Remove profile ($how)")) { $confirmed.Add($p) } else { & $addResult $p ($WhatIfPreference ? 'WhatIf' : 'Skipped') 'Not confirmed' $null $false if (-not $WhatIfPreference) { Write-EdgeStatus "Skipped $label - not confirmed." -Level Warning } } } $backupPath = $null if ($confirmed.Count) { # Edge must be fully closed. $state = Get-EdgeProcessState -Channel $ch if ($state.Running) { if (-not $CloseEdge) { throw "Edge $ch is running. Removing profiles rewrites Local State, so Edge must be fully closed (also check the system tray / Startup Boost), or use -CloseEdge." } Write-EdgeStatus "Stopping Edge $ch..." -Level Step if (-not (Stop-EdgeProcess -Channel $ch)) { throw "Edge $ch could not be stopped; nothing removed." } } # Backup first (registered profiles; orphan folders are not in Local State and cannot be backed up by key). $toBackup = @($confirmed | Where-Object { -not ($_.PSObject.Properties['IsOrphan'] -and $_.IsOrphan) }) if (-not $SkipBackup -and $toBackup) { $bArgs = @{ Channel = $ch ProfileName = @($toBackup | ForEach-Object { [WildcardPattern]::Escape($_.Directory) }) Category = 'All' PassThru = $true } if ($BackupDestination) { $bArgs.Destination = $BackupDestination } if ($UserDataRoot) { $bArgs.UserDataRoot = $UserDataRoot } $bSw = [System.Diagnostics.Stopwatch]::StartNew() Write-EdgeStatus "Backing up $($toBackup.Count) profile(s) before removal: $(($toBackup | ForEach-Object { $_.Name }) -join ', ')..." -Level Step try { $backupPath = (Backup-EdgeProfiles @bArgs -ErrorAction Stop).Path } catch { throw "Backup before removal failed, nothing removed: $($_.Exception.Message)" } if (-not $backupPath) { throw 'Backup before removal produced no archive; nothing removed.' } Write-EdgeStatus ('Backup written: {0} ({1}, {2}).' -f $backupPath, (Format-EdgeSize (Get-EdgePathSize -Path $backupPath)), (Format-EdgeDuration $bSw.Elapsed)) -Level Success } elseif ($SkipBackup) { Write-EdgeStatus 'No backup is made (-SkipBackup).' -Level Warning } $syncRootPath = $LocalOnly ? $null : (Get-EdgeBackupSyncRoot -SyncRoot $SyncRoot) $canTombstone = $syncRootPath -and (Test-Path -LiteralPath (Join-Path $syncRootPath 'store') -PathType Container) -and (Get-Command -Name Set-EdgeSyncTombstone -ErrorAction Ignore) $progress = New-EdgeProgress -Activity "Removing Edge $ch profiles" -Total $confirmed.Count -Unit Steps -Id 20 try { $width = "$($confirmed.Count)".Length $i = 0 foreach ($p in $confirmed) { $i++ $isOrphan = [bool]($p.PSObject.Properties['IsOrphan'] -and $p.IsOrphan) $tag = "[{0,$width}/{1}]" -f $i, $confirmed.Count $label = $isOrphan ? "orphan folder '$($p.Directory)'" : "'$($p.Name)' ($($p.Directory))" Update-EdgeProgress -Progress $progress -Done ($i - 1) -Status "Profile $i/$($confirmed.Count) '$($p.Name)'" -CurrentOperation $p.Path -Force $pSw = [System.Diagnostics.Stopwatch]::StartNew() $size = Get-EdgePathSize -Path $p.Path Write-EdgeStatus "$tag Removing $label ($(Format-EdgeSize $size))..." -Level Step try { Remove-EdgeLocalProfile -Directory $p.Directory -Channel $ch -UserDataRoot $UserDataRoot -Permanent:$Permanent -Confirm:$false -WhatIf:$false } catch { Write-EdgeSyncLog -Message "Removing Edge $ch profile '$($p.Name)' ($($p.Directory)) failed: $($_.Exception.Message)" -Level Warning Write-EdgeStatus "$tag Failed to remove ${label}: $($_.Exception.Message)" -Level Warning & $addResult $p 'Error' $_.Exception.Message $backupPath $false continue } $tomb = $false if ($canTombstone -and -not $isOrphan) { try { Set-EdgeSyncTombstone -SyncRoot $syncRootPath -Channel $ch -ProfileKey $p.Key -Name $p.Name $tomb = $true } catch { Write-EdgeSyncLog -Message "Tombstone for '$($p.Key)' failed: $($_.Exception.Message)" -Level Warning } } Write-EdgeSyncLog -Message "Removed Edge $ch profile '$($p.Name)' ($($p.Directory))$($Permanent ? ' permanently' : ' to the Recycle Bin')$($backupPath ? "; backup: $backupPath" : '')." -Level Info $tombNote = $isOrphan ? '' : ($tomb ? '; tombstone written to the sync store' : ($LocalOnly ? '; local only (no tombstone)' : '; no sync store (no tombstone)')) Write-EdgeStatus ('{0} Removed {1}: {2} {3} in {4}{5}.' -f $tag, $label, (Format-EdgeSize $size), ($Permanent ? 'deleted permanently' : 'moved to the Recycle Bin'), (Format-EdgeDuration $pSw.Elapsed), $tombNote) -Level Success & $addResult $p 'Removed' $null $backupPath $tomb Update-EdgeProgress -Progress $progress -Done $i } } finally { Complete-EdgeProgress -Progress $progress } } $sw.Stop() $removed = @($results | Where-Object Action -eq 'Removed') $skipped = @($results | Where-Object Action -in 'Skipped', 'WhatIf') $failed = @($results | Where-Object Action -eq 'Error') $where = $Permanent ? 'deleted' : 'moved to the Recycle Bin' $level = $failed ? 'Warning' : 'Success' Write-EdgeStatus ('Remove of Edge {0} profiles finished in {1}' -f $ch, (Format-EdgeDuration $sw.Elapsed)) -Level $level Write-EdgeStatus (' Profiles : {0} removed ({1}), {2} skipped, {3} failed' -f $removed.Count, $where, $skipped.Count, $failed.Count) -Level $level if ($backupPath) { Write-EdgeStatus " Backup : $backupPath" -Level $level } if ($PassThru) { $results } } } } |