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
function Remove-PASSafe {
    <#
.SYNOPSIS
Deletes a safe from the Vault
 
 
.DESCRIPTION
Deletes a safe from the Vault.
The "Manage" Safe vault permission is required.
 
.PARAMETER SafeName
The name of the safe to delete.
 
.EXAMPLE
Remove-PASSafe -SafeName OLD_Safe
 
Deletes "OLD_Safe"
 
.INPUTS
All parameters can be piped by property name
 
.OUTPUTS
None
 
#>

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

    )

    BEGIN {}#begin

    PROCESS {

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


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

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

        }

    }#process

    END {}#end
}