public/Remove-TNReportResult.ps1
|
function Remove-TNReportResult { <# .SYNOPSIS Removes a report result .DESCRIPTION Removes a report result .PARAMETER SessionObject Optional parameter to force using specific SessionObjects. By default, each command will connect to all connected servers that have been connected to using Connect-TNServer .PARAMETER ReportResultId The ID of the target report result .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with 'sea of red' exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this 'nice by default' feature off and enables you to catch exceptions with your own try/catch. .EXAMPLE PS C:\> Get-TNReportResult | Remove-TNReportResult Removes a list of report results #> [CmdletBinding()] param ( [Parameter(ValueFromPipelineByPropertyName)] [object[]]$SessionObject = (Get-TNSession), [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias("Id")] [int32[]]$ReportResultId, [switch]$EnableException ) process { foreach ($session in $SessionObject) { $PSDefaultParameterValues["*:SessionObject"] = $session foreach ($id in $ReportResultId) { Write-PSFMessage -Level Verbose -Message "Deleting report result with id $id" Invoke-TNRequest -SessionObject $session -EnableException:$EnableException -Path "/report/$id" -Method Delete | ConvertFrom-TNRestResponse Write-PSFMessage -Level Verbose -Message 'ReportResult deleted' } } } } |