Functions/Platforms/Import-PASPlatform.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
function Import-PASPlatform {
    <#
    .SYNOPSIS
    Import a new platform
 
    .DESCRIPTION
    Import a new CPM platform.
 
    .PARAMETER ImportFile
    The zip file that contains the platform.
 
    .EXAMPLE
    Import-PASPlatform -ImportFile CustomApp.zip
 
    Imports CustomApp.zip Platform package
 
    .NOTES
    Minimum CyberArk version 10.2
 
    #>

    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateNotNullOrEmpty()]
        [ValidateScript( { Test-Path -Path $_ -PathType Leaf })]
        [ValidatePattern( '\.zip$' )]
        [string]$ImportFile
    )

    BEGIN {
        $MinimumVersion = [System.Version]"10.2"
    }#begin

    PROCESS {

        Assert-VersionRequirement -ExternalVersion $Script:ExternalVersion -RequiredVersion $MinimumVersion

        #Create URL for request
        $URI = "$Script:BaseURI/API/Platforms/Import"

        #Convert File to byte array
        $FileBytes = $ImportFile | Get-ByteArray

        $Body = @{"ImportFile" = $FileBytes } | ConvertTo-Json

        if ($PSCmdlet.ShouldProcess($ImportFile, "Imports Platform Package")) {

            #send request to web service
            Invoke-PASRestMethod -Uri $URI -Method POST -Body $Body -WebSession $Script:WebSession -Debug:$false

        }

    }#process

    END { }#end

}