functions/folders/Remove-Folder.ps1
|
function Remove-Folder { <# .SYNOPSIS Delete secret folder .DESCRIPTION Delete secret folder .EXAMPLE PS C:\> $session = New-TssSession -SecretServer https://alpha -Credential $ssCred PS C:\> Remove-TssFolder -TssSession $session -Id 28 Delete Folder ID 28 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess)] [OutputType('TssDelete')] param ( # TssSession object created by New-TssSession for auth [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [TssSession]$TssSession, # Short description for parameter [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [Alias("FolderId")] [int[]] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = @{ } } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { foreach ($folder in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'folders', $folder.ToString() -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' $invokeParams.PersonalAccessToken = $TssSession.AccessToken if (-not $PSCmdlet.ShouldProcess($folder, "$($invokeParams.Method) $uri")) { return } Write-Verbose "$($invokeParams.Method) $uri with $body" try { $restResponse = Invoke-TssRestApi @invokeParams } catch { Write-Warning "Issue removing [$]" $err = $_.ErrorDetails.Message Write-Error $err } if ($restResponse) { [TssDelete]@{ Id = $restResponse.id ObjectType = $restResponse.objectType } } } } else { Write-Warning "No valid session found" } } } |