Functions/Safes/Remove-PASSafe.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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# .ExternalHelp psPAS-help.xml
function Remove-PASSafe {
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'UseGen1API', Justification = 'False Positive')]
    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = 'Gen2')]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen2'
        )]
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true,
            ParameterSetName = 'Gen1'
        )]
        [ValidateNotNullOrEmpty()]
        [string]$SafeName,

        [parameter(
            Mandatory = $false,
            ValueFromPipelinebyPropertyName = $false,
            ParameterSetName = 'Gen1'
        )]
        [switch]$UseGen1API

    )

    BEGIN { }#begin

    PROCESS {

        switch ($PSCmdlet.ParameterSetName) {

            'Gen1' {

                Assert-VersionRequirement -MaximumVersion 12.3

                #Create URL for request
                $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Safes/$($SafeName |
                Get-EscapedString)"


                break

            }

            default {

                Assert-VersionRequirement -RequiredVersion 12.1

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

                break

            }

        }

        if ($PSCmdlet.ShouldProcess($SafeName, 'Delete Safe')) {

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

        }

    }#process

    END { }#end
}