functions/secrets/Restore-Secret.ps1
|
function Restore-Secret { <# .SYNOPSIS Undelete a Secret(s) .DESCRIPTION Undelete a Secret(s) .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Restore-TssSecret -TssSession $session -Id 34, 56 Un-delete Secrets 34 and 56 .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/secrets/Restore-TssSecret .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secrets/Restore-Secret.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [cmdletbinding(SupportsShouldProcess)] param( # TssSession object created by New-TssSession for auth [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [TssSession] $TssSession, # Folder Id to modify [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('SecretId')] [int[]] $Id ) begin { $setParams = $PSBoundParameters $invokeParams = . $GetInvokeTssParams $TssSession } process { Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" if ($setParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($secret in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'secrets', $secret, 'undelete' -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'PUT' if ($PSCmdlet.ShouldProcess("Secret Id: $secret", "$($invokeParams.Method) $uri")) { Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $restResponse = . $InvokeApi @invokeParams } catch { Write-Warning "Issue with Secret [$secret]" $err = $_ . $ErrorHandling $err } } if ($restResponse.id -eq $secret) { Write-Host "Secret [$secret] undeleted" } } } else { Write-Warning 'No valid session found' } } } |