Functions/OnboardingRules/Remove-PASOnboardingRule.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
function Remove-PASOnboardingRule {
    <#
.SYNOPSIS
Deletes an automatic on-boarding rule


.DESCRIPTION
Deletes an automatic on-boarding rulefrom the Vault.
Vault Admin membership required.

.PARAMETER RuleID
The unique ID of the rule to delete.

.EXAMPLE
Remove-PASOnboardingRule -RuleID 5

Removes specified on-boarding rule.

.INPUTS
All parameters can be piped by property name

.LINK
https://pspas.pspete.dev/commands/Remove-PASOnboardingRule
#>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$RuleID
    )

    BEGIN { }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/AutomaticOnboardingRules/$($RuleID | Get-EscapedString)"

        if ($PSCmdlet.ShouldProcess($RuleID, "Delete On-boarding Rule")) {

            #Send request to web service
            Invoke-PASRestMethod -Uri $URI -Method DELETE -WebSession $Script:WebSession

        }

    }#process

    END { }#end
}