functions/reports/Remove-TssReport.ps1
|
function Remove-TssReport { <# .SYNOPSIS Remove a report. .DESCRIPTION Remove a report. .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Remove-TssReport -TssSession $session -Id 4 Remove Report ID 4. .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/Remove-TssReport .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/repors/Remove-TssReport.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('Thycotic.PowerShell.Common.Delete')] param ( # TssSession object created by New-TssSession for authentication [Parameter(Mandatory,ValueFromPipeline,Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, # Short description for parameter [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [Alias("ReportId")] [int[]] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($report in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'reports', $report -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if (-not $PSCmdlet.ShouldProcess("Report ID: $report","$($invokeParams.Method) $uri")) { return } Write-Verbose "Performing the operation $($invokeParams.Method) $uri with $body" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning "Issue removing report [$report]" $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Common.Delete]@{ Id = $report ObjectType = 'Report' } } } } else { Write-Warning "No valid session found" } } } |