functions/secret-dependencies/Remove-TssSecretDependencyGroup.ps1
|
function Remove-TssSecretDependencyGroup { <# .SYNOPSIS Delete a secret dependency group .DESCRIPTION Delete a secret dependency group by its ID (the Id property of Get-TssSecretDependencyGroup output). The server refuses to delete a group that still holds dependencies: remove them first with Remove-TssSecretDependency. Prompts for confirmation unless -Confirm:$false is passed. .PARAMETER TssSession TssSession object created by New-TssSession for authentication .PARAMETER Id Id of the secret dependency group to delete .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Remove-TssSecretDependencyGroup -TssSession $session -Id 42 Delete secret dependency group 42 after confirmation .EXAMPLE $session = New-TssSession -SecretServer https://alpha -Credential $ssCred Get-TssSecretDependencyGroup -TssSession $session -Id 1050 | Where-Object Name -eq 'Old servers' | Remove-TssSecretDependencyGroup -TssSession $session -Confirm:$false Delete the dependency group named Old servers of secret 1050 without a prompt .LINK https://thycotic-ps.github.io/thycotic.secretserver/commands/secret-dependencies/Remove-TssSecretDependencyGroup .LINK https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-dependencies/Remove-TssSecretDependencyGroup.ps1 .NOTES Requires TssSession object returned by New-TssSession #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] [OutputType('Thycotic.PowerShell.Common.Delete')] param ( [Parameter(Mandatory, ValueFromPipeline, Position = 0)] [Thycotic.PowerShell.Authentication.Session] $TssSession, [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [Alias('SecretDependencyGroupId')] [int[]] $Id ) begin { $tssParams = $PSBoundParameters $invokeParams = . $GetInvokeApiParams $TssSession } process { Get-TssInvocation $PSCmdlet.MyInvocation if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { Compare-TssVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation foreach ($currentId in $Id) { $restResponse = $null $uri = $TssSession.ApiUrl, 'secret-dependencies', 'groups', $currentId -join '/' $invokeParams.Uri = $uri $invokeParams.Method = 'DELETE' if ($PSCmdlet.ShouldProcess("Secret dependency group: $currentId", "$($invokeParams.Method) $uri")) { Write-Verbose "Performing the operation $($invokeParams.Method) $uri" try { $apiResponse = Invoke-TssApi @invokeParams $restResponse = . $ProcessResponse $apiResponse } catch { Write-Warning 'Issue with Remove-TssSecretDependencyGroup request' $err = $_ . $ErrorHandling $err } if ($restResponse) { [Thycotic.PowerShell.Common.Delete](. $FilterTssResponse $restResponse ([Thycotic.PowerShell.Common.Delete])) } } } } else { Write-Warning 'No valid session found' } } } |