psPAS

5.5.110

Functions/LDAPDirectories/Remove-PASDirectory.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
 # .ExternalHelp psPAS-help.xml
function Remove-PASDirectory {
    [CmdletBinding(SupportsShouldProcess = $true)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [Alias('DomainName')]
        [string]$id

    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 10.7
    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/api/Configuration/LDAP/Directories/$id/"

        if ($PSCmdlet.ShouldProcess($id, 'Delete Directory')) {

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

        }

    }#process

    END { }#end

}