Functions/Connections/Import-PASConnectionComponent.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
function Import-PASConnectionComponent {
    <#
.SYNOPSIS
Import a new connection component.
 
.DESCRIPTION
Allows administrators to import a new connection component, such as those available to download from the
CyberArk Marketplace.
 
.PARAMETER ImportFile
The zip file that contains the connection component.
 
.EXAMPLE
Import-PASConnectionComponent -ImportFile ConnectionComponent.zip
 
Imports ConnectionComponent.zip Connection Component
 
.NOTES
Minimum CyberArk version 10.3
 
.LINK
https://pspas.pspete.dev/commands/Import-PASConnectionComponent
#>

    [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/ConnectionComponents/Import"

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

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

        if ($PSCmdlet.ShouldProcess($ImportFile, "Imports Connection Component")) {

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

        }

    }#process

    END { }#end

}