Functions/Platforms/Export-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
# .ExternalHelp psPAS-help.xml
function Export-PASPlatform {
    [CmdletBinding(SupportsShouldProcess)]
    param(
        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [string]$PlatformID,

        [parameter(
            Mandatory = $true,
            ValueFromPipelinebyPropertyName = $true
        )]
        [ValidateScript( { Test-Path -Path $_ -IsValid })]
        [string]$path
    )

    BEGIN {
        Assert-VersionRequirement -RequiredVersion 10.4
    }#begin

    PROCESS {

        #Create URL for request
        $URI = "$Script:BaseURI/API/Platforms/$PlatformID/Export?platformID=$PlatformID"

        if ($PSCmdlet.ShouldProcess($PlatformID, 'Exports Platform Package')) {

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

            #if we get a platform byte array
            If ($null -ne $result) {

                Out-PASFile -InputObject $result -Path $path

            }

        }

    }#process

    END { }#end

}