Public/Remove-TppCodeSignProject.ps1
|
<# .SYNOPSIS Delete a code sign project .DESCRIPTION Delete a code sign project. You must be a code sign admin or owner of the project. .PARAMETER Path Path of the project to delete .PARAMETER VenafiSession Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. If providing a TPP token, an environment variable named TPP_SERVER must also be set. .INPUTS Path .OUTPUTS None .EXAMPLE Remove-TppCodeSignProject -Path '\ved\code signing\projects\my_project' Delete a project .EXAMPLE $projectObj | Remove-TppCodeSignProject Remove 1 or more projects. Get projects with Find-TppCodeSignProject .LINK http://VenafiPS.readthedocs.io/en/latest/functions/Remove-TppCodeSignProject/ .LINK https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Remove-TppCodeSignProject.ps1 .LINK https://docs.venafi.com/Docs/current/TopNav/Content/SDK/CodeSignSDK/r-SDKc-POST-Codesign-DeleteProject.php #> function Remove-TppCodeSignProject { [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param ( [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [ValidateScript( { if ( $_ | Test-TppDnPath ) { $true } else { throw "'$_' is not a valid path" } })] [String] $Path, [Parameter()] [psobject] $VenafiSession = $script:VenafiSession ) begin { Test-VenafiSession -VenafiSession $VenafiSession -Platform 'TPP' -AuthType 'token' $params = @{ VenafiSession = $VenafiSession Method = 'Post' UriLeaf = 'Codesign/DeleteProject' Body = @{ } } } process { $params.Body.Dn = $Path if ( $PSCmdlet.ShouldProcess($Path, 'Remove code sign project') ) { $response = Invoke-VenafiRestMethod @params if ( -not $response.Success ) { Write-Error ('{0} : {1} : {2}' -f $response.Result, [enum]::GetName([TppCodeSignResult], $response.Result), $response.Error) } } } } |