From e731f427d7983eec28b12454c0077feffad3a93a Mon Sep 17 00:00:00 2001 From: Shawn Melton <11204251+wsmelton@users.noreply.github.com> Date: Sat, 6 Nov 2021 10:14:42 -0500 Subject: [PATCH] Remove-TssList - new command to "delete" a List --- docs/commands/lists/Remove-TssList.md | 104 ++++++++++++++++++ .../classes/common/Delete.cs | 2 +- src/functions/lists/Remove-TssList.ps1 | 71 ++++++++++++ tests/lists/Remove-TssList.Tests.ps1 | 24 ++++ 4 files changed, 200 insertions(+), 1 deletion(-) create mode 100644 docs/commands/lists/Remove-TssList.md create mode 100644 src/functions/lists/Remove-TssList.ps1 create mode 100644 tests/lists/Remove-TssList.Tests.ps1 diff --git a/docs/commands/lists/Remove-TssList.md b/docs/commands/lists/Remove-TssList.md new file mode 100644 index 00000000..eadd2b56 --- /dev/null +++ b/docs/commands/lists/Remove-TssList.md @@ -0,0 +1,104 @@ +# Remove-TssList + +## SYNOPSIS +Remove a List by ID + +## SYNTAX + +``` +Remove-TssList [-TssSession] -Id [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Remove a List by ID + +## EXAMPLES + +### EXAMPLE 1 +``` +$session = New-TssSession -SecretServer https://alpha -Credential $ssCred +Remove-TssList -TssSession $session -Id -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0 +``` + +Remove the provided List ID + +## PARAMETERS + +### -TssSession +TssSession object created by New-TssSession for authentication + +```yaml +Type: Session +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Id +Categorized List ID + +```yaml +Type: String +Parameter Sets: (All) +Aliases: CategorizedListId + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Thycotic.PowerShell.Common.Delete +## NOTES +Requires TssSession object returned by New-TssSession + +## RELATED LINKS + +[https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Remove-TssList](https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Remove-TssList) + +[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Remove-TssList.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Remove-TssList.ps1) + diff --git a/src/Thycotic.SecretServer/classes/common/Delete.cs b/src/Thycotic.SecretServer/classes/common/Delete.cs index 63cdbf2f..d68d0b6c 100644 --- a/src/Thycotic.SecretServer/classes/common/Delete.cs +++ b/src/Thycotic.SecretServer/classes/common/Delete.cs @@ -7,7 +7,7 @@ namespace Thycotic.PowerShell.Common { public class Delete { - public int Id { get; set; } + public string Id { get; set; } public string ObjectType { get; set; } public string[] ResponseCodes { get; set; } } diff --git a/src/functions/lists/Remove-TssList.ps1 b/src/functions/lists/Remove-TssList.ps1 new file mode 100644 index 00000000..e151a15f --- /dev/null +++ b/src/functions/lists/Remove-TssList.ps1 @@ -0,0 +1,71 @@ +function Remove-TssList { + <# + .SYNOPSIS + Remove a List by ID + + .DESCRIPTION + Remove a List by ID + + .EXAMPLE + $session = New-TssSession -SecretServer https://alpha -Credential $ssCred + Remove-TssList -TssSession $session -Id -Id 2d92c585-a3e1-4706-96b8-23ad2edda6b0 + + Remove the provided List ID + + .LINK + https://thycotic-ps.github.io/thycotic.secretserver/commands/lists/Remove-TssList + + .LINK + https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/lists/Remove-TssList.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, + + # Categorized List ID + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias("CategorizedListId")] + [string] + $Id + ) + begin { + $tssParams = $PSBoundParameters + $invokeParams = . $GetInvokeApiParams $TssSession + } + process { + Get-TssInvocation $PSCmdlet.MyInvocation + if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { + Compare-TssVersion $TssSession '10.9.000064' $PSCmdlet.MyInvocation + foreach ($list in $Id) { + $uri = $TssSession.ApiUrl, 'lists', $list -join '/' + $invokeParams.Uri = $uri + $invokeParams.Method = 'DELETE' + + if ($PSCmdlet.ShouldProcess("List $list","$($invokeParams.Method) $($invokeParams.Uri)")) { + Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri) with $body" + try { + $apiResponse = Invoke-TssApi @invokeParams + $restResponse = . $ProcessResponse $apiResponse + } catch { + Write-Warning "Issue removing List [$list]" + $err = $_ + . $ErrorHandling $err + } + + if ($restResponse) { + [Thycotic.PowerShell.Common.Delete]$restResponse + } + } + } + } else { + Write-Warning "No valid session found" + } + } +} \ No newline at end of file diff --git a/tests/lists/Remove-TssList.Tests.ps1 b/tests/lists/Remove-TssList.Tests.ps1 new file mode 100644 index 00000000..3febbd74 --- /dev/null +++ b/tests/lists/Remove-TssList.Tests.ps1 @@ -0,0 +1,24 @@ +BeforeDiscovery { + $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf +} +Describe "$commandName verify parameters" { + BeforeDiscovery { + [object[]]$knownParameters = 'TssSession', 'Id' + [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys + [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function') + $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru + } + Context "Verify parameters" -Foreach @{currentParams = $currentParams } { + It "$commandName should contain <_> parameter" -TestCases $knownParameters { + $_ -in $currentParams | Should -Be $true + } + It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters { + $_ | Should -BeNullOrEmpty + } + } + Context "Command specific details" { + It "$commandName should set OutputType to Thycotic.PowerShell.Common.Delete" -TestCases $commandDetails { + $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.Common.Delete' + } + } +} \ No newline at end of file