Public/Connectors/Remove-SIAHttpsRelay.ps1
|
function Remove-SIAHttpsRelay { <# .SYNOPSIS Deletes a SIA HTTPS relay. .DESCRIPTION Permanently removes an HTTPS relay registration from the tenant. .PARAMETER Id The HTTPS relay's id, as returned by Get-SIAHttpsRelay. .EXAMPLE Remove-SIAHttpsRelay -Id 'relay-01' Deletes the specified HTTPS relay after confirmation. .INPUTS psSIA.HttpsRelay .OUTPUTS None. .LINK https://api-docs.cyberark.com/secure-infra-access/docs/sia-connector-api #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] param( [Parameter(Mandatory, ValueFromPipelineByPropertyName)] [string]$Id ) process { if ($PSCmdlet.ShouldProcess($Id, 'Delete SIA HTTPS relay')) { Invoke-SIARequest -Method DELETE -Path "/api/https-relays/$Id" | Out-Null } } } |