psPAS

5.5.110

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

                                # .ExternalHelp psPAS-help.xml

function 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

}